Projeto, serviço e ambiente
Configure um projeto
Instale a CLI. Executelogbrew status --json para ver o acesso da sua conta. Se o acesso não for válido, uma pessoa precisa executar logbrew login. Uma chave de ingestão do projeto não serve para entrar na conta.
1
Crie ou selecione um projeto
Liste seus projetos primeiro. Crie um projeto somente se ele ainda não existir.A CLI grava a chave de ingestão em um novo arquivo que só o dono pode acessar. Ela nunca exibe a chave nem o caminho do arquivo. Se o resultado não estiver claro, execute exatamente o mesmo comando de novo. Não mude o nome do projeto nem o arquivo da chave. A CLI reaproveita a identidade da requisição pendente. O Início rápido mostra como ler o ID do projeto no resultado.Para um projeto existente, registre o estado da configuração:Para criar outra chave de ingestão em um projeto existente, use
logbrew projects keys create. O guia de rotação da chave de ingestão mostra o comando.logbrew setup --create-project só mostra a ajuda. Ele não cria um projeto.2
Defina os nomes de serviço no SDK
Use nomes que vêm do seu repositório e da sua implantação, como
api, worker, web, ios ou checkout-api. Um nome de serviço é um rótulo, não um seletor de projeto. A chave de ingestão seleciona o projeto. Renomear um serviço não move os eventos armazenados. Se você não encontrar um evento, confira o projeto e a chave de ingestão que a aplicação usa antes de criar outro projeto.3
Use ambientes padrão
Use
production, staging, preview e local. Se a sua implantação usar outros nomes, use esses nomes de forma consistente. Um nome de ambiente não pode conter espaços, / nem barra invertida.4
Envie um evento de teste e leia esse evento
Configure o kit de desenvolvimento de software (SDK) com a chave de ingestão do projeto, como descreve o guia de integração do SDK. Criar um projeto não instala um SDK na sua aplicação. Mantenha a chave fora do repositório de código. Defina o serviço, o ambiente e a versão na aplicação. Envie um evento seguro e depois leia esse evento:Cada sinal tem a própria lista. Uma lista de logs vazia não significa que o projeto não tem problemas nem traces.No painel, selecione o mesmo projeto e um período que inclua o evento de teste. Confira se os filtros de serviço, ambiente e versão correspondem ao evento.
Diagnostique a configuração do projeto
Leia o estado da configuração com o doctor do projeto. Não deduza o estado da configuração a partir de arquivos locais ou de uma consulta de logs vazia.status, checks e next. O código de saída 0 não mostra que todas as verificações passaram. Leia cada item em checks. Veja Ler o relatório do doctor de um projeto.
Resposta direta da API
Clientes de API chamamGET /api/projects/{project_id}/doctor com a autenticação da conta. O endpoint não tem parâmetros de consulta nem corpo de requisição. Nunca use uma chave de ingestão do projeto nessa leitura.
Uma resposta 200 tem estes campos: project_id, state, setup_status, setup_acknowledged, has_active_ingest_key, first_telemetry_seen_at, last_seen_at, last_signal, next e next_action. Os horários estão em RFC3339 ou são null. last_signal é um resumo seguro para exibição, não um sinal bruto.
O doctor verifica primeiro a chave de ingestão. Um projeto sem chave de ingestão ativa fica em
needs_ingest_key, qualquer que seja o status da configuração.
setup_status é created, setup_started, sdk_seen, first_telemetry_seen ou active. setup_acknowledged é true apenas para os três últimos valores. created resulta em needs_setup. setup_started e sdk_seen resultam em needs_telemetry. first_telemetry_seen e active resultam em ready.
Se a leitura continuar falhando, use Relatar um problema. Não inclua credenciais, cabeçalhos, corpos de sinais, dados de clientes, caminhos locais nem código-fonte.
Arquive ou exclua um projeto
Arquive um projeto para tirá-lo da lista de projetos ativos:--yes. Depois do arquivamento, as chaves de ingestão do projeto deixam de aceitar nova telemetria. A rota da API é DELETE /api/projects/{project_id}. Ela retorna 204 sem corpo. Liste os projetos arquivados com GET /api/projects/archived. Restaure um projeto com POST /api/projects/{project_id}/restore, que também retorna 204.
Exclua um projeto permanentemente só quando tiver certeza:
--confirm. Uma requisição aceita deixa o projeto inativo na hora e agenda a exclusão permanente. Depois disso, não é possível restaurar o projeto.