Thiết lập telemetry cho LogBrew

Chọn ứng dụng hoặc framework, tạo dự án và kiểm tra một tín hiệu an toàn.

Chọn nền tảngMở trang Thêm dự án

Chọn nền tảng

Chọn ứng dụng hoặc framework gửi telemetry. Dùng cùng lựa chọn đó ở trang Thêm dự án.

Lọc nền tảng
Đang hiển thị 6/26

Node.js

Dịch vụ Node.js

Dùng package Node.js khi một dịch vụ backend cần log, span request, hành động, bản phát hành và chỉ số.

npm install @logbrew/sdk @logbrew/node
Dùng hướng dẫn tín hiệu đầu tiên cho Node

Express

Dịch vụ Express

Dùng package Express khi một dịch vụ Node xử lý request qua middleware Express.

npm install @logbrew/sdk @logbrew/express express
Mở trang Thêm dự án

Fastify

Dịch vụ Fastify

Dùng package Fastify khi một dịch vụ Node xử lý route qua plugin Fastify.

npm install @logbrew/sdk @logbrew/fastify fastify
Mở trang Thêm dự án

NestJS

Dịch vụ NestJS

Dùng package NestJS khi một dịch vụ Node được tổ chức theo module Nest và cách xử lý request của Nest.

npm install @logbrew/sdk @logbrew/nestjs @nestjs/common @nestjs/core @nestjs/platform-express reflect-metadata rxjs
Mở trang Thêm dự án

Python

Dịch vụ Python

Bắt đầu với package lõi cho worker và dịch vụ Python.

python3 -m pip install logbrew-sdk
Mở trang Thêm dự án

Django

Ứng dụng Django

Dùng package Django cho tín hiệu request và ứng dụng từ một dự án Django.

python3 -m pip install logbrew-sdk logbrew-django
Mở trang Thêm dự án

Lệnh cài đặt

Lần chạy SDK thành công đầu tiên

Giữ phiên đầu tiên thật gọn: cài package, tạo dự án, gửi một hành động sản phẩm không chứa bí mật, rồi xác nhận trong LogBrew.

  1. 1Cài đặt SDKDùng các package Node cho dịch vụ backend cần log, span, hành động, bản phát hành và chỉ số.
    npm install @logbrew/sdk @logbrew/node
  2. 2Tạo dự ánMở trang Thêm dự án, chọn nền tảng và sao chép thông tin xác thực gửi dữ liệu. Bảng thiết lập chỉ hiển thị nó một lần.Mở trang Thêm dự án
  3. 3Gửi một hành động sản phẩmChạy ví dụ đi kèm package trước khi tích hợp vào mã production, để biết trước cấu trúc dữ liệu đầu tiên và không cần token.
    node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs
  4. 4Kiểm tra trong LogBrewĐọc tín hiệu info đầu tiên trong log trước khi instrument thêm.
    logbrew logs info --json

Đưa cho agent bản đồ LogBrew công khai trước khi nó sửa ứng dụng hoặc lệnh thiết lập của bạn.

curl -L https://logbrew.co/llms.txt
prompt cài đặtĐọc https://logbrew.co/llms.txt, rồi chọn thẻ SDK phù hợp tại https://logbrew.co/en/docs#docs-sdk-choice-title. Chỉ dùng npm install @logbrew/sdk @logbrew/node cho dịch vụ Node.js phía server; với Next.js, React, iOS, Android hoặc React Native, hãy dùng thẻ đã chọn và prompt trong trang Thêm dự án. Đề nghị người dùng đã đăng nhập mở trang Thêm dự án và chỉ đặt thông tin xác thực vào môi trường của đúng ứng dụng đó. Với Node.js phía server, biến môi trường là LOGBREW_SERVER_API_KEY. Chỉ chạy node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs cho dịch vụ Node, rồi kiểm tra bằng logbrew logs info --json. Không yêu cầu thông tin xác thực qua chat hoặc trong commit.
Mở hướng dẫn cho agent

Thiết lập một dịch vụ Node.js và kiểm tra telemetry đầu tiên của nó. Trang Thêm dự án tạo dự án và hiển thị thông tin xác thực gửi dữ liệu một lần. Các bước dưới đây hướng dẫn cài đặt và kiểm tra.

  1. Thêm các package JavaScript SDK

    Bắt đầu với SDK lõi và helper Node khi một dịch vụ backend cần log, span request, hành động, bản phát hành và chỉ số.

    npm install @logbrew/sdk @logbrew/node

  2. Tạo dự án từ trang Thêm dự án

    Đăng nhập, mở trang Thêm dự án, chọn nền tảng và sao chép thông tin xác thực gửi dữ liệu. Thông tin này chỉ hiển thị một lần. Website sẽ không hiển thị lại sau khi bạn rời bảng thiết lập.

    Mở trang Thêm dự án

  3. Chạy ví dụ tín hiệu SDK đầu tiên

    Dùng ví dụ trong package đã cài để xem cấu trúc của bản phát hành, môi trường, span request, hành động sản phẩm, mốc mạng và chỉ số trước khi tích hợp vào ứng dụng.

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

  4. Đọc tín hiệu đầu tiên trong LogBrew

    Sau khi SDK gửi một tín hiệu info kèm thông tin xác thực của dự án, dùng CLI hoặc chế độ xem log trên bảng điều khiển để xác nhận tín hiệu đã đến trước khi instrument thêm.

    logbrew logs info --json

