项目、服务、环境
完成项目接入
安装 CLI。运行logbrew status --json 查看账号的访问权限。如果访问权限无效,由人运行 logbrew login。项目接入密钥不能用于登录。
1
2
在 SDK 中设置服务名
使用代码仓库和部署中的名称,例如
api、worker、web、ios 或 checkout-api。服务名只是一个标签,不能用来选择项目。项目由接入密钥决定。重命名服务不会移动已存储的信号。如果找不到某个信号,先检查应用使用的项目和接入密钥,再考虑创建新项目。3
使用标准环境名
使用
production、staging、preview 和 local。如果你的部署使用其他名称,就始终使用同一套名称。环境名不能包含空格、/ 或反斜杠。4
发送测试信号并读取
按照 SDK 接入的说明,用项目接入密钥配置 SDK。创建项目不会在你的应用中安装 SDK。不要把密钥提交到源代码管理中。在应用中设置服务、环境和版本。发送一个安全的信号,然后读取它:每种信号都有自己的列表。日志列表为空并不表示项目中没有问题或链路。在控制台中,选择同一个项目,以及包含该测试信号的时间范围。确认服务、环境和版本筛选条件与该信号一致。
诊断项目接入
用项目 doctor 读取接入状态。不要根据本地文件或空的日志查询推断接入状态。status、checks 和 next 的报告。退出码为 0 并不表示所有检查都已通过。逐项查看 checks 中的内容。参见读取项目 doctor 报告。
直接调用 API 的响应
API 客户端使用账号身份验证调用GET /api/projects/{project_id}/doctor。该端点没有查询参数,也没有请求体。不要用项目接入密钥进行这项读取。
200 响应包含以下键:project_id、state、setup_status、setup_acknowledged、has_active_ingest_key、first_telemetry_seen_at、last_seen_at、last_signal、next 和 next_action。时间戳为 RFC3339 格式或 null。last_signal 是可安全显示的摘要,不是原始信号。
doctor 会先检查接入密钥。没有有效接入密钥的项目,无论接入状态如何,都是
needs_ingest_key。
setup_status 的值为 created、setup_started、sdk_seen、first_telemetry_seen 或 active。只有后 3 个值的 setup_acknowledged 为 true。created 对应 needs_setup。setup_started 和 sdk_seen 对应 needs_telemetry。first_telemetry_seen 和 active 对应 ready。
如果读取仍然失败,报告问题。不要在工单中包含凭据、请求头、信号正文、客户数据、本地路径或源代码。
归档或删除项目
归档项目可以将其从活动项目列表中移除:--yes。归档后,该项目的接入密钥就无法再发送新的遥测数据。对应的 API 路由是 DELETE /api/projects/{project_id},返回 204,不带响应体。使用 GET /api/projects/archived 列出已归档的项目。使用 POST /api/projects/{project_id}/restore 恢复项目,该请求同样返回 204。
只有在确定无误时,才永久删除项目:
--confirm 后再次输入完全相同的项目 ID。请求被接受后,项目会立即停用,并安排永久删除。此后无法恢复该项目。
