A integração com Capistrano garante que um marcador de deploy do AppSignal seja criado em
cada deploy. Leia mais sobre
marcadores de deploy. Alguma configuração manual
pode ser necessária.
Instalação
Certifique-se de carregar o arquivo appsignal/capistrano no Capfile do Capistrano.
Isso deve ser feito automaticamente quando você executa o comando appsignal install
durante a instalação.
# Capfile
require 'capistrano'
# Other Capistrano requires.
require 'appsignal/capistrano'
Configuração
appsignal_config
# deploy.rb
set :appsignal_config, name: 'My app'
appsignal_config permite que você sobrescreva qualquer configuração carregada do arquivo de configuração.
appsignal_env (desde a versão 1.3 da gem)
# deploy.rb
set :stage, :alpha
set :appsignal_env, :staging
appsignal_env permite que você carregue um ambiente AppSignal diferente quando o nome
de um stage não corresponder ao ambiente AppSignal nomeado no arquivo de configuração
ou variável de ambiente do AppSignal.
appsignal_revision (desde a versão 0.8.8 da gem)
Esse método de reportar marcadores de deploy está obsoleto e pode ser removido a qualquer momento no futuro.
Reportar marcadores de deploy usando esse método só é útil para aplicações pequenas que usam uma única instância da aplicação. Ele cria um novo marcador de deploy em um momento específico, independentemente da versão que a aplicação está realmente executando. Isso também significa que é mais propenso a erros, agrupando dados que não deveriam pertencer ao deploy. Detectamos a implantação automaticamente lendo o arquivo REVISION que o Capistrano adiciona ao diretório de release desde a versão 4.5.18 da gem Ruby.
No Capistrano 2, o AppSignal consegue buscar a revisão da configuração do Capistrano.
No Capistrano 3, no entanto, isso não está mais disponível, e definir a
revisão é recomendado.
# deploy.rb
set :appsignal_revision, "my_revision"
A revisão pode ser definida manualmente ou buscada localmente no repositório git.
# Sets the current branch's git commit SHA as the revision
set :appsignal_revision, `git rev-parse --short HEAD`.strip
Se você estiver usando a configuração de branch do Capistrano, também pode configurar
o git para buscar o SHA do commit da branch selecionada.
set :branch, "main"
# Sets the selected branch's git commit SHA as the revision
set :appsignal_revision, `git rev-parse --short #{fetch(:branch)}`.strip
appsignal_user (desde a versão 2.4.0 da gem)
Usado em combinação com appsignal_revision (se necessário), é possível personalizar um usuário de deploy para deploys do Capistrano.
Por padrão, isso usa o nome de usuário local do sistema, lido da variável de ambiente USER ou USERNAME, então não é necessário configurá-lo se o sistema tiver essas variáveis disponíveis.
Se você quiser personalizar o usuário de deploy, defina a opção de configuração :appsignal_user na sua configuração do Capistrano.
# deploy.rb
set :appsignal_user, "Jane" # Custom deploy user name
Aplicações de exemplo
Temos duas aplicações de exemplo em nosso repositório de exemplos no GitHub. Os
exemplos mostram como configurar o AppSignal em pequenas aplicações Capistrano enquanto
carregam valores de configuração do ambiente usando gems como dotenv e
Figaro.