跳转到主要内容
SDK 发送成功,只能说明 LogBrew 接受了请求。它不能说明 LogBrew 已存储该信号,也不能说明你能读取它。要验证接入,发送一个测试信号,再把它读回来。 有了项目只读密钥,人、CI 任务或编程智能体无需登录账号,就能读取一个项目。它是项目密钥,不是账号凭据。

项目密钥类型

每个项目密钥属于一个项目。密钥的类型决定它能做什么。运行 logbrew projects keys create 时,用 --kind 选择类型。 sdk、server、cli 和 browser 类型都是接入密钥。选择与密钥运行位置对应的类型。在浏览器中运行的代码使用 browser。切勿把只读密钥放进浏览器代码、移动应用或公开的包中。 账号访问是另一回事。logbrew login 让 CLI 获得你账号的访问权限。切勿把账号访问用作 SDK 配置。只读密钥不能登录 CLI 或控制台。

读回测试信号

1

创建只读密钥

这一步需要账号访问。运行 logbrew status --json,确认它显示账号访问已通过认证。
CLI 会把密钥写入一个仅所有者可访问的新文件。它从不打印密钥或文件路径。--ingest-key-file 是所有密钥类型通用的文件选项。目标文件必须不存在。检查点:结果包含 status: "created" 和 ingest_key.kind: "read"。记下 ingest_key.id。撤销密钥时需要用到它。
2

发送测试信号

用项目接入密钥,从应用发送一条安全的测试日志。按快速入门或 SDK 接入中对应运行时的步骤操作。如果还要测试问题,再发送一个已处理的测试错误。检查点:SDK 报告 2xx 状态。这说明 LogBrew 接受了请求。继续下一步。
3

读回信号

把只读密钥加载到 LOGBREW_TOKEN,只在当前 shell 中生效。然后读取项目:
每次读取只返回密钥所属项目的数据,所以不需要 --project。添加 --service、--environment 或 --release,与测试信号保持一致。检查点:测试日志出现,并带有你的服务、环境和版本。测试错误显示为问题。这说明 LogBrew 已存储这些信号,并且你能读取它们。完成后,运行 unset LOGBREW_TOKEN。CLI 会重新使用你的账号访问。
4

撤销只读密钥

不再需要时,撤销该密钥。这一步需要账号访问,所以先取消设置 LOGBREW_TOKEN。
检查点:结果包含 status: "revoked"。密钥在下一次请求时失效。

为 CI 任务或智能体提供读取权限

为读取一个项目的 CI 任务或编程智能体单独准备一个只读密钥。把密钥存放在 CI 系统或智能体环境的机密存储中,并以 LOGBREW_TOKEN 的形式提供。不要把密钥放进提示词、代码仓库或命令输出。 之后,任务或智能体就可以运行 logbrew issues --json、logbrew issue "<issue_id>" --json 和 logbrew read trace "<trace_id>" 等读取命令。项目、密钥和账号命令需要账号访问。API 客户端调用遥测 API 中的遥测读取接口时,把密钥作为 Bearer 令牌发送。 每个任务或智能体使用一个密钥。这样撤销一个密钥时,不会影响其他密钥。

读取失败时如何恢复

如果遥测数据仍然缺失,按首次遥测检查排查。要替换接入密钥,参见轮换接入密钥。