.appsignal.toml local do projeto que assume o controle dentro de um projeto. Esta página cobre o comando project, onde cada arquivo vive e cada chave que você pode definir.
O comando project
appsignal-cli project init cria ou atualiza um .appsignal.toml local de projeto:
Shell
.appsignal.toml na raiz do repositório. Fora de um checkout git, ela usa o diretório atual.
Você pode definir a organização padrão do projeto ao criar o arquivo:
Shell
project init aceita estas flags:
| Flag | Descrição |
|---|---|
--org <slug> | Define a organização padrão para o projeto |
--endpoint <url> | Aponta o projeto para um servidor AppSignal não-produção |
--rest-endpoint <url> | Aponta o projeto para uma URL base da API REST ou pública não-produção |
--oauth-client-id <id> | Sobrescreve o ID do cliente OAuth para o projeto |
project init não copia suas credenciais OAuth globais para o arquivo do projeto. Após criá-lo, execute appsignal-cli auth login dentro do projeto para configurar credenciais específicas do projeto.Onde a configuração vive
A configuração global vive no diretório de configuração padrão do seu sistema operacional; seu caminho exato varia por SO. Executeappsignal-cli auth status para ver onde o seu está. Ele contém suas credenciais de toda a conta e organização padrão.
Um .appsignal.toml local do projeto pode viver em qualquer lugar de um projeto. Quando a CLI roda dentro desse projeto ou de um subdiretório, ela usa o .appsignal.toml mais próximo como a única configuração para esse projeto. Quando uma configuração local do projeto está ativa, a CLI lê e escreve apenas esse arquivo. Caso contrário, ela usa a configuração global.
O valor org é salvo automaticamente quando você executa appsignal-cli apps list ou appsignal-cli apps set-org --org <slug>, em qualquer configuração que estiver ativa. Execute project init primeiro se quiser que essas gravações permaneçam locais ao projeto.
Chaves de configuração
Ambos os arquivos usam as mesmas chaves:| Chave | Descrição |
|---|---|
org | Slug da organização padrão, usado quando um comando omite --org. |
Tabela [oauth] | Credenciais OAuth (access_token, refresh_token, expires_at). Definidas automaticamente por appsignal-cli auth login. |
Global config
.appsignal.toml local do projeto usa o mesmo formato.
Os tokens OAuth são renovados automaticamente antes das chamadas de API, então você não precisa fazer login novamente. O OAuth sempre usa o callback local embutido em http://127.0.0.1:9789/callback.
Telemetria
A CLI envia um evento mínimo de telemetria de melhor esforço para cada execução de comando, para ajudar o AppSignal a medir o uso e a confiabilidade da CLI. Cada evento inclui apenas o caminho do comando, se foi bem-sucedido ou falhou, quanto tempo levou, a versão da CLI e o formato de saída. Não contém nenhum dos seus dados do AppSignal. Para desativá-lo, definaAPPSIGNAL_CLI_TELEMETRY=0:
Shell
Endpoints personalizados
A maioria dos usuários nunca precisa dessas configurações. Elas fazem a CLI se comunicar com um servidor AppSignal não-produção em vez do padrão, o que é principalmente útil para os próprios engenheiros do AppSignal para testes. Você pode defini-las como flags emproject init ou auth login, ou como chaves em seu arquivo de configuração. As chaves são:
| Chave de configuração | Descrição |
|---|---|
endpoint | URL base do servidor AppSignal, sem /graphql. A CLI adiciona /graphql para chamadas de API e usa a URL base para OAuth. |
rest_endpoint | URL base da API REST ou pública, quando difere de endpoint. |
oauth_client_id | ID do cliente OAuth a usar durante o login. Quando não definido, a CLI usa o cliente de produção, ou registra um automaticamente para endpoints que anunciam um registration_endpoint. |
https://appsignal.example.com/graphql não é suportado. Use apenas a URL base.