Pular para o conteúdo principal
Configuração. Importante, porque sem ela o pacote AppSignal Elixir não saberá qual aplicação está instrumentando ou em qual ambiente. Neste tópico, explicaremos como configurar o AppSignal, o que pode ser configurado no pacote Elixir e qual é a configuração mínima necessária.

Configuração mínima necessária

A configuração mínima necessária pelo AppSignal for Elixir é a seguinte. Se ela não estiver presente, o AppSignal não enviará nenhum dado para o AppSignal.com.
  • Uma Push API Key válida
  • O nome do OTP app da aplicação
  • Um nome de aplicação
  • Um ambiente de aplicação (dev / prod / test)
  • O ambiente da aplicação definido como active: true
# Exemplo de arquivo de configuração mínimo
# config/config.exs
config :appsignal, :config,
  otp_app: :appsignal_phoenix_example,
  name: "AppsignalPhoenixExample",
  push_api_key: "your-push-api-key",
  env: Mix.env,
  active: true
Como alternativa, você pode configurar o agente usando variáveis de ambiente do sistema. O AppSignal será automaticamente ativado se a variável de ambiente APPSIGNAL_PUSH_API_KEY estiver definida.
export APPSIGNAL_OTP_APP="appsignal_phoenix_example"
export APPSIGNAL_PUSH_API_KEY="your-push-api-key"
export APPSIGNAL_APP_NAME="AppsignalPhoenixExample"
export APPSIGNAL_APP_ENV="prod"

Opções de configuração

Leia sobre todas as opções de configuração na página de opções.

Ambientes da aplicação

Uma aplicação pode ter múltiplos ambientes, como “development”/“dev”, “test”, “staging” e “production”. Para separar os erros e problemas de desempenho que ocorrem no ambiente “development” daqueles em “production”, é possível definir o ambiente em que a aplicação está rodando com a opção de configuração env. Um arquivo de configuração de ambiente típico conteria o seguinte.
# config/prod.exs
config :appsignal, :config,
  active: true,
  env: :prod
O exemplo de arquivo de configuração acima também é o que é gerado pelo instalador do AppSignal por ambiente. Se você ativar o AppSignal por ambiente, usando active: true no arquivo config/{env}.exs, a opção active não é necessária no arquivo config/config.exs principal.

Desabilitar o AppSignal para testes

Se você colocar toda a sua configuração do AppSignal no config/config.exs em vez de config/prod.exs (por exemplo, para ter o AppSignal habilitado durante o desenvolvimento), certifique-se de colocar active: false na sua configuração de testes, a menos que você queira enviar todos os resultados dos seus testes.
# config/test.exs
config :appsignal, :config,
  active: false

Exemplo de configuração

# config/config.exs
config :appsignal, :config,
  otp_app: :appsignal_phoenix_example,
  name: "AppsignalPhoenixExample",
  push_api_key: "your-push-api-key",
  env: Mix.env,
# config/test.exs
config :appsignal, :config,
  active: false