Registrar a implantação com o agente Ruby

O agente New Relic Ruby permite enviar informações sobre a implantação do aplicativo utilizando a API REST ou uma receita Capistrano (versões 2.xe 3.x) distribuída com o agente Ruby. Você pode então visualizar a implantação na interface do New Relic. Por padrão, todas as informações de implantação são registradas no seu ambiente de produção. Você também pode customizar a variável rails_env para outros ambientes, como preparação.

Atribuir um nome de aplicativo

Para atribuir um nome de aplicativo:

1. Baixe a versão mais recente do agente Ruby.
2. Defina app_name em seu arquivo newrelic.yml com um nome significativo.

Isso atribuirá à instância no ambiente determinado o rótulo fornecido por app_name ao navegar pelos seus dados na interface do usuário do New Relic. O script de upload de implantação usará esse rótulo para associar um aplicativo à implantação.

Adicione sua chave de usuário

Opcionalmente, você pode registrar a implantação através da API REST v2 da New Relic. Para fazer isso, forneça sua chave de usuário para a configuração do agente usando api_key. Quando esta configuração está presente, o comando newrelic deployments utiliza automaticamente o endpoint de implantação REST API v2 .

Grave com a linha de comando

Se você instalou o agente Ruby como uma gem, você pode registrar a implantação diretamente usando o executável newrelic :

$
newrelic deployments

Dependendo do seu ambiente, pode ser necessário executar:

$
bundle exec newrelic deployment

Você pode usar vários valores opcionais com newrelic. O description é um texto curto.

deployments [OPTIONS] [description]
OPTIONS:
   -a, --appname=name           Set the application name.
   -i, --appid=ID               Set the application ID
                                If not provided, will connect to the New Relic collector to get it
                                Default is app_name setting in newrelic.yml
   -e, --environment=name       Override the (RAILS|RUBY)_ENV setting
   -u, --user=USER              Specify the user deploying.
   -r, --revision=REV           Specify the revision being deployed
   -c, --changes                Read in a change log from the standard input
   -h                           Print this help

Ao usar a opção -c , você pode canalizar o log de alterações para o script. Se não houver tubulação ao usar a opção -c , selecione control-D para indicar o fim do arquivo (EOF).

Grave com Capistrano 3.x

O agente New Relic Ruby contém uma receita Capistrano que pode registrar a implantação do aplicativo. Após atribuir o nome do seu aplicativo, edite seus arquivos Capistrano para se comunicar com o agente:

1. No topo do seu Capfile, adicione a seguinte linha:

   require 'new_relic/recipes'

   Copiar

2. No seu arquivo deploy.rb , inclua:

   after "deploy:updated", "newrelic:notice_deployment"

   Copiar

Grave com Capistrano 2.x

Você pode registrar a implantação do Capistrano 2.x com o agente New Relic:

1. Diga a Capistrano para carregar as receitas da New Relic:

   Se o agente foi instalado com a gem New Relic

   Adicione isto no topo do seu arquivo deploy.rb :

   require 'new_relic/recipes'

   Copiar

   Se o agente foi instalado como plug-in Rails

   No seu Capfile, adicione a seguinte linha acima de load deploy.rb (se ainda não estiver lá):

   Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }

   Copiar

2. Adicione os seguintes ganchos ao seu arquivo deploy.rb :

   # Notify New Relic of deployments.
   # This goes out even if the deploy fails, sadly.
   after "deploy",            "newrelic:notice_deployment"
   after "deploy:migrations", "newrelic:notice_deployment"
   after "deploy:cold",       "newrelic:notice_deployment"

   Copiar

Na próxima vez que você executar cap deploy, o agente notificará a New Relic sobre a implantação e todos os gráficos de série temporal mostrarão o evento de implantação.

Personalize sua configuração Capistrano

Se Capistrano estiver executando a receita de notificação de implantação em uma máquina de compilação remota, a máquina de compilação must terá seu chave de licença. Você pode copiar um arquivo newrelic.yml válido para a máquina de compilação (possivelmente usando um Capistrano Before Hook) ou chamar set :newrelic_license_key, 'YOUR_LICENSE_KEY' na configuração do Capistrano.

É possível customizar algumas informações de implantação usando variáveis Capistrano. Se definidos, estes substituirão os padrões. Isso se aplica ao Capistrano 2 e 3.

Substituir configurações do Capistrano

Em qualquer versão do Capistrano, você pode substituir as configurações em seu deploy.rb:

set :newrelic_user, "username"

Para substituir as configurações com Capistrano 2.x: Na linha de comando:

$
cap production deploy -Snewrelic_desc="Deploying beta Krakatau release"

Este exemplo prompt o conteúdo que aparecerá no log de alterações da implantação:

set(:newrelic_changelog) do
  Capistrano::CLI.ui.ask "Enter a summary of changes: "
end

Implantar a preparação

Por padrão, a gem newrelic_rpm vem com tarefas do Capistrano para registrar toda implantação em seu ambiente de produção. Se você tiver um aplicativo de preparação separado, poderá alterar a configuração da variável rails_env para que a preparação implantação seja registrada no aplicativo de preparação em vez de no aplicativo de produção.

Para identificar a implantação em seu ambiente de preparação, utilize o Capistrano ou a linha de comando.

set :rails_env, "staging"

$
cap -s rails_env=staging deployment_task_name