跳转到主内容
跳转到主内容

一体化部署

这个完整的 Docker 镜像打包了所有 ClickStack 开源组件：

  • ClickHouse
  • HyperDX
  • OpenTelemetry (OTel) collector（通过端口 4317 和 4318 对外提供 OTLP）
  • MongoDB（用于持久化存储应用程序状态）

此选项启用身份验证，可在不同会话和用户之间持久保存仪表板、告警和已保存搜索。

适用场景​

  • 演示
  • 本地全栈测试

部署步骤​


使用 Docker 部署​

以下命令会运行一个 OpenTelemetry collector（监听 4317 和 4318 端口）以及 HyperDX UI（监听 8080 端口）。

docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 clickhouse/clickstack-all-in-one:latest
镜像名称更新

ClickStack 镜像现在发布为 clickhouse/clickstack-*（之前为 docker.hyperdx.io/hyperdx/*）。

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

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

点击 Create 后，将为集成的 ClickHouse 实例创建数据源。

HyperDX UI

有关使用其他 ClickHouse 实例的示例，请参见 "使用 ClickHouse Cloud"。

摄取数据​

要摄取数据，请参见 "摄取数据"。

持久化数据和设置​

要在容器重启时仍然保留数据和设置，可以修改上面的 Docker 命令，将路径 /data/db、/var/lib/clickhouse 和 /var/log/clickhouse-server 挂载为持久卷。例如：

# ensure directories exist
mkdir -p .volumes/db .volumes/ch_data .volumes/ch_logs
# 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" \
  clickhouse/clickstack-all-in-one:latest

在生产环境中部署​

由于以下原因，此选项不建议用于生产环境部署：

  • 非持久化存储： 所有数据都使用 Docker 原生 overlay 文件系统进行存储。此配置在大规模场景下无法提供足够的性能，并且如果容器被删除或重启，数据将会丢失——除非用户挂载所需的文件路径。
  • 缺乏组件隔离： 所有组件都在单个 Docker 容器中运行。这会阻止独立扩缩容与监控，并将任何 cgroup 限制全局应用到所有进程。因此，各组件可能会争抢 CPU 和内存。

自定义端口​

如果需要自定义 HyperDX Local 运行时使用的应用程序端口（8080）或 API 端口（8000），需要修改 docker run 命令以转发相应端口，并设置一些环境变量。

自定义 OpenTelemetry 端口时，只需修改端口转发参数即可。例如，将 -p 4318:4318 替换为 -p 4999:4318，即可将 OpenTelemetry 的 HTTP 端口更改为 4999。

docker run -p 8080:8080 -p 4317:4317 -p 4999:4318 clickhouse/clickstack-all-in-one:latest

使用 ClickHouse Cloud​

此发行版可以配合 ClickHouse Cloud 使用。虽然本地 ClickHouse 实例仍会被部署（但会被忽略），但可以通过设置环境变量 CLICKHOUSE_ENDPOINT、CLICKHOUSE_USER 和 CLICKHOUSE_PASSWORD 将 OTel collector 配置为连接到 ClickHouse Cloud 实例。

例如：

export CLICKHOUSE_ENDPOINT=<HTTPS ENDPOINT>
export CLICKHOUSE_USER=<CLICKHOUSE_USER>
export CLICKHOUSE_PASSWORD=<CLICKHOUSE_PASSWORD>

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 clickhouse/clickstack-all-in-one:latest

CLICKHOUSE_ENDPOINT 应设置为 ClickHouse Cloud 的 HTTPS 端点，并包含端口 8443，例如：https://mxl4k3ul6a.us-east-2.aws.clickhouse.com:8443

连接到 HyperDX UI 后，导航至 Team Settings，先创建与你的 ClickHouse Cloud 服务的连接，然后添加所需的数据源。

配置 OpenTelemetry collector​

如果需要，可以修改 OTel collector 的配置——请参阅“修改配置”。

JSON 类型支持​

Beta feature. Learn more.
Beta 功能 - 尚未准备好用于生产环境

ClickStack 中的 JSON 类型支持目前为 Beta 功能。虽然 JSON 类型本身在 ClickHouse 25.3+ 中已经可以用于生产环境，但其在 ClickStack 中的集成仍在积极开发中，可能存在功能限制、未来变更或缺陷。

从 2.0.4 版本开始，ClickStack 对 JSON 类型 提供 Beta 支持。

关于此类型的优势，请参见 JSON 类型的优势。

要启用对 JSON 类型的支持，你必须设置以下环境变量：

  • OTEL_AGENT_FEATURE_GATE_ARG='--feature-gates=clickhouse.json' - 在 OTel collector 中启用支持，确保使用 JSON 类型创建模式（schema）。
  • BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true（仅适用于 ClickStack 开源版）- 在 ClickStack UI 应用中启用支持，允许查询 JSON 数据。

例如：

docker run -e OTEL_AGENT_FEATURE_GATE_ARG='--feature-gates=clickhouse.json' -e BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true -p 8080:8080 -p 4317:4317 -p 4318:4318 clickhouse/clickstack-all-in-one:latest