开源发行版设置
Docker
Docker Compose
.env 文件修改设置。
或者，也可以直接在 docker-compose.yaml 文件中显式覆盖这些设置，例如：
示例：
Helm
自定义配置值 (可选)
--set 参数来自定义设置，例如：
values.yaml。如需获取默认配置值：
ClickStack UI (HyperDX) 应用
数据源设置
LogsTracesMetricsSessions
Team Settings -> Sources 中完成，下面以日志为例：
创建这些数据源时，每个数据源都至少需要指定一张表，以及一组供 HyperDX 查询数据的列。
如果使用 ClickStack 附带的默认 OpenTelemetry (OTel) schema，则每个数据源所需的这些列都可以自动推断出来。如果修改 schema或使用自定义 schema，则用户需要指定并更新这些映射。
ClickStack 附带的默认 ClickHouse schema，是由 OTel collector 的 ClickHouse exporter 创建的 schema。这些列名与 此处 文档中的 OTel 官方规范相对应。
日志
链路追踪
指标
会话
高亮属性
- 高亮属性是查看日志或 span 详情时，为每条日志或 span 显示的列或表达式。
- 高亮 trace 属性是从某个 trace 中的每条日志或 span 查询出的列或表达式，并显示在 trace 瀑布图上方。
Logs：可与链路追踪和指标关联。Traces：可与日志、会话和指标关联。Metrics：可与日志关联。Sessions：可与链路追踪关联。
应用配置设置
ClickHouse Cloud 中的 HyperDX当 HyperDX 由 ClickHouse Cloud 托管时，这些设置不可修改。
-
HYPERDX_API_KEY- 默认值： None (必填)
- 说明： 用于 HyperDX API 的身份验证密钥。
- 指导：
- 遥测和日志功能必需
- 在本地开发环境中，可使用任意非空值
- 在生产环境中，请使用安全且唯一的密钥
- 创建账户后，可从 Team Settings 页面获取
-
HYPERDX_LOG_LEVEL- 默认值：
info - 说明： 设置日志详细程度。
- 可选项：
debug,info,warn,error - 建议：
- 使用
debug进行详细故障排查 - 使用
info用于正常运行 - 在生产环境中使用
warn或error以减少日志量
- 默认值：
-
HYPERDX_API_PORT- 默认值：
8000 - 说明： HyperDX API 服务器使用的端口。
- 指导：
- 确保该端口在主机上可用
- 如果存在端口冲突，请更改此端口
- 必须与 API 客户端配置中的端口保持一致
- 默认值：
-
HYPERDX_APP_PORT- 默认值：
8000 - 说明： HyperDX 前端应用使用的端口。
- 指导：
- 确保此端口在主机上可用
- 如果发生端口冲突，请更改该端口
- 必须可通过浏览器访问
- 默认值：
-
HYPERDX_APP_URL- 默认值：
http://localhost - 说明： 前端应用的基础 URL。
- 指导：
- 在生产环境中将其设置为你的域名
- 包含协议 (http/https)
- 不要包含末尾斜杠
- 默认值：
-
MONGO_URI- 默认值：
mongodb://db:27017/hyperdx - 说明： MongoDB 连接字符串。
- 指导：
- 在使用 Docker 的本地开发环境中，可使用默认值
- 在生产环境中，请使用安全的连接字符串
- 如果需要，请包含身份验证信息
- 示例：
mongodb://user:pass@host:port/db
- 默认值：
-
MINER_API_URL- 默认值：
http://miner:5123 - 说明： 日志模式挖掘服务的 URL。
- 指导：
- 在使用 Docker 的本地开发环境中使用默认值
- 在生产环境中，将其设置为你的 miner 服务 URL
- 必须可从 API 服务访问
- 默认值：
-
FRONTEND_URL- 默认值：
http://localhost:3000 - 说明： 前端应用的 URL。
- 建议：
- 本地开发时使用默认值
- 在生产环境中设置为您的域名
- API 服务必须能够访问该地址
- 默认值：
-
OTEL_SERVICE_NAME- 默认值：
hdx-oss-api - 说明： OpenTelemetry 插桩的服务名称。
- 指导：
- 为 HyperDX 服务使用便于识别的名称。适用于 HyperDX 自行插桩的场景。
- 有助于在遥测数据中识别 HyperDX 服务
- 默认值：
-
NEXT_PUBLIC_OTEL_EXPORTER_OTLP_ENDPOINT- 默认值：
http://localhost:4318 - 说明： OpenTelemetry collector 端点。
- 指导：
- 适用于 HyperDX 自行埋点。
- 本地开发时使用默认值
- 在生产环境中，将其设置为你的 collector URL
- 必须可从你的 HyperDX 服务访问
- 默认值：
-
USAGE_STATS_ENABLED- 默认值：
true - 说明： 用于控制是否收集使用统计信息。
- 指导：
- 设置为
false可禁用使用情况跟踪 - 适用于对隐私较为敏感的部署
- 默认为
true，以便更好地改进产品
- 默认值：
-
IS_OSS- 默认值：
true - 说明： 表示是否以 OSS 模式运行。
- 指导：
- 开源部署时，保持为
true - Enterprise 部署时，设置为
false - 会影响功能可用性
- 默认值：
-
IS_LOCAL_MODE- 默认值：
false - 说明： 指示是否以本地模式运行。
- 建议：
- 本地开发时设置为
true - 会禁用某些生产环境功能
- 适用于测试和开发
- 默认值：
-
EXPRESS_SESSION_SECRET- 默认值：
hyperdx is cool 👋 - 说明： 用于 Express 会话管理的密钥。
- 指南：
- 请在生产环境中更改
- 使用高强度的随机字符串
- 妥善保密并安全存储
- 默认值：
-
ENABLE_SWAGGER- 默认值：
false - 说明： 用于启用或禁用 Swagger API 文档。
- 指导：
- 设置为
true以启用 API 文档 - 适用于开发和测试环境
- 在生产环境中禁用
- 默认值：
-
BETA_CH_OTEL_JSON_SCHEMA_ENABLED- 默认值：
false - 说明： 在 HyperDX 中启用对 JSON type 的 Beta 支持。另请参阅
OTEL_AGENT_FEATURE_GATE_ARG，以在 OTel collector 中启用 JSON 支持。 - 指导：
- 这会启用一项 Beta 功能。对于典型的可观测性 workloads，不建议使用 JSON 类型的 schema。有关两者的对比及各自适用场景，请参阅 Map vs JSON type。
- 将其设置为
true，即可在 ClickStack UI 中启用 JSON 支持。
- 默认值：
OpenTelemetry collector
-
CLICKHOUSE_ENDPOINT- 默认值： 独立镜像时为 无 (必填) 。如果是 All-in-one 或 Docker Compose 发行版，则会设置为集成的 ClickHouse 实例。
- 说明： 用于将遥测数据导出到 ClickHouse 实例的 HTTPS URL。
- 指导：
- 必须是包含端口的完整 HTTPS 端点 (例如：
https://clickhouse.example.com:8443) - collector 向 ClickHouse 发送数据时必需
- 必须是包含端口的完整 HTTPS 端点 (例如：
-
CLICKHOUSE_USER- 默认值：
default - 说明： 用于向 ClickHouse 实例进行身份验证的用户名。
- 指导：
- 确保该用户具有
INSERT和CREATE TABLE权限 - 建议为摄取创建专用用户
- 确保该用户具有
- 默认值：
-
CLICKHOUSE_PASSWORD- 默认值： 无 (启用身份验证时必填)
- 说明： 指定 ClickHouse 用户的密码。
- 指导：
- 如果该用户账户设置了密码，则此项必填
- 在生产环境部署中通过 secrets 安全存储
-
HYPERDX_LOG_LEVEL- 默认值：
info - 说明： collector 的日志详细级别。
- 指导：
- 可接受的值包括
debug、info、warn、error - 在故障排查期间使用
debug
- 可接受的值包括
- 默认值：
-
OPAMP_SERVER_URL- 默认值： 独立镜像时为 无 (必填) 。如果是 All-in-one 或 Docker Compose 发行版，则指向已部署的 HyperDX 实例。
- 说明： 用于管理 collector 的 OpAMP server URL (例如 HyperDX 实例) 。默认端口为
4320。 - 指导：
- 必须指向你的 HyperDX 实例
- 启用动态配置和安全摄取
- 如果省略，则会禁用安全摄取，除非指定了
OTLP_AUTH_TOKEN值。
-
OTLP_AUTH_TOKEN- 默认值： 无。仅用于独立镜像。
- 说明： 允许指定 OTLP 身份验证令牌。如果设置了该值，则所有通信都需要此 Bearer 令牌。
- 指导：
- 如果在生产环境中使用独立 collector 镜像，建议设置此项。
-
HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE- 默认值：
default - 说明： collector 将遥测数据写入的 ClickHouse database。
- 指导：
- 如果使用自定义 database 名称，请设置此项
- 确保指定用户对该 database 具有访问权限
- 默认值：
-
OTEL_AGENT_FEATURE_GATE_ARG- 默认值：
<empty string> - 说明： 在 collector 中启用功能开关。如果设置为
--feature-gates=clickhouse.json，则会在 collector 中启用 JSON type 的 Beta 支持，并确保使用该类型创建 schema。另请参见BETA_CH_OTEL_JSON_SCHEMA_ENABLED以在 HyperDX 中启用 JSON 支持。 - 指导：
- 这会启用一项 Beta 功能。对于典型的可观测性 workload，不建议使用 JSON-typed schemas。有关对比以及各自适用场景，请参见 Map vs JSON type。
- 设置为
--feature-gates=clickhouse.json，以使用 JSON type 创建新表。
- 默认值：