接入 LogBrew 遥测

选择应用或框架，创建项目，然后验证一个安全的信号。

选择平台打开“添加项目”

选择平台

选择发送遥测数据的应用或框架。在“添加项目”中也选择同一项。

筛选平台
显示 6 / 26

Node.js

Node.js 服务

后端服务需要日志、请求 Span、操作、版本和指标时，使用 Node.js 包。

npm install @logbrew/sdk @logbrew/node
按 Node 首个信号路径操作

Express

Express 服务

Node 服务通过 Express 中间件处理请求时，使用 Express 包。

npm install @logbrew/sdk @logbrew/express express
打开“添加项目”

Fastify

Fastify 服务

Node 服务通过 Fastify 插件处理路由时，使用 Fastify 包。

npm install @logbrew/sdk @logbrew/fastify fastify
打开“添加项目”

NestJS

NestJS 服务

Node 服务基于 Nest 模块和请求处理来组织时，使用 NestJS 包。

npm install @logbrew/sdk @logbrew/nestjs @nestjs/common @nestjs/core @nestjs/platform-express reflect-metadata rxjs
打开“添加项目”

Python

Python 服务

Python 后台任务和服务从核心包开始。

python3 -m pip install logbrew-sdk
打开“添加项目”

Django

Django 应用

Django 项目上报请求和应用信号时，使用 Django 包。

python3 -m pip install logbrew-sdk logbrew-django
打开“添加项目”

安装命令

第一次成功运行 SDK

第一次只做必要的事：安装包，创建项目，发送一个不含机密的产品操作，然后在 LogBrew 中确认。

  1. 1安装 SDK后端服务需要日志、Span、操作、版本和指标时，使用 Node 包。
    npm install @logbrew/sdk @logbrew/node
  2. 2创建项目打开“添加项目”，选择平台，然后复制接入凭据。接入面板只显示一次。打开“添加项目”
  3. 3发送一个产品操作在接入生产代码前，先运行打包好的示例，确认第一条数据的结构且不含令牌。
    node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs
  4. 4在 LogBrew 中验证增加更多插桩前，先在日志中读取第一个 info 信号。
    logbrew logs info --json

在智能体修改你的应用或接入命令之前，先给它公开的 LogBrew 地图。

curl -L https://logbrew.co/llms.txt
安装提示词阅读 https://logbrew.co/llms.txt，然后在 https://logbrew.co/en/docs#docs-sdk-choice-title 选择匹配的 SDK 卡片。npm install @logbrew/sdk @logbrew/node 只用于服务端 Node.js 服务；Next.js、React、iOS、Android 或 React Native 请使用所选卡片和“添加项目”中的提示词。请已登录的用户打开“添加项目”，并且只把凭据放在对应应用的环境中。服务端 Node.js 的环境变量是 LOGBREW_SERVER_API_KEY。仅对 Node 服务运行 node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs，然后用 logbrew logs info --json 验证。不要在聊天或提交中索要凭据。
打开智能体指南

接入一个 Node.js 服务并验证它的第一条遥测数据。“添加项目”会创建项目，并只显示一次接入凭据。以下步骤涵盖安装和验证。

  1. 添加 JavaScript SDK 包

    后端服务需要日志、请求 Span、操作、版本和指标时，从核心 SDK 和 Node 辅助包开始。

    npm install @logbrew/sdk @logbrew/node

  2. 在“添加项目”中创建项目

    登录，打开“添加项目”，选择平台，然后复制接入凭据。凭据只显示一次。离开接入面板后，网站不会再次显示。

    打开“添加项目”

  3. 运行首个 SDK 信号示例

    在接入应用代码前，用已安装包中的示例查看版本、环境、请求 Span、产品操作、网络节点和指标的数据结构。

    node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs

  4. 在 LogBrew 中读取第一个信号

    SDK 用项目凭据发送一个 info 信号后，先用 CLI 或控制台的日志视图确认已收到，再增加更多插桩。

    logbrew logs info --json

docs.logbrew.co

完整文档站

长篇接入说明、API 详情和示例请查看独立的文档站，避免挤占产品介绍页。

打开文档站

纯文本

Markdown 文档镜像

当智能体或终端工作流需要同样的文档、但不依赖浏览器状态时，使用本地化的 Markdown 镜像。

打开 Markdown

纯文本

智能体镜像

当智能体需要可预测的公开读取路径时，使用 llms.txt、Markdown 镜像、robots 和 sitemap。

打开 llms.txt

接入

检查 LogBrew 是否就绪

先运行 status，确认连通性、登录状态和下一步安全读取。

logbrew status --json

分诊

从最新的故障开始

先读取最近的错误日志；当某个版本或项目需要上下文时，再进入问题或链路。

logbrew logs error --json

交接

共享稳定的问题视图

同事需要查看同一批故障分组时，列出未解决的问题。

logbrew issues open --json

命令一览

状态

在读取任何私有数据前，检查本地认证、API 连通性和恢复步骤。

logbrew status --json

命令一览

日志

当版本、项目或链路需要上下文时，从最近的错误开始。

logbrew logs error --json

命令一览

问题

先列出未解决的故障分组，再决定解决、关闭、忽略还是重新打开。

logbrew issues open --json

命令一览

链路详情

当日志或问题指向某个失败请求时，读取已知的 trace id。

logbrew trace <trace_id> --json

命令一览

操作

当关键上下文是某个产品操作时，按名称筛选用户事件。

logbrew actions --name checkout_failed --json

命令一览

版本

将发布上下文与日志、问题、链路 Span 和操作的数量进行比较。

logbrew releases --json

CLI 优先

检查本地认证和 API 连通性

第一次读取应告诉你 CLI 能否连接 LogBrew API，且不暴露任何令牌内容。

  • 脚本或自动化需要稳定字段时，使用 JSON 模式。
  • 开发者需要下一条命令时，使用人类可读输出。
  • 认证恢复始终指回 login 和 status。

观测

按资源读取生产环境信号

从能回答你问题的信号开始。打开详情查看相关证据。

  • 日志保留严重程度、版本、环境、项目、链路和搜索筛选条件。
  • 排查问题前，先查看它的状态和最近一次发生记录。
  • 链路保留 Span 名称、版本上下文、环境上下文和项目范围。

共享

发送有用的上下文，不暴露项目数据

有人需要接入帮助或安全交接时，使用公开文档、Markdown 和可复制的命令。

  • 下一步是接入或查找命令时，共享文档链接。
  • 纯文本比截图更方便时，共享 Markdown。
  • 私有项目数据只与有权查看的人共享。

API 读取

选择项目和时间范围

支持的路由、筛选条件以及成功和错误示例，请参阅遥测 API 参考。

  • 请求私有项目数据前先完成认证。
  • 比较结果前先选择项目和时间范围。
  • 请求失败时，按照返回的恢复步骤操作。
  • 将缺失的证据与无法加载的证据区分开。