Tipos de chave de projeto
Cada chave de projeto pertence a um projeto. O tipo define o que ela pode fazer. Você escolhe o tipo com--kind ao executar logbrew projects keys create.
Os tipos
sdk, server, cli e browser são chaves de ingestão. Escolha o
tipo que indica onde a chave roda. Use browser para código que roda em um
navegador. Nunca coloque uma chave de leitura em código de navegador, em um
aplicativo móvel ou em um bundle público.
O acesso da conta é outra coisa. logbrew login dá à CLI o acesso da sua
conta. Nunca use o acesso da conta como configuração do SDK. Uma chave de
leitura não consegue entrar na CLI nem no painel.
Leia de volta o seu evento de teste
1
Crie uma chave de leitura
Esta etapa precisa do acesso da conta. Execute A CLI grava a chave em um arquivo novo que só o dono pode ler. Ela nunca
imprime a chave nem o caminho do arquivo.
logbrew status --json e
confira se ele informa acesso da conta autenticado.--ingest-key-file é a opção de
arquivo para todos os tipos de chave. O arquivo de destino não pode
existir.Ponto de controle: o resultado tem status: "created" e
ingest_key.kind: "read". Anote o ingest_key.id. Você precisa dele para
revogar a chave.2
Envie um evento de teste
Envie um log de teste seguro pela sua aplicação, com a chave de ingestão do
projeto. Siga as etapas do seu runtime no início rápido
ou no guia de integração do SDK. Para testar
também os problemas, envie um erro de teste tratado.Ponto de controle: o SDK informa um status
2xx. Isso mostra que o
LogBrew aceitou a requisição. Siga para a próxima etapa.3
Leia o evento de volta
Carregue a chave de leitura em Cada leitura retorna dados só do projeto da chave, então você não precisa
de
LOGBREW_TOKEN só neste shell. Depois,
leia o projeto:--project. Adicione --service, --environment ou --release para
corresponder ao evento de teste.Ponto de controle: o log de teste aparece com o seu serviço, ambiente e
versão. Um erro de teste aparece como problema. Isso mostra que o LogBrew
armazenou os eventos e que você consegue lê-los.Ao terminar, execute unset LOGBREW_TOKEN. A CLI volta a usar o acesso da
sua conta.4
Revogue a chave de leitura
Revogue a chave quando não precisar mais dela. Esta etapa precisa do acesso
da conta, então remova Ponto de controle: o resultado tem
LOGBREW_TOKEN primeiro.status: "revoked". A chave para de
funcionar na próxima requisição.Dê acesso de leitura a um job de CI ou a um agente
Mantenha uma chave de leitura para um job de CI ou um agente de programação que lê um projeto. Guarde a chave no gerenciador de segredos do sistema de CI ou do ambiente do agente. Disponibilize a chave comoLOGBREW_TOKEN. Não coloque a
chave em um prompt, em um repositório nem na saída de comandos.
Depois, o job ou o agente pode executar leituras como logbrew issues --json,
logbrew issue "<issue_id>" --json e logbrew read trace "<trace_id>".
Comandos de projeto, de chave e de conta precisam do acesso da conta.
Clientes de API enviam a chave como bearer token para as leituras de
telemetria da API de telemetria.
Use uma chave para cada job ou agente. Assim, você revoga uma chave sem afetar
as outras.
Recupere uma leitura que falhou
Se a telemetria ainda não aparecer, use as
verificações da primeira telemetria.
Para substituir uma chave de ingestão, consulte Rotação da chave de ingestão.