@volcengine/diagnostics-tls-install

一键安装并配置 OpenClaw 插件 @volcengine/diagnostics-tls 的交互式安装器（会写入 openclaw.json）。

使用

交互式安装

npm exec -y --package=@volcengine/diagnostics-tls-install -- diagnostics-tls-install

按提示输入配置即可完成安装与配置。

非交互式（一键）安装

如果你希望在 CI/CD 或自动化脚本中跳过交互直接安装，可以使用 --non-interactive 标志以及相关参数：

使用 API Key 模式（推荐）：

npm exec -y --package=@volcengine/diagnostics-tls-install -- diagnostics-tls-install \
  --non-interactive \
  --region <your-region> \
  --api-key <your-api-key> \
  --topic-id-app-log <App日志 TopicID> \
  --topic-id-audit-log <配置日志 TopicID> \
  --topic-id-cache-trace <CacheTrace日志 TopicID> \
  --topic-id-session <Session日志 TopicID> \
  --topic-id-trace <Trace日志 TopicID> \
  --topic-id-metric <Metric TopicID>

注意：在 apiKey 模式下，Topic ID 都是可选的（可以不传），插件将在需要时根据配置向 TLS 发送数据。

使用 AK/SK 模式：

npm exec -y --package=@volcengine/diagnostics-tls-install -- diagnostics-tls-install \
  --non-interactive \
  --region <your-region> \
  --project-name <project-name> \
  --app-name <app-name> \
  --ak <your-ak> \
  --sk <your-sk>

Node/OpenClaw 版本说明

• 本包本身仅要求 Node.js >= 18（见 package.json#engines）
• 但 OpenClaw 可能要求更高的 Node.js（例如 openclaw@latest 需要 Node.js >= 22.16.0）。请以 OpenClaw 的提示为准。

常见安装失败

• ClawHub 429 / Rate limit exceeded：属于 ClawHub 限流，通常等待一段时间后重试即可。本安装器会自动做指数退避重试，可通过环境变量 DIAGNOSTICS_TLS_INSTALL_OPENCLAW_INSTALL_MAX_ATTEMPTS=1 关闭自动重试。
• npm registry / userconfig：如果你使用自建 registry，请确认 ~/.npmrc 配置了正确的 registry 与鉴权信息；npm exec/npx 可能会使用临时 npmrc，本安装器会尽量选择包含鉴权信息的 userconfig。

联调（本地开发）

• 本地执行 pnpm dev 联调（含 watch）：docs/dev-with-openclaw.md

前置条件

• 已安装 openclaw