docs.logbrew.co

Trang tài liệu đầy đủ

Dùng trang tài liệu riêng cho hướng dẫn thiết lập chi tiết, thông tin API và ví dụ không nên chen vào các trang giới thiệu sản phẩm.

Mở trang tài liệu

Văn bản thuần

Bản sao tài liệu dạng Markdown

Dùng bản sao Markdown đã bản địa hóa khi agent hoặc quy trình trong terminal cần cùng tài liệu đó mà không phụ thuộc trạng thái chỉ có trên trình duyệt.

Mở Markdown

Văn bản thuần

Bản sao cho agent

Dùng llms.txt, các bản sao Markdown, robots và sitemap khi agent cần đường đọc công khai có thể đoán trước.

Mở llms.txt

Thiết lập

Kiểm tra LogBrew đã sẵn sàng chưa

Chạy status trước để xác nhận kết nối, trạng thái đăng nhập và lần đọc an toàn tiếp theo.

logbrew status --json

Phân loại

Bắt đầu từ lỗi mới nhất

Đọc log lỗi gần đây, rồi chuyển sang vấn đề hoặc trace khi một bản phát hành hay dự án cần thêm ngữ cảnh.

logbrew logs error --json

Bàn giao

Chia sẻ chế độ xem vấn đề ổn định

Liệt kê các vấn đề đang mở khi đồng nghiệp cần xem cùng các nhóm lỗi.

logbrew issues open --json

Bản đồ lệnh

Trạng thái

Kiểm tra xác thực cục bộ, kết nối tới API và các bước khôi phục trước mọi lần đọc dữ liệu riêng tư.

logbrew status --json

Bản đồ lệnh

Log

Bắt đầu với lỗi gần đây khi một bản phát hành, dự án hoặc trace cần ngữ cảnh.

logbrew logs error --json

Bản đồ lệnh

Vấn đề

Liệt kê các nhóm lỗi đang mở trước khi quyết định giải quyết, đóng, bỏ qua hay mở lại.

logbrew issues open --json

Bản đồ lệnh

Chi tiết trace

Đọc một trace id đã biết khi log hoặc vấn đề chỉ đến một request bị lỗi.

logbrew trace <trace_id> --json

Bản đồ lệnh

Hành động

Lọc sự kiện người dùng theo tên khi ngữ cảnh quan trọng là một hành động sản phẩm.

logbrew actions --name checkout_failed --json

Bản đồ lệnh

Bản phát hành

So sánh ngữ cảnh triển khai với số log, vấn đề, span trace và hành động.

logbrew releases --json

CLI trước

Kiểm tra xác thực cục bộ và kết nối tới API

Lần đọc đầu tiên cần cho bạn biết CLI có kết nối được API của LogBrew hay không mà không làm lộ token.

  • Dùng chế độ JSON khi script hoặc tự động hóa cần các trường ổn định.
  • Dùng đầu ra dễ đọc khi lập trình viên cần lệnh tiếp theo.
  • Khi cần khôi phục xác thực, luôn hướng về login và status.

Quan sát

Đọc tín hiệu production theo tài nguyên

Bắt đầu với tín hiệu trả lời được câu hỏi của bạn. Mở chi tiết để xem bằng chứng liên quan.

  • Log giữ các bộ lọc mức độ, bản phát hành, môi trường, dự án, trace và tìm kiếm.
  • Kiểm tra trạng thái và lần xảy ra gần nhất của vấn đề trước khi điều tra.
  • Trace giữ tên span, ngữ cảnh bản phát hành, ngữ cảnh môi trường và phạm vi dự án.

Chia sẻ

Gửi ngữ cảnh hữu ích mà không làm lộ dữ liệu dự án

Dùng tài liệu công khai, Markdown và các lệnh có thể sao chép khi ai đó cần trợ giúp thiết lập hoặc bàn giao an toàn.

  • Chia sẻ liên kết tài liệu khi bước tiếp theo là thiết lập hoặc tìm lệnh.
  • Chia sẻ Markdown khi văn bản thuần dễ dùng hơn ảnh chụp màn hình.
  • Chỉ chia sẻ dữ liệu dự án riêng tư với người có quyền xem.

Đọc qua API

Chọn dự án và khoảng thời gian

Dùng tài liệu tham khảo API telemetry để xem các route, bộ lọc được hỗ trợ cùng ví dụ thành công và lỗi.

  • Xác thực trước khi yêu cầu dữ liệu dự án riêng tư.
  • Chọn dự án và khoảng thời gian trước khi so sánh kết quả.
  • Làm theo các bước khôi phục được trả về khi request thất bại.
  • Tách bằng chứng bị thiếu khỏi bằng chứng không tải được.