AppSignal para Ruby: Ferramenta de diagnóstico

A gem AppSignal para Ruby inclui uma ferramenta de autodiagnóstico que pode ser usada para depurar a instalação e a configuração da sua integração com o AppSignal. É uma das primeiras ferramentas que nossa equipe de suporte pede para você executar ao depurar um problema.

O relatório de diagnóstico

Você pode usar esta ferramenta de diagnóstico para testar e validar sua instalação do AppSignal. Ela gera informações úteis para depurar problemas e verifica se o agente do AppSignal consegue rodar na arquitetura da máquina e se comunicar com os servidores do AppSignal. Esta ferramenta de diagnóstico coleta e exibe o seguinte:

Informações sobre a gem do AppSignal.
Informações sobre o sistema host e o Ruby.
Se a extensão e o agente do AppSignal podem rodar no sistema host.
Todas as opções de configuração definidas (incluindo valores padrão).
Se a configuração é válida e está ativa.
Se a Push API key está presente e é válida (requer conexão com a internet).
De onde vêm os valores das opções de configuração.
Se os caminhos de sistema necessários existem, têm permissão de escrita e qual usuário e grupo são os proprietários.
Pequenos trechos do final dos arquivos de log disponíveis.

Você pode ler mais sobre como usar o comando diagnose na nossa documentação de Depuração.

Enviando o relatório

Na versão 2.2.0 ou superior da gem, você será solicitado a enviar o relatório para o AppSignal. Se aceito, o relatório será enviado para nossos servidores e você receberá um token de suporte. Quando você nos enviar este token de suporte nós revisaremos o relatório e ajudaremos você a depurar o problema. Já notamos que copiar e colar a saída do relatório geralmente perde a formatação e dificulta a leitura, por isso ele é enviado para nossos servidores no formato JSON. Na versão 2.8.0 da gem foi adicionada a opção de visualizar o relatório você mesmo em AppSignal.com. Um link para o relatório é exibido na saída do diagnose. Esta visualização web também mostrará quaisquer problemas de validação e avisos que nosso sistema detectou.

Uso

Na linha de comando dentro do seu projeto, execute:

appsignal diagnose

Se você estiver enfrentando um problema em produção e precisar enviar o relatório para o AppSignal para obter suporte, pode executar o seguinte comando para gerar e enviar o relatório para nossos servidores:

bundle exec appsignal diagnose --environment=production --send-report

Opções

Opção	Descrição
`--environment=<environment>`	Define o ambiente a ser usado no comando, por exemplo, `production` ou `staging`.
`--[no-]send-report`	Envia automaticamente ou não envia o relatório.
`--[no-]color`	Alterna a colorização da saída.

Opção de ambiente

Para selecionar um ambiente específico com a CLI, execute o comando abaixo:

appsignal diagnose --environment=production

A opção de ambiente é útil quando não há um ambiente padrão (apps não-Rails e apps configurados com um arquivo de configuração) ou quando o ambiente padrão não é o que você deseja diagnosticar. A ferramenta diagnose vai te avisar quando nenhum ambiente estiver selecionado.

Opção de envio do relatório

As opções para enviar o relatório imediatamente, ou não, foram adicionadas na versão 2.8.0 da gem do AppSignal. Selecionar se quer ou não enviar o relatório com essas opções não exibirá mais essa pergunta, facilitando o uso em ambientes não interativos. Para executar o diagnose e enviar os dados do relatório para o AppSignal, execute o comando abaixo:

appsignal diagnose --send-report

Para executar o diagnose sem enviar os dados do relatório para o AppSignal, execute o comando abaixo:

appsignal diagnose --no-send-report

Formato de saída da configuração

Formato dos valores das opções de configuração

As opções de configuração são exibidas no CLI como seus valores inspecionados. Isso significa que as exibimos como o Ruby faria em um console.

Valores String são exibidos entre aspas duplas, por exemplo, "My app name".
Valores Boolean são exibidos como seus valores brutos: true e false.
Valores Array são exibidos como uma coleção de valores entre colchetes, por exemplo, ["HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET"].
- Arrays vazios são exibidos como dois colchetes: [].
Valores Nil são exibidos como nil.

Fontes de configuração

A seção de configuração também exibe a origem dos valores das opções de configuração, o que pode ajudar a identificar fontes que sobrescrevem valores definidos em outras fontes de configuração. Você pode ler mais sobre fontes de configuração, sua ordem de carregamento e prioridade na documentação sobre ordem de carregamento da configuração. As opções de configuração são exibidas com base na fonte de seus valores e na quantidade de fontes que as definem, como no exemplo abaixo:

Shell

Configuration
  # Option with a value loaded only from the default source
  send_params: true

  # Option with one source
  # A different source than the default source
  name: "My app name" (Loaded from file)

  # Option with multiple sources
  # Listed in order of priority (highest priority last)
  active: true
    Sources:
      default: false
      file:    false
      env:     true