跳到主要内容
跳到主要内容

ClickStack 入门

由于提供了预构建好的 Docker 镜像，开始使用 ClickStack 十分简单。这些镜像基于官方的 ClickHouse Debian 软件包构建，并提供多种发行版本，以适配不同的使用场景。

本地部署​

最简单的选项是使用包含该栈所有核心组件的单镜像发行版：

  • HyperDX UI
  • OpenTelemetry (OTel) collector
  • ClickHouse

此一体化镜像允许通过一条命令启动完整栈，非常适合用于测试、试验或快速本地部署。

使用 Docker 部署栈​

下面的命令会在端口 4317 和 4318 上运行一个 OTel collector，并在端口 8080 上运行 HyperDX UI。

docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one
持久化数据和设置

要在容器重启之间持久化数据和设置，可以修改上述 Docker 命令，将路径 /data/db、/var/lib/clickhouse 和 /var/log/clickhouse-server 进行挂载。

例如：

# 修改命令以挂载路径 \{#modify-command-to-mount-paths}
docker run \
  -p 8080:8080 \
  -p 4317:4317 \
  -p 4318:4318 \
  -v "$(pwd)/.volumes/db:/data/db" \
  -v "$(pwd)/.volumes/ch_data:/var/lib/clickhouse" \
  -v "$(pwd)/.volumes/ch_logs:/var/log/clickhouse-server" \
  docker.hyperdx.io/hyperdx/hyperdx-all-in-one

访问 http://localhost:8080 以打开 HyperDX UI。

创建一个用户，并设置符合复杂度要求的用户名和密码。

HyperDX UI

HyperDX 将自动连接到本地集群，并为日志、链路追踪、指标和会话创建数据源，使你可以立即开始探索产品。

探索产品​

栈部署完成后，可以尝试我们的任一示例数据集。

若要继续使用本地集群：

  • 示例数据集 - 从我们的公共演示中加载一个示例数据集，用于诊断一个简单问题。
  • 本地文件和指标 - 使用本地 OTel collector 在 OSX 或 Linux 上加载本地文件并监控系统。

或者，你也可以连接到一个演示集群，在其中探索更大的数据集：

使用 ClickHouse Cloud 部署​

用户可以将 ClickStack 部署到 ClickHouse Cloud 上，在享受完全托管且安全的后端的同时，仍然对数据摄取、Schema 和可观测性工作流保持完全控制。

创建 ClickHouse Cloud 服务​

按照 ClickHouse Cloud 入门指南创建一个服务。

复制连接信息​

要查找 HyperDX 的连接信息，请进入 ClickHouse Cloud 控制台并点击侧边栏中的 Connect 按钮。

复制 HTTP 连接信息，尤其是 HTTPS 端点（endpoint）和密码。

连接 Cloud
部署到生产环境

虽然我们将使用 default 用户连接 HyperDX，但我们建议在进入生产环境时创建一个专用用户。

使用 docker 部署​

打开终端并导出上面复制的凭证：

export CLICKHOUSE_USER=default
export CLICKHOUSE_ENDPOINT=<YOUR HTTPS ENDPOINT>
export CLICKHOUSE_PASSWORD=<YOUR_PASSWORD>

运行以下 docker 命令：

docker run -e CLICKHOUSE_ENDPOINT=${CLICKHOUSE_ENDPOINT} -e CLICKHOUSE_USER=default -e CLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD} -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one

这将提供一个 OpenTelemetry collector（监听 4317 和 4318 端口），以及 HyperDX UI（监听 8080 端口）。

访问 http://localhost:8080 以打开 HyperDX UI。

创建一个用户，并提供满足复杂度要求的用户名和密码。

HyperDX 登录

创建 ClickHouse Cloud 连接​

进入 Team Settings，并在 Local Connection 上点击 Edit：

编辑连接

将连接重命名为 Cloud，并使用你的 ClickHouse Cloud 服务凭证填写后续表单，然后点击 Save：

创建 Cloud 连接

体验产品​

完成 ClickStack 部署后，尝试我们的任一示例数据集。

  • 示例数据集 - 从我们的公共演示中加载一个示例数据集，诊断一个简单问题。
  • 本地文件和指标 - 使用本地 OTel collector 在 OSX 或 Linux 上加载本地文件并监控系统。

本地模式​

本地模式是一种无需身份验证即可部署 HyperDX 的方式。

此模式不支持身份验证。

该模式适用于快速测试、开发、演示和调试等场景，此时不需要身份验证和设置持久化。

托管版本​

可以在本地模式下使用 HyperDX 的托管版本，地址为 play.hyperdx.io。

自托管版本​

使用 Docker 运行​

自托管本地模式镜像中已预先配置好 OpenTelemetry collector 和 ClickHouse server。这样可以轻松从你的应用程序采集遥测数据，并在 HyperDX 中进行可视化，且只需最少的外部设置。要开始使用自托管版本，只需运行 Docker 容器并映射相应端口：

docker run -p 8080:8080 docker.hyperdx.io/hyperdx/hyperdx-local

系统不会提示你创建用户，因为本地模式不包含身份验证。

配置连接凭据​

要连接到你自己的外部 ClickHouse 集群，可以手动输入连接凭据。

或者，如果只是快速体验产品，你也可以点击 Connect to Demo Server 连接到演示服务器（demo server），访问预加载数据集，在无需任何配置的情况下试用 ClickStack。

凭据

如果连接到演示服务器，用户可以按照演示数据集说明来探索该数据集。