Pular para o conteúdo principal
Siga primeiro o guia de instalação ao adicionar uma nova aplicação ao AppSignal.

​
Requisitos

Antes de compilar o pacote AppSignal, certifique-se de que as ferramentas de build/compilação estão instaladas no seu sistema. Verifique a página Sistemas operacionais suportados para quaisquer dependências de sistema que possam ser necessárias.

​
Instalação

A instalação do pacote AppSignal em sua aplicação Elixir requer algumas etapas manuais. Atualmente, o AppSignal oferece suporte a Phoenix, Plug e apps em Elixir puro. Se o AppSignal não cobrir seu caso de uso ou se você encontrar algum problema com a documentação, não hesite em entrar em contato conosco. Você também pode abrir um pull request em nosso repositório público de Elixir.

​
Instalando o pacote

📖 Nota: Se você está rodando uma aplicação umbrella, veja também nosso guia de instalação para umbrella.
Nota: Se você usa o framework Phoenix ou Plug, continue com os guias integrando o AppSignal ao Phoenix ou integrando o AppSignal ao Plug.
  1. Comece adicionando appsignal à sua lista de dependências em mix.exs.
# mix.exs
def deps do
  [
    {:appsignal, "~> 2.8"}
  ]
end
  1. Em seguida, execute mix deps.get.
  2. Em seguida, execute mix appsignal.install YOUR_PUSH_API_KEY ou siga o guia de configuração manual.
Após a instalação, inicie sua aplicação. Quando a aplicação OTP do AppSignal inicia, ela procura uma configuração válida (por exemplo, uma Push API key do AppSignal) e inicia o agente AppSignal. Se ela não encontrar uma configuração válida, um aviso será registrado no log. Veja a seção Configuração sobre como configurar totalmente o agente AppSignal.

​
Configuração

Antes de o pacote AppSignal funcionar, você precisa configurá-lo. Para conseguir enviar dados ao AppSignal, primeiro você precisa criar uma conta no AppSignal.com. Ou, se você já tiver uma conta, clique no botão “add app” em AppSignal.com/accounts. Durante o processo de instalação, você pode executar o comando mix appsignal.install com a Push API key hexadecimal ou configurar o AppSignal manualmente seguindo o guia abaixo. Para mais informações sobre como configurar o pacote AppSignal for Elixir, leia nossa documentação de configuração.

​
Configuração manual

Se você quiser configurar o AppSignal manualmente, será necessário colocar a Push API key do AppSignal recebida no processo de instalação no arquivo config/config.exs da sua aplicação. Usando a configuração do AppSignal, você também pode configurar o nome da aplicação, o ambiente e muito mais. 
# 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 AppSignal usando variáveis de ambiente do SO. 
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"
Para mais informações sobre como configurar o pacote AppSignal for Elixir, leia nossa página de opções de configuração.

​
Execute sua aplicação!

Depois de concluir este guia, sua aplicação está pronta para ser monitorada pelo AppSignal! Inicie sua aplicação e faça algumas requisições. Disparar um erro ou dois também testará o relatório de erros. Entre em contato conosco se tiver dúvidas sobre a instalação ou se encontrar quaisquer problemas durante a instalação.

​
Opcional: Adicionar instrumentação do Phoenix

Leia mais sobre como você pode integrar mais instrumentação na sua aplicação Phoenix em nosso guia de integração com o Phoenix.

​
Opcional: Adicionar instrumentação do Plug

Leia mais sobre como você pode integrar mais instrumentação na sua aplicação Plug em nosso guia de integração com o Plug.

​
Opcional: Adicionar instrumentação personalizada

Adicione instrumentação personalizada à sua aplicação para ter uma visão mais aprofundada do que está acontecendo nela. Leia mais sobre instrumentação personalizada em nossa documentação de instrumentação.
📖 Continue com nosso guia de instalação.

​
Desinstalação

Desinstale o AppSignal do seu app seguindo as etapas abaixo. Quando essas etapas forem concluídas, seu app não enviará mais dados para os servidores do AppSignal.
  1. No mix.exs do seu app, exclua a linha {:appsignal, "~> 2.0"}.
  2. Execute mix deps.get para atualizar seu mix.lock com o estado dos pacotes removidos.
  3. Remova quaisquer arquivos de configuração do AppSignal do seu app.
    • Local do arquivo de configuração: config/appsignal.exs
    • E suas referências em quaisquer outros arquivos em config/*.exs
  4. Remova quaisquer variáveis de ambiente do sistema dos seus hosts de desenvolvimento, staging, produção, etc.
    • Variáveis de ambiente prefixadas com APPSIGNAL_
    • Variável de ambiente APP_REVISION
  5. Faça commit, deploy e reinicie seu app.
    • Isso garantirá que os servidores do AppSignal não continuarão a receber dados do seu app.
  6. Opcional: Certifique-se de que nenhum processo appsignal-agent está rodando em segundo plano.
    • Verifique a saída de ps aux | grep appsignal-agent e finalize os processos que ainda estiverem rodando.
  7. Por fim, remova o app no AppSignal.com.
📖 Continue com nosso guia de desinstalação.