Registro de despliegue con el agente Ruby.

El agente Ruby de New Relic le permite enviar información sobre el despliegue de la aplicación mediante el uso de la API REST o una receta de Capistrano (versiones 2.x y 3.x) distribuida con el agente Ruby. Luego podrá ver el despliegue en la UIde New Relic. De forma predeterminada, toda la información de despliegue se registra en su entorno de producción. También puede personalizar la variable rails_env para otros entornos, como de prueba.

Asignar un nombre a la aplicación

Para asignar un nombre de aplicación:

1. Descargue la última versión del agente Ruby.
2. Establezca el app_name en su archivo newrelic.yml con un nombre significativo.

Esto asignará a la instancia en el entorno dado la etiqueta proporcionada por app_name al explorar sus datos en la interfaz de usuario de New Relic. El script de carga del despliegue usará esa etiqueta para asociar una aplicación con el despliegue.

Añade tu clave de usuario

Opcionalmente, puede grabar el despliegue a través de la API REST v2 de New Relic. Para hacer esto, proporcione su clave de usuario a la configuración del agente usando api_key. Cuando esta configuración está presente, el comando newrelic deployments utiliza automáticamente la API REST v2 desplegable extremo.

Grabar con la línea de comando

Si instaló el agente Ruby como una gema, puede registrar el despliegue directamente usando el ejecutable newrelic :

$
newrelic deployments

Dependiendo de su entorno, es posible que necesite ejecutar:

$
bundle exec newrelic deployment

Puede utilizar varios valores opcionales con newrelic. El description es texto corto.

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

Al utilizar la opción -c, puede canalizar el log de cambios al script. Si no hay tubería cuando usa la opción -c , seleccione control-D para indicar el final del archivo (EOF).

Grabar con Capistrano 3.x

El agente New Relic Ruby contiene una receta de Capistrano que puede registrar el despliegue de la aplicación. Después de asignar el nombre de su aplicación, edite sus archivos de Capistrano para comunicarse con el agente:

1. En la parte superior de su Capfile, agregue la siguiente línea:

   require 'new_relic/recipes'

   Copia

2. En su archivo deploy.rb , incluya:

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

   Copia

Grabar con Capistrano 2.x

Puedes grabar Capistrano 2.x despliegue con el agente New Relic:

1. Dile a Capistrano que cargue las recetas de New Relic:

   Si el agente se instaló con la gema New Relic

   Agregue esto en la parte superior de su archivo deploy.rb :

   require 'new_relic/recipes'

   Copia

   Si el agente se instaló como complemento Rails

   En su Capfile, agregue la siguiente línea encima de load deploy.rb (si aún no está allí):

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

   Copia

2. Agregue los siguientes enlaces a su archivo 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"

   Copia

La próxima vez que ejecute cap deploy, el agente notifica a New Relic sobre el despliegue y todos los gráficos de series temporales mostrarán el evento de despliegue.

Personaliza tu configuración de Capistrano

Si Capistrano está ejecutando la receta de notificación desplegable en una máquina de compilación remota, la máquina de compilación must tiene su clave de licencia. Puede copiar un archivo newrelic.yml válido a la máquina de compilación (posiblemente usando Capistrano Before Hook) o llamar set :newrelic_license_key, 'YOUR_LICENSE_KEY' en su configuración de Capistrano.

Puede personalizar parte de la información de despliegue utilizando variables de Capistrano. Si se definen, estos anularán los valores predeterminados. Estos se aplican tanto a Capistrano 2 como a 3.

Anular la configuración de Capistrano

En cualquier versión de Capistrano, puedes anular la configuración en tu deploy.rb:

set :newrelic_user, "username"

Para anular la configuración con Capistrano 2.x: Desde la línea de comando:

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

Este ejemplo será un símbolo para el contenido que aparecerá en el log de cambios del despliegue:

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

Desplegar a prueba

De forma predeterminada, la gema newrelic_rpm viene con tareas de Capistrano para registrar todo el despliegue en su entorno de producción. Si tiene una aplicación de preparación separada, puede cambiar la configuración de la variable rails_env para que el despliegue de preparación se registre en la aplicación de preparación en lugar de en la aplicación de producción.

Para identificar el despliegue en su entorno de prueba, use Capistrano o la línea de comando.

set :rails_env, "staging"

$
cap -s rails_env=staging deployment_task_name