Configure a telemetria do LogBrew

Escolha um app ou framework, crie um projeto e verifique um sinal seguro.

Escolher plataformaAbrir Adicionar projeto

Escolher plataforma

Escolha o app ou framework que envia a telemetria. Use a mesma opção em Adicionar projeto.

Filtrar plataformas
6 de 26 exibidos

Node.js

Serviço Node.js

Use o pacote Node.js quando um serviço de backend precisar de logs, spans de requisição, ações, versões e métricas.

npm install @logbrew/sdk @logbrew/node
Seguir o caminho do primeiro sinal no Node

Express

Serviço Express

Use o pacote Express quando um serviço Node tratar requisições com middleware do Express.

npm install @logbrew/sdk @logbrew/express express
Abrir Adicionar projeto

Fastify

Serviço Fastify

Use o pacote Fastify quando um serviço Node tratar rotas com plugins do Fastify.

npm install @logbrew/sdk @logbrew/fastify fastify
Abrir Adicionar projeto

NestJS

Serviço NestJS

Use o pacote NestJS quando um serviço Node for organizado em módulos Nest e no tratamento de requisições.

npm install @logbrew/sdk @logbrew/nestjs @nestjs/common @nestjs/core @nestjs/platform-express reflect-metadata rxjs
Abrir Adicionar projeto

Python

Serviço Python

Comece pelo pacote principal para workers e serviços Python.

python3 -m pip install logbrew-sdk
Abrir Adicionar projeto

Django

App Django

Use o pacote Django para sinais de requisição e do app em um projeto Django.

python3 -m pip install logbrew-sdk logbrew-django
Abrir Adicionar projeto

Comando de instalação

Primeira execução do SDK com sucesso

Mantenha a primeira sessão curta: instale o pacote, crie o projeto, envie uma ação de produto sem segredos e confirme no LogBrew.

  1. 1Instalar SDKUse os pacotes Node em um serviço de backend que precisa de logs, spans, ações, versões e métricas.
    npm install @logbrew/sdk @logbrew/node
  2. 2Criar projetoAbra Adicionar projeto, escolha uma plataforma e copie a credencial de ingestão. A tela de configuração mostra a credencial uma única vez.Abrir Adicionar projeto
  3. 3Enviar uma ação de produtoExecute o exemplo incluído no pacote antes de integrar o código de produção. Assim, o formato do primeiro sinal fica conhecido e sem tokens.
    node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs
  4. 4Verificar no LogBrewLeia o primeiro sinal info nos logs antes de adicionar mais instrumentação.
    logbrew logs info --json

Dê a um agente o mapa público do LogBrew antes que ele edite seu app ou o comando de configuração.

curl -L https://logbrew.co/llms.txt
prompt de instalaçãoLeia https://logbrew.co/llms.txt e escolha o card de SDK correspondente em https://logbrew.co/en/docs#docs-sdk-choice-title. Use npm install @logbrew/sdk @logbrew/node apenas para um serviço Node.js no servidor; para Next.js, React, iOS, Android ou React Native, use o card escolhido e o prompt de Adicionar projeto. Peça ao usuário conectado para abrir Adicionar projeto e colocar as credenciais apenas no ambiente do app correspondente. Para Node.js no servidor, a variável de ambiente é LOGBREW_SERVER_API_KEY. Execute node node_modules/@logbrew/node/examples/first-useful-telemetry.mjs apenas para serviços Node e depois verifique com logbrew logs info --json. Não peça credenciais no chat nem em commits.
Abrir guia para agentes

Configure um serviço Node.js e verifique a primeira telemetria. Adicionar projeto cria o projeto e mostra a credencial de ingestão uma única vez. Os passos abaixo cobrem a instalação e a verificação.

  1. Adicione os pacotes do SDK JavaScript

    Comece pelo SDK principal e pelo helper para Node quando um serviço de backend precisar de logs, spans de requisição, ações, versões e métricas.

    npm install @logbrew/sdk @logbrew/node

  2. Crie o projeto em Adicionar projeto

    Entre, abra Adicionar projeto, escolha uma plataforma e copie a credencial de ingestão. Ela aparece uma única vez. O site não mostra a credencial de novo depois que você sai da tela de configuração.

    Abrir Adicionar projeto

  3. Execute o exemplo do primeiro sinal do SDK

    Use o exemplo do pacote instalado para conferir o formato da versão, do ambiente, do span de requisição, da ação de produto, do marco de rede e da métrica antes de integrar seu app.

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

  4. Leia o primeiro sinal no LogBrew

    Depois que o SDK enviar um sinal info com a credencial do projeto, use a CLI ou a tela de logs do painel para confirmar que ele chegou. Só então adicione mais instrumentação.

    logbrew logs info --json

docs.logbrew.co

Site completo da documentação

Use o site dedicado da documentação para guias completos de configuração, detalhes da API e exemplos que não cabem nas páginas do produto.

Abrir documentação

Texto simples

Espelho da documentação em Markdown

Use o espelho localizado em Markdown quando um agente ou um fluxo no terminal precisar da mesma documentação sem depender do navegador.

Abrir Markdown

Texto simples

Espelhos para agentes

Use llms.txt, os espelhos em Markdown, robots e sitemap quando um agente precisar de caminhos públicos de leitura previsíveis.

Abrir llms.txt

Configurar

Confira se o LogBrew está pronto

Execute o status primeiro para confirmar o acesso à API, o estado do login e a próxima leitura segura.

logbrew status --json

Triagem

Comece pelas falhas mais recentes

Leia os logs de erro recentes e passe para problemas ou traces quando uma versão ou um projeto precisar de contexto.

logbrew logs error --json

Compartilhar

Compartilhe uma visão estável dos problemas

Liste os problemas abertos quando um colega precisar ver os mesmos grupos de falhas.

logbrew issues open --json

Mapa de comandos

Status

Confira a autenticação local, o acesso à API e as etapas de recuperação antes de qualquer leitura privada.

logbrew status --json

Mapa de comandos

Logs

Comece pelos erros recentes quando uma versão, um projeto ou um trace precisar de contexto.

logbrew logs error --json

Mapa de comandos

Problemas

Liste os grupos de falhas abertos antes de decidir se vai resolver, fechar, ignorar ou reabrir.

logbrew issues open --json

Mapa de comandos

Detalhes do trace

Leia um trace pelo ID quando logs ou problemas apontarem para uma requisição com falha.

logbrew trace <trace_id> --json

Mapa de comandos

Ações

Filtre eventos de usuário pelo nome quando o contexto importante for uma ação de produto.

logbrew actions --name checkout_failed --json

Mapa de comandos

Versões

Compare o contexto da implantação com as contagens de logs, problemas, spans de trace e ações.

logbrew releases --json

CLI primeiro

Confira a autenticação local e o acesso à API

A primeira leitura deve dizer se a CLI consegue acessar a API do LogBrew sem expor tokens.

  • Use o modo JSON quando um script ou uma automação precisar de campos estáveis.
  • Use a saída legível quando um desenvolvedor precisar do próximo comando.
  • Mantenha a recuperação da autenticação apontando para login e status.

Observar

Leia os sinais de produção por recurso

Comece pelo sinal que responde à sua pergunta. Abra os detalhes para ver as evidências relacionadas.

  • Os logs mantêm filtros de gravidade, versão, ambiente, projeto, trace e busca.
  • Confira o status e a última ocorrência de um problema antes de investigá-lo.
  • Os traces mantêm nomes de spans, contexto de versão, contexto de ambiente e escopo do projeto.

Compartilhar

Envie contexto útil sem expor dados do projeto

Use a documentação pública, o Markdown e comandos copiáveis quando alguém precisar de ajuda com a configuração ou de uma passagem segura.

  • Compartilhe um link da documentação quando o próximo passo for configurar ou descobrir comandos.
  • Compartilhe Markdown quando texto simples for mais fácil que uma captura de tela.
  • Compartilhe dados privados do projeto só com pessoas que têm permissão para vê-los.

Leituras da API

Escolha o projeto e o período

Use a referência da API de telemetria para ver as rotas, os filtros e os exemplos de sucesso e de erro disponíveis.

  • Autentique-se antes de solicitar dados privados do projeto.
  • Selecione o projeto e o período antes de comparar resultados.
  • Siga as etapas de recuperação retornadas quando uma solicitação falhar.
  • Separe evidências ausentes de evidências que não puderam ser carregadas.