Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

开始使用 ClickStack 开源版

在本地运行 ClickStack 开源版,通过其 OpenTelemetry Collector 发送测试事件,并确认该事件已显示在 ClickStack UI 中。

使用 ClickStack 开源版时,您需要自行运行和管理 ClickHouse 后端、ClickStack UI 和摄取管道。all-in-one 镜像将这些组件与 MongoDB 打包在一个 Docker 容器中,便于进行本地评估和测试。

以下步骤使用需要身份验证的 all-in-one 镜像。如果您希望无需创建账户即可使用本地 UI,请改为参阅 Docker 本地模式操作指南

开始前准备

安装 Docker,并确认以下端口可用:

  • ClickStack UI 使用 8080
  • 通过 gRPC 传输 OTLP 使用 4317
  • 通过 HTTP 传输 OTLP 使用 4318
  • ClickHouse HTTP 接口使用 8123

对于持续运行的工作负载或生产环境,请参阅开源部署选项投入生产环境

使用 all-in-one 镜像部署 ClickStack 开源版

启动 ClickStack

运行 all-in-one 镜像:

docker run \
  --name clickstack \
  -p 8123:8123 \
  -p 8080:8080 \
  -p 4317:4317 \
  -p 4318:4318 \
  clickhouse/clickstack-all-in-one:latest

容器将在前台运行。请保持此终端打开,并使用第二个终端执行本指南中的其余命令。

持久化数据和设置

若要在删除容器后保留 ClickStack 设置、ClickHouse 数据和 ClickHouse 日志,请改为运行以下命令:

docker run \
  --name clickstack \
  -p 8123:8123 \
  -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

$(pwd) 会解析为当前目录。此命令会将持久化文件存储在该位置的 .volumes 目录中。

发送测试数据

在第二个终端中,导出摄取 API key:

export CLICKSTACK_API_KEY=<your_ingestion_api_key>

发送一条带有当前时间戳的 OTLP 日志:

NOW_NANO="$(date +%s)000000000"

curl -i "http://localhost:4318/v1/logs" \
  -H "Content-Type: application/json" \
  -H "authorization: ${CLICKSTACK_API_KEY}" \
  --data-binary @- <<EOF
{
  "resourceLogs": [{
    "resource": {
      "attributes": [{
        "key": "service.name",
        "value": {"stringValue": "clickstack-docs-test"}
      }]
    },
    "scopeLogs": [{
      "scope": {"name": "clickstack-docs-test"},
      "logRecords": [{
        "timeUnixNano": "${NOW_NANO}",
        "severityText": "INFO",
        "body": {"stringValue": "ClickStack ingestion test"}
      }]
    }]
  }]
}
EOF

请求成功时将返回 HTTP/1.1 200 OK

确认摄取

在 ClickStack 中打开 搜索 视图,然后搜索 ClickStack ingestion test

结果中应包含服务名称为 clickstack-docs-test 的测试事件。

ClickStack 开源版日志视图,显示 ClickStack 摄取测试事件

现在,您已拥有本地 ClickStack 实例、可用的摄取端点,以及可在 ClickStack 中查看的测试事件。

后续步骤

发送应用和基础设施数据

根据要发送到 ClickStack 的数据选择相应指南:

探索样本数据

使用样本数据集,通过更丰富的遥测数据体验 ClickStack:

若要在不安装 Docker 的情况下探索预加载的数据,请使用托管的 ClickStack 演示环境

生成合成数据

无需现有应用程序或数据集,即可使用生成器测试数据摄取:

请参阅所有 ClickStack 样本数据和演示

为生产环境做好准备

在使用 ClickStack 承载持续运行的工作负载之前,请查阅部署和生产环境相关指南:

Navigation