Configuração mínima necessária
Para que as aplicações reportem dados ao AppSignal a configuração a seguir é necessária. Todas as outras configurações são opcionais.- Nome da aplicação - opção name
- Ambiente da aplicação - environment (detectado automaticamente ou definido via variável de ambiente)
- Push API key da aplicação - opção push_api_key
- AppSignal precisa estar ativo - opção active
Métodos de configuração
Existem vários métodos de configuração diferentes disponíveis na nossa gem Ruby. Para ver em qual ordem eles são carregados e qual método de configuração sobrescreve valores de outras fontes, veja nossa página de ordem de carregamento da configuração.Arquivo de configuração Ruby
A gem AppSignal para Ruby pode ser configurada usando um arquivo de configuração Ruby. Quando selecionado, o instalador cria automaticamente um arquivoconfig/appsignal.rb. Este arquivo inclui configurações padrão que podem ser personalizadas para atender às necessidades específicas da sua aplicação.
Este arquivo de configuração é lido quando Appsignal.start é chamado, o que é chamado automaticamente para a maioria das nossas integrações. Leia as instruções de integração do AppSignal se Appsignal.start não for chamado automaticamente.
O arquivo de configuração configura nossa gem Ruby usando o helper Appsignal.configure. Leia a seção o helper Appsignal.configure para mais detalhes sobre como usá-lo.
O arquivo de configuração YAML não será lido quando este arquivo estiver presente.
Helper Appsignal.configure
O helper Appsignal.configure pode ser usado para configurar o AppSignal usando código Ruby. O arquivo de configuração Ruby usa este helper e ele também pode ser usado diretamente na sua aplicação.
Se seu app usa Appsignal.configure fora do arquivo config/appsignal.rb, como em um initializer do Rails, leia esta seção sobre as diferenças no comportamento que isso tem.
Defina as opções de configuração dentro do bloco Appsignal.configure chamando os métodos de escrita no objeto config. As opções de configuração podem ser definidas usando a “Config file key” listada para as opções de configuração. Por exemplo, a opção send_params pode ser definida usando: config.send_params = false.
Appsignal.configure funciona e que outros helpers ele possui.
Opções de configuração String
Opções de configuração do tipo String podem ser definidas usando tanto Strings quanto Symbols. Quando definidas, converteremos Symbols em Strings.Opções de configuração Array
Opções de configuração do tipo Array podem ser modificadas como um array normal:- Use uma atribuição para sobrescrever os padrões e valores previamente lidos das variáveis de ambiente.
- Por exemplo:
config.array_option = ["value 1", "value 2"] - Valor da opção:
["value 1", "value 2"]
- Por exemplo:
- Use o operador de atribuição com adição
+=para mesclar um novo array de valores com os padrões e valores previamente lidos das variáveis de ambiente.- Por exemplo:
config.array_option += ["value 1", "value 2"] - Valor da opção:
["DUMMY default value", "value 1", "value 2"]
- Por exemplo:
- Use o operador append
<<para acrescentar um único valor à lista dos padrões e valores previamente lidos das variáveis de ambiente.- Por exemplo:
config.array_option << "value 1" - Valor da opção:
["DUMMY default value", "value 1"]
- Por exemplo:
Detecção automática de ambiente
A gem AppSignal para Ruby detecta o ambiente da aplicação automaticamente. Integramos com gems como Rails, Sinatra, Rack e outras para detectar em qual ambiente a aplicação foi iniciada. Por essa razão, não deve ser necessário configurar o ambiente manualmente. Se precisar configurar o ambiente da aplicação manualmente, passe o nome do ambiente como o primeiro argumento para o helperAppsignal.configure. Esse argumento sobrescreverá o valor da variável de ambiente APPSIGNAL_APP_ENV e a detecção automática de ambiente.
Helper activate_if_environment
O helper Appsignal.configure tem um helper para configurar quais ambientes devem estar ativos e reportar dados para AppSignal.com.
Chame activate_if_environment com uma lista de ambientes (Strings e/ou Symbols).
O AppSignal detecta o ambiente quando o helper Appsignal.configure é chamado sem um argumento de ambiente. Em seguida, ele verifica se o ambiente corresponde a algum dos valores fornecidos e, em caso afirmativo, define a opção de configuração active como true.
activate_if_environment é um helper de conveniência para evitar que as aplicações tenham que adicionar suas próprias verificações sobre quando o AppSignal deve estar ativo, como:
Helper env?
O helper Appsignal.configure tem um helper para verificar qual ambiente o AppSignal detectou. Use este helper para verificar qual ambiente está ativo e definir as opções de configuração que devem se aplicar apenas a este ambiente.
Chame o helper env? com um nome de ambiente (String ou Symbol), e ele retornará true se o nome do ambiente corresponder ao ambiente atualmente ativo.
Usando o helper Appsignal.configure na sua aplicação
Recomendamos configurar a gem AppSignal para Ruby usando o arquivo de configuração Ruby em config/appsignal.rb. Se um initializer do Rails ou configuração inline for preferido, leia esta seção para entender as mudanças de comportamento que isso traz.
Se o helper Appsignal.configure for chamado antes que o arquivo de configuração Ruby config/appsignal.rb seja lido quando Appsignal.start é chamado, ele não lerá o arquivo de configuração Ruby.
Em apps Rails, certifique-se de configurar a gem AppSignal para iniciar após o Rails ser inicializado, caso contrário, a configuração definida com Appsignal.configure é ignorada quando chamada em um initializer do Rails, como config/initializers/appsignal.rb.
Exemplo de initializer do Rails:
Variáveis de ambiente do sistema
O AppSignal também pode ser configurado usando variáveis de ambiente do sistema no host em que a aplicação que o AppSignal está monitorando roda. Isso é comum em plataformas como o Heroku. Certifique-se de que essas variáveis de ambiente estão configuradas de forma compatível com seu sistema operacional e que os valores sejam carregados antes que seu app com AppSignal seja iniciado.Arquivo de configuração YAML
A gem AppSignal para Ruby pode ser configurada com um arquivo de configuração YAML. Durante a instalação, a gem Ruby criará um arquivoconfig/appsignal.yml, se selecionado. Nesse arquivo, alguma configuração padrão é fornecida e pode ser modificada para atender às necessidades da sua aplicação. Este arquivo config/appsignal.yml suporta tags ERB para que variáveis de ambiente do sistema também possam ser carregadas neste arquivo.
Os exemplos de configuração config/appsignal.yml mostrados para as opções de configuração usarão a âncora YAML default. O instalador do AppSignal criará um arquivo config/appsignal.yml com essa âncora por padrão. Se não estiver presente, certifique-se de adicionar a opção de configuração ao ambiente correto.
Múltiplos ambientes do app
Vários ambientes do app podem ser configurados neste arquivo usando chaves no nível raiz.defaults e fazê-la aplicar-se automaticamente a todos os ambientes. Cada ambiente precisa ser configurado no arquivo YAML com uma chave de nível raiz e estender desta âncora defaults.
Exemplo de arquivo de configuração YAML
Aqui está um exemplo de um arquivo de configuraçãoappsignal.yml. Recomendamos
que você adicione apenas a configuração necessária ao seu arquivo de configuração.
Para a lista completa de opções, veja a página de opções de
configuração.