Descripción general de la configuración

Puede configurar el agente New Relic Ruby con configuraciones en un archivo de configuración, variables de entorno o mediante programación con configuración del lado del servidor. Este documento resume las opciones de configuración disponibles para el agente Ruby.

Si el valor predeterminado para una opción de configuración es (Dynamic), esto significa que el agente Ruby calcula el valor predeterminado en tiempo de ejecución. El valor de la configuración es el valor predeterminado de otra configuración, según corresponda.

Métodos de configuración y precedencia.

El método principal (predeterminado) para configurar el agente Ruby es a través del archivo de configuración (newrelic.yml) en el subdirectorio config . Para establecer valores de configuración utilizando variables de entorno:

1. Agregue el prefijo NEW_RELIC_ al nombre de la configuración.
2. Reemplace los puntos . con guiones bajos _.

También puede configurar algunos valores en la UI mediante la configuración del lado del servidor.

El agente Ruby sigue este orden de precedencia para la configuración:

1. Variables de entorno
2. Configuración del lado del servidor
3. Archivo de configuración (newrelic.yml)
4. Ajustes de configuración predeterminados

En otras palabras, las variables de entorno anulan todas las demás configuraciones e información de configuración, la configuración del lado del servidor anula el archivo de configuración y las configuraciones predeterminadas, y así sucesivamente.

Ver y editar opciones de archivos de configuración

El newrelic.yml del agente Ruby es un archivo de configuración YAML estándar. Generalmente incluye una sección Defaults en la parte superior, además de secciones debajo para cada entorno de aplicación (Development, Test, Staging y Production).

El agente Ruby determina qué sección del archivo de configuración newrelic.yml leer observando ciertas variables de entorno para derivar el entorno de la aplicación. Esto puede ser útil cuando desea emplear info para la configuración log_level en su entorno de producción y desea configuraciones log_level más detalladas (como debug) en su entorno de desarrollo.

A continuación se muestra un archivo de configuración newrelic.yml de ejemplo:

common: &default_settings
  license_key: 'YOUR_LICENSE_KEY'
  app_name: 'My Application Name'
production:
  <<: *default_settings
  log_level: info
development:
  <<: *default_settings
  log_level: debug

El agente Ruby busca las siguientes variables de entorno, en este orden, para encontrar el entorno de la aplicación:

1. NEW_RELIC_ENV
2. RUBY_ENV
3. RAILS_ENV
4. APP_ENV
5. RACK_ENV

Si el agente Ruby no detecta valores para ninguna de esas variables de entorno, establecerá el entorno de la aplicación en development de manera predeterminada y leerá desde la sección development del archivo de configuración newrelic.yml .

Al ejecutar el agente Ruby en una aplicación Rails, el agente primero busca la variable de entorno NEW_RELIC_ENV para encontrar el entorno de la aplicación y qué sección de newrelic.yml emplear. Si NEW_RELIC_ENV no está presente, el agente emplea el entorno Rails (RAILS_ENV).

Cuando edite el archivo de configuración, asegúrese de:

• Sangría sólo con dos espacios.
• Sangrar sólo cuando sea relevante, en secciones como error_collector.

Si no aplica la sangría correctamente, el agente puede generar un error Unable to parse configuration file al iniciar.

Para ver la lista más actualizada de opciones de configuración del agente Ruby disponibles, utilice el comando rake newrelic:config:docs . Este documento describe las opciones más comunes.

Actualizar el archivo de configuración

Esta documentación se aplica a la última versión del agente Ruby. Para obtener detalles sobre versiones anteriores, consulte los comentarios en el propio newrelic.yml .

Para actualizar el archivo newrelic.yml después de una nueva versión, utilice la plantilla en el directorio base de la gema del agente. Cuando actualice a nuevas versiones de gemas, examine o diferencie config/newrelic.yml y newrelic.yml en el directorio de instalación para aprovechar las nuevas opciones de configuración.

Referencia de configuración

Todos los ajustes de configuración están documentados en las siguientes subpáginas. Cada ajuste muestra su tipo, valor predeterminado y la variable de entorno equivalente.