# 接入 LogBrew 遥测 选择应用或框架，创建项目，然后验证一个安全的信号。 # 选择平台 选择发送遥测数据的应用或框架。在“添加项目”中也选择同一项。 ## Node.js 服务 后端服务需要日志、请求 Span、操作、版本和指标时，使用 Node.js 包。 ```bash npm install @logbrew/sdk @logbrew/node ``` Next: 按 Node 首个信号路径操作 ## Express 服务 Node 服务通过 Express 中间件处理请求时，使用 Express 包。 ```bash npm install @logbrew/sdk @logbrew/express express ``` Next: 打开“添加项目” ## Fastify 服务 Node 服务通过 Fastify 插件处理路由时，使用 Fastify 包。 ```bash npm install @logbrew/sdk @logbrew/fastify fastify ``` Next: 打开“添加项目” ## JavaScript 应用 前端页面需要上报产品操作、日志和轻量客户端信号时，使用 JavaScript 浏览器包。 ```bash npm install @logbrew/sdk @logbrew/browser ``` Next: 打开“添加项目” ## Next.js 应用 路由、服务端渲染和客户端操作需要同一条接入路径时，使用 Next.js 包。 ```bash npm install @logbrew/sdk @logbrew/next next react react-dom ``` Next: 打开“添加项目” ## React 应用 组件化的 Web 应用需要发送用户操作和 UI 状态时，使用 React 包。 ```bash npm install @logbrew/sdk @logbrew/react react ``` Next: 打开“添加项目” ## Angular 应用 框架路由和应用错误需要共用一条接入路径时，使用 Angular 包。 ```bash npm install @logbrew/sdk @logbrew/angular @angular/core ``` Next: 打开“添加项目” ## Vue 应用 Vue 应用需要清晰的产品操作和浏览器端信号时，使用 Vue 包。 ```bash npm install @logbrew/sdk @logbrew/vue vue ``` Next: 打开“添加项目” ## Svelte 应用 Svelte 应用需要直接安装 SDK 时，使用 Svelte 包。 ```bash npm install @logbrew/sdk @logbrew/svelte svelte ``` Next: 打开“添加项目” ## NestJS 服务 Node 服务基于 Nest 模块和请求处理来组织时，使用 NestJS 包。 ```bash npm install @logbrew/sdk @logbrew/nestjs @nestjs/common @nestjs/core @nestjs/platform-express reflect-metadata rxjs ``` Next: 打开“添加项目” ## Python 服务 Python 后台任务和服务从核心包开始。 ```bash python3 -m pip install logbrew-sdk ``` Next: 打开“添加项目” ## Django 应用 Django 项目上报请求和应用信号时，使用 Django 包。 ```bash python3 -m pip install logbrew-sdk logbrew-django ``` Next: 打开“添加项目” ## FastAPI 服务 Python API 需要显式的请求 Span 和操作时，使用 FastAPI 包。 ```bash python3 -m pip install logbrew-sdk logbrew-fastapi ``` Next: 打开“添加项目” ## .NET 服务 服务需要上报服务端信号时，安装 .NET 包。 ```bash dotnet add package LogBrew ``` Next: 打开“添加项目” ## ASP.NET Core 应用 .NET 请求处理和 Web 应用信号需要同一条接入路径时，使用 ASP.NET Core 包。 ```bash dotnet add package LogBrew.AspNetCore ``` Next: 打开“添加项目” ## Java 服务 Java 服务需要应用自有的日志、请求 Span 和产品操作时，使用 JVM 包。 ```bash implementation("co.logbrew:logbrew-sdk:0.1.0") ``` Next: 打开“添加项目” ## Go 服务 服务需要显式上报日志、Span、指标和链路上下文时，添加 Go 包。 ```bash go get github.com/LogBrewCo/sdk/go/logbrew@v0.1.3 ``` Next: 打开“添加项目” ## PHP 应用 PHP 服务和应用自有的请求信号使用 Composer 安装。 ```bash composer require logbrew/sdk ``` Next: 打开“添加项目” ## Ruby 服务 Ruby 服务需要显式的应用和请求信号时，使用 Ruby gem。 ```bash gem install logbrew-sdk ``` Next: 打开“添加项目” ## Rust 服务 服务自行构建日志、Span、操作和指标时，添加 Rust crate。 ```bash cargo add logbrew ``` Next: 打开“添加项目” ## iOS 应用 iOS 应用需要发送显式产品信号时，使用 Apple 平台包。 ```bash .package(url: "https://github.com/LogBrewCo/sdk.git", from: "0.1.1") ``` Next: 打开“添加项目” ## Android 应用 应用需要从 Android 运行时发送应用自有信号时，使用 Android 包。 ```bash implementation("co.logbrew:logbrew-kotlin:0.1.0") ``` Next: 打开“添加项目” ## React Native 应用 移动应用需要共用 JavaScript 产品操作时，使用 React Native 包。 ```bash npm install @logbrew/sdk @logbrew/react-native react react-native ``` Next: 打开“添加项目” ## Unity 应用 游戏或仿真需要发送产品操作和运行时信号时，使用 Unity 包。 ```bash "co.logbrew.unity": "file:../Packages/co.logbrew.unity" ``` Next: 打开“添加项目” ## C 应用 原生服务或嵌入式应用需要直接控制信号时，使用 C 源码。 ```bash cc -std=c99 -Wall -Wextra -Wpedantic -Iinclude src/logbrew.c src/logbrew_metric.c src/logbrew_recording_transport.c src/logbrew_timeline.c src/logbrew_trace.c your_app.c -o your_app ``` Next: 打开“添加项目” ## C++ 应用 在 CMake 3.16+、C++17 项目中运行已发布的 CLI 接入计划。链接 LogBrew::LogBrew。仅在需要托管投递时启用 LogBrew::HttpTransport 和 libcurl。 ```bash logbrew setup --json ``` Next: 打开“添加项目” ## 接入路径一览 按这个顺序，从文档走到一个已验证的产品操作，全程不离开接入流程。 - 安装. 添加包: 从适合你运行时的 SDK 包开始。 - 创建. 创建项目: 打开“添加项目”并复制项目凭据。凭据只显示一次。 - 发送. 发送一个产品操作: 在接入应用代码前，先运行一个不含机密的产品操作。 - 验证. 查看日志: 在日志中或用 CLI 确认该信号。 # 第一次成功运行 SDK 第一次只做必要的事：安装包，创建项目，发送一个不含机密的产品操作，然后在 LogBrew 中确认。 ## 首个信号接入所需条件 SDK 直接上报，接入路径更短。 - 采集器: 无需本地 Agent. 安装 SDK 包，直接发送到 LogBrew API。 - 凭据: 一个项目凭据. 只在创建或接入该项目时，从“添加项目”中复制。 - 验证: 在日志中验证. 先发送一个 info 信号并确认，再扩大插桩范围。 ## AI 助手上下文 在智能体修改你的应用或接入命令之前，先给它公开的 LogBrew 地图。 ```bash curl -L https://logbrew.co/llms.txt ``` ### 安装提示词 ```bash 阅读 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 验证。不要在聊天或提交中索要凭据。 ``` Next: 打开智能体指南 ## 安装 SDK 后端服务需要日志、Span、操作、版本和指标时，使用 Node 包。 ```bash npm install @logbrew/sdk @logbrew/node ``` ## 创建项目 打开“添加项目”，选择平台，然后复制接入凭据。接入面板只显示一次。 Next: 打开“添加项目” ## 发送一个产品操作 在接入生产代码前，先运行打包好的示例，确认第一条数据的结构且不含令牌。 ```bash node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs ``` ## 在 LogBrew 中验证 增加更多插桩前，先在日志中读取第一个 info 信号。 ```bash logbrew logs info --json ``` # 向 LogBrew 发送第一个 Node SDK 信号 接入一个 Node.js 服务并验证它的第一条遥测数据。“添加项目”会创建项目，并只显示一次接入凭据。以下步骤涵盖安装和验证。 ## 添加 JavaScript SDK 包 后端服务需要日志、请求 Span、操作、版本和指标时，从核心 SDK 和 Node 辅助包开始。 ```bash npm install @logbrew/sdk @logbrew/node ``` ## 在“添加项目”中创建项目 登录，打开“添加项目”，选择平台，然后复制接入凭据。凭据只显示一次。离开接入面板后，网站不会再次显示。 ## 运行首个 SDK 信号示例 在接入应用代码前，用已安装包中的示例查看版本、环境、请求 Span、产品操作、网络节点和指标的数据结构。 ```bash node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs ``` ## 在 LogBrew 中读取第一个信号 SDK 用项目凭据发送一个 info 信号后，先用 CLI 或控制台的日志视图确认已收到，再增加更多插桩。 ```bash logbrew logs info --json ``` # 选择你的路径 ## 检查 LogBrew 是否就绪 先运行 status，确认连通性、登录状态和下一步安全读取。 ```bash logbrew status --json ``` ## 从最新的故障开始 先读取最近的错误日志；当某个版本或项目需要上下文时，再进入问题或链路。 ```bash logbrew logs error --json ``` ## 共享稳定的问题视图 同事需要查看同一批故障分组时，列出未解决的问题。 ```bash logbrew issues open --json ``` # 命令一览 ## 状态 在读取任何私有数据前，检查本地认证、API 连通性和恢复步骤。 ```bash logbrew status --json ``` ## 日志 当版本、项目或链路需要上下文时，从最近的错误开始。 ```bash logbrew logs error --json ``` ## 问题 先列出未解决的故障分组，再决定解决、关闭、忽略还是重新打开。 ```bash logbrew issues open --json ``` ## 链路详情 当日志或问题指向某个失败请求时，读取已知的 trace id。 ```bash logbrew trace --json ``` ## 操作 当关键上下文是某个产品操作时，按名称筛选用户事件。 ```bash logbrew actions --name checkout_failed --json ``` ## 版本 将发布上下文与日志、问题、链路 Span 和操作的数量进行比较。 ```bash logbrew releases --json ``` ## 检查本地认证和 API 连通性 第一次读取应告诉你 CLI 能否连接 LogBrew API，且不暴露任何令牌内容。 - 脚本或自动化需要稳定字段时，使用 JSON 模式。 - 开发者需要下一条命令时，使用人类可读输出。 - 认证恢复始终指回 login 和 status。 ## 按资源读取生产环境信号 从能回答你问题的信号开始。打开详情查看相关证据。 - 日志保留严重程度、版本、环境、项目、链路和搜索筛选条件。 - 排查问题前，先查看它的状态和最近一次发生记录。 - 链路保留 Span 名称、版本上下文、环境上下文和项目范围。 ## 发送有用的上下文，不暴露项目数据 有人需要接入帮助或安全交接时，使用公开文档、Markdown 和可复制的命令。 - 下一步是接入或查找命令时，共享文档链接。 - 纯文本比截图更方便时，共享 Markdown。 - 私有项目数据只与有权查看的人共享。 ## 选择项目和时间范围 支持的路由、筛选条件以及成功和错误示例，请参阅遥测 API 参考。 - 请求私有项目数据前先完成认证。 - 比较结果前先选择项目和时间范围。 - 请求失败时，按照返回的恢复步骤操作。 - 将缺失的证据与无法加载的证据区分开。 ## Public agent links - Full docs site: https://docs.logbrew.co - Docs: https://logbrew.co/zh-Hans/docs - Docs Markdown: https://logbrew.co/zh-Hans/docs.md - Agent guide: https://logbrew.co/zh-Hans/agents - Home Markdown: https://logbrew.co/zh-Hans/page.md - llms.txt: https://logbrew.co/llms.txt - Sitemap: https://logbrew.co/sitemap.xml