Configuración del agente Node.js

El archivo de configuración (newrelic.js) contiene todas las configuraciones del agente Node.js. Cuando instala el agente de Node.js, debe copiar newrelic.js en el directorio raíz de su aplicación. La mayoría de las configuraciones están vacías de forma predeterminada; heredan sus valores de config/default.js.

Si su aplicación se ejecuta en CommonJS, simplemente cambie el tipo de archivo de configuración a (newrelic.cjs). Este tipo de archivo es compatible a partir de la versión 7.5.0 del agente Node.js.

Todos los ajustes de configuración en newrelic.js tienen variables de entorno equivalentes. Son útiles, por ejemplo, si su agente se ejecuta en un entorno PaaS como Heroku o Microsoft Azure. Las variables de entorno del agente Node.js siempre comienzan con NEW_RELIC_.

Estas variables de entorno se documentan a continuación en opciones de configuración individuales como Environ variable. También hay dos configuraciones que rara vez se utilizan y que solo se pueden configurar mediante variables de entorno. Si no está seguro de cómo especificar tipos más complejos como variables de entorno, utilice la guía de referencia.

Si está utilizando New Relic CodeStream para monitor el rendimiento de su IDE, es posible que también desee asociar el repositorio con sus servicios y asociar SHA de compilación o etiqueta de lanzamiento con errores.

Los propietarios y administradores pueden ver y configurar algunas configuraciones directamente en New Relic. Cuando estén disponibles, las etiquetas de la UI para la configuración del lado del servidor se enumeran en este documento en opciones de configuración individuales como Server-side label.

El nombre que utiliza New Relic para identificar su aplicación. Por ejemplo, app_name: ['MyNodeApp']. Para usar varios nombres para su aplicación, especifique una lista de nombres delimitada por comas.

Los datos de todas las aplicaciones con el mismo nombre se fusionarán en la UI de New Relic, así que configúrelo con cuidado. Recomendamos highly recommend que reemplace el nombre predeterminado con un nombre descriptivo para evitar confusión y agregación involuntaria de datos.

Esta configuración es obligatoria. Tu New Relic clave de licencia. Por ejemplo, license_key: '40HexadecimalCharacters'.

Configúrelo en false para evitar que el agente se inicie. Esto es útil cuando la depuración de su código requiere deshabilitar temporalmente el agente. Impide que el agente arranque su instrumentación o configure todas sus piezas, lo que impide que el agente inicie y se conecte a los servidores de New Relic.

Si true, habilita la captura de todos los encabezados HTTP, excepto aquellos filtrados por las reglas exclude . Si es false, los encabezados recopilados se limitan a los definidos en el atributo del agente de Node.js.

Si se alcanza el umbral de compresión de datos en la carga útil, el agente comprime los datos utilizando la compresión gzip de forma predeterminada. La opción de configuración compressed_content_encoding se puede establecer en deflate para usar compresión desinflada.

Configure su Apdex T a través de la UIde New Relic.

Certificados adicionales en los que confiar para conexiones SSL, especificados como una matriz de cadenas en formato PEM. Esto afecta tanto a las conexiones a un proxy HTTPS como a las conexiones a New Relic.

certificates: [ fs.readFileSync('myca.crt', {encoding: 'utf8'}) ]

Cuando se establece en true, habilita la alta seguridad v2. También debe habilitar la configuración ssl y habilitar la alta seguridad en la UI.

nombre de host para que el coleccionista New Relic se conecte a Internet; por ejemplo, host: 'collector.newrelic.com'.

Agrega etiqueta. Especifique su etiqueta como objetos o una cadena delimitada por punto y coma de pares separados por dos puntos (por ejemplo, Server:One;Data Center:Primary).

Número de puerto para conectarse al recolector New Relic; por ejemplo, port: 443.

Una URL que especifica el servidor proxy para conectarse a Internet. Por ejemplo, proxy: 'http://user:pass@10.0.0.1:8000/'. Consideraciones importantes:

• La configuración del archivo de configuración proxy anula las otras configuraciones del proxy del archivo de configuración (proxy_host, proxy_port, proxy_user, proxy_pass) si se utilizan. De manera similar, la variable de entorno NEW_RELIC_PROXY_URL anula la configuración del proxy de otras variables de entorno (NEW_RELIC_PROXY_HOST, NEW_RELIC_PROXY_PORT, NEW_RELIC_PROXY_USER y NEW_RELIC_PROXY_PASS) si se usa.
• Si está utilizando Infinite Tracing: consulte cómo configurar un proxy para Infinite Tracing.

Nombre de host o dirección IP del servidor proxy para conectarse a Internet.

Contraseña para autenticarse en el servidor proxy. El agente solo admite autenticación HTTP básica.

Número de puerto del servidor proxy para conectarse a Internet.

Nombre de usuario para autenticarse en el servidor proxy. El agente solo admite autenticación HTTP básica.

Habilita o deshabilita el registro específico del agente.

Define el nivel de detalle registrado en el registro del agente. Desde el menor detalle hasta el mayor detalle, los valores posibles son fatal, error, warn, info, debug o trace.

Ruta completa al log del agente New Relic, incluido el nombre del archivo. El valor predeterminado es filepath: require('path').join(process.cwd(), 'newrelic_agent.log'). El agente cerrará el proceso si no puede crear este archivo. El agente crea un archivo de registro con los mismos permisos que el proceso del agente principal de Node.js.

• Para escribir todos los registros en

  stdout

  , configúrelo en stdout.

• Para escribir todos los registros en

  stderr

  , configúrelo en stderr.

Cuando se establece en true, habilita el monitoreo de IA. Permite al agente capturar datos de eventos LLM.

Cuando se establece en false, deshabilita la instrumentación para datos LLM transmitidos. Establecido en true, captura datos transmitidos para el evento LLM.

Si se establece en false, el agente omite el contenido de entrada y salida (como cadenas de texto de símbolo y respuestas) capturado en el evento LLM. Esta es una configuración de seguridad opcional si no desea registrar datos confidenciales enviados y recibidos de sus LLM.

Cuando está habilitado, el agente registra la carga que envía al recolector. Estos datos se incluyen en el archivo de registro principal incluso cuando el nivel de registro está establecido en el nivel más bajo.

El agente envía varios tipos diferentes de datos al recolector en cargas separadas. Por defecto, todos ellos están incluidos en el archivo de registro. Esta opción permite limitar el registro solo a tipos específicos de datos.

Los valores válidos incluyen:

• agent_settings
• analytic_event_data
• connect
• custom_event_data
• error_data
• error_event_data
• metric_data
• preconnect
• shutdown
• span_event_data
• sql_trace_data
• transaction_sample_data

Esta opción habilita newrelic.addCustomAttribute y newrelic.addCustomAttributes.

Esta opción habilita recordCustomEvent.

Esta opción habilita newrelic.noticeError.

Si true, habilita la captura del atributo para todos los destinos.

Prefijo de atributo a excluir de todos los destinos. Permite * como comodín al final.

Prefijo de atributo a incluir desde todos los destinos. Permite * como comodín al final.

Cuando true, se pueden agregar patrones a la lista attributes.include .

Cuando está habilitado, el agente recopila la traza de error de su aplicación.

Lista delimitada por comas de códigos de estado HTTP que el recolector de errores debe ignorar.

Lista delimitada por comas de tipos/clases de errores de JavaScript que el selector de errores debe ignorar.

La siguiente configuración

error_collector: {
    /* ... */
    ignore_classes: ["ReferenceError"]
}

Ignoraría todos los errores de referencia.

Un objeto JavaScript que describe una lista de clases vinculadas al mensaje de error para que el recolector las ignore. La siguiente configuración ignoraría todos los errores del tipo Error con las cadenas de mensajes exactas (distingue entre mayúsculas y minúsculas) de Undefined y Out of time:

error_collector: {
    /* ... */
    ignore_messages: {"Error":["Undefined", "Out of time"]}
}

Ignoraría todos los errores de tipo Error, con las cadenas de mensaje exactas (distingue entre mayúsculas y minúsculas) de Undefined y Out of time.

Lista delimitada por comas de códigos de estado HTTP para que el selector de errores los marque como se esperaba.

La siguiente configuración

error_collector: {
    /* ... */
    expected_classes: ["ReferenceError"]
}

Marcaría todos los errores de referencia como se esperaba.

Un objeto de JavaScript que describe una lista de clases de JavaScript vinculadas al mensaje de error de JavaScript para que el recolector lo ignore. La siguiente configuración.

error_collector: {
    /* ... */
    expected_messages: {"Error":["Undefined", "Out of time"]}
}

Marcaría todos los errores de tipo Error, con las cadenas de mensaje exactas (distingue entre mayúsculas y minúsculas) de Undefined y Out of time.

Si es true, el agente captura el atributo de la colección de errores.

Prefijo del atributo a excluir de la colección de errores. Permite * como comodín al final.

Prefijo del atributo a incluir en la colección de errores. Permite * como comodín al final.

Define el número máximo de eventos que el agente recopila por minuto. Si hay más que este número, el agente recopila un muestreo estadístico.

Cuando está habilitado, el agente recopila la traza lenta de la transacción.

Duración mínima de la consulta (en milisegundos) para que una transacción sea elegible para consulta lenta en la traza de la transacción.

Esta opción afecta tanto a consulta lenta como record_sql para traza de la transacción. Puede tener estos valores: off, obfuscated o raw.

Cuando se establece en off no se capturará ninguna consulta lenta y los backtraces y SQL no se incluirán en la traza de la transacción. Si se establece en raw o obfuscated, el agente envía SQL sin formato u ofuscado y una muestra de consulta lenta al recolector. El agente también puede enviar SQL cuando se cumplen otros criterios, como cuando se establece slow_sql.enabled .

Define el número máximo de solicitudes elegibles para la traza de la transacción.

Las transacciones se nombran según la solicitud y top_n se refiere a las "n transacciones más lentas" agrupadas por estos nombres. El módulo reemplaza una traza registrada con una nueva traza solo si la nueva traza es más lenta que la traza más lenta anterior con ese nombre. El valor predeterminado para esta configuración es top_n: 20, porque la páginaTransactions también muestra de manera predeterminada las 20 transacciones más lentas.

El agente de Node.js captura al menos cinco transacciones lentas diferentes en el primer ciclo de recolección después del inicio. También restablecerá y capturará diferentes transacciones si no se han capturado transacciones lentas durante los últimos cinco ciclos de recolección. Esto le permite ver más información sobre más rutas de solicitud de su aplicación, con el posible costo de no centrarse en la solicitud absolutamente más lenta para ese ciclo de recolección.

Umbral del tiempo de respuesta de una transacción web en segundos más allá del cual una transacción es elegible para el seguimiento de transacciones. El valor predeterminado es apdex_f; esto establece el umbral de traza en cuatro veces el Apdex T de su aplicación. También puede ingresar un valor de tiempo específico en milisegundos.

Example: Threshold set to apdex_f

El apdex_t predeterminado es 100 milisegundos. Si su umbral de transacción se establece en apdex_f, una transacción "lenta" dura 400 milisegundos.

Si true, el agente captura atributo de la traza de la transacción.

Prefijo de atributo a excluir de la traza de la transacción. Permite * como comodín al final.

Prefijo de atributo a incluir en la traza de la transacción. Permite * como comodín al final.

Una lista de reglas delimitadas por comas para hacer coincidir las URL de solicitud entrante y nombrar la transacción New Relic asociada. Utiliza el formato:

name: [
    { pattern: 'STRING_OR_REGEX', name: 'NAME' },
    { pattern: 'STRING_OR_REGEX', name: 'NAME' }
]

Ambos parámetros son obligatorios. Para cadenas, debe escapar de los caracteres de control. No es necesario escapar de los caracteres de control en las expresiones regulares. Se ignoran los atributos adicionales.

Las expresiones regulares admiten grupos de captura de estilo JavaScript y los nombres utilizan cadenas de reemplazo de estilo $1 . Las expresiones regulares sólo encuentran el primer resultado coincidente; Las coincidencias posteriores se ignoran. Para obtener más información, consulte API de nomenclatura de transacciones de Node.js.

Para la variable de entorno NEW_RELIC_NAMING_RULES , pase las reglas como literales de objeto JSON delimitados por comas:

NEW_RELIC_NAMING_RULES='{"pattern":"^t","name":"u"},{"pattern":"^u","name":"t"}'

Defina una lista de URL de solicitud que desea que el agente ignore. Especifique la lista como patrones, que pueden ser cadenas o expresiones regulares. El valor predeterminado es una expresión regular para coincidir con las solicitudes de sondeo prolongado de socket.io.

Cuando está habilitado, el agente cambia el nombre de las transacciones que no se ven afectadas por otra lógica de nombres (como la API, reglas o reglas de normalización métrica) a NormalizedUri/*. Si configura esto en false, el agente establece los nombres de las transacciones en Uri/path/to/resource.

Cuando está habilitado, el agente envía el evento de transacción a New Relic. Los datos de este evento incluyen el momento de la transacción, el nombre de la transacción y cualquier atributo personalizado. Si esto está deshabilitado, el agente no recopila estos datos ni los envía a New Relic.

Define el número máximo de eventos que el agente recopila por minuto. Si hay más que este número, el agente recopila un muestreo estadístico.

No recomendamos configurar más de 10.000. El servidor limitará los datos a 10.000 por minuto.

Define el número máximo de eventos que el agente almacena si no puede comunicarse con el recolector de New Relic. Los valores del ciclo de recolección anterior se fusionarán en el siguiente, limitando esta opción el número máximo. Asegúrese de que este número sea mayor que max_samples_per_minute; por ejemplo, configúrelo al doble. Considere la sobrecarga de su memoria antes de aumentar este valor.

Define el número máximo de eventos que el agente recopila por minuto. Si hay más que este número, el agente recopila un muestreo estadístico.

Si true, el agente captura el atributo del evento de transacción.

Prefijo de atributo a excluir del evento de transacción. Permite * como comodín al final.

Prefijo de atributo a incluir en evento de transacción. Permite * como comodín al final.

Genere encabezados de JavaScript para la instrumentación browser . Si se establece en true el agente no inyecta automáticamente el código JS del browser a menos que haya habilitado monitoreo de browsermanualmente. Incluso si lo ha habilitado y ha agregado el encabezado de sincronización browser , puede deshabilitar el monitoreo del browser para su aplicación configurándolo en false.

Si es true, solicite fuentes no minificadas del servidor.

Si true, el agente envía un atributo personalizado al monitoreo del browser.

Prefijo de atributo a excluir del monitoreo del navegador. Permite * como comodín al final.

Prefijo de atributo a incluir en el monitoreo del navegador. Permite * como comodín al final.

Cuando está habilitado, el agente envía el evento personalizado grabado con recordCustomEvent() a New Relic. Si esto está deshabilitado, el agente no recopila estos datos ni los envía a New Relic.

• Define el número máximo de eventos personalizados que el agente recopila por minuto. Si el número de eventos personalizados excede este límite, el agente recopila un muestreo estadístico.

• Al configurar el agente para el monitoreo de IA, configúrelo en el valor máximo 100000. Garantiza que se capture la cantidad máxima de eventos LLM.

  Importante

  Aumentar este límite puede aumentar el uso de memoria.

Cuando está habilitado, el agente recopila detalles de consulta lenta.

Define el número máximo de consultas lentas que cobra el agente por minuto. El agente descarta consultas adicionales una vez alcanzado el límite.

Especifique un nombre de host personalizado para mostrar en New Relic. Si no configura este campo, New Relic continuará usando el nombre de host predeterminado que se encuentra al llamar os.hostname().

• Si utiliza la configuración de nombre de host predeterminada, New Relic encuentra el nombre de host a través de os.hostname().
• Si esta llamada falla, New Relic usa la IP del host como nombre.
• Si configura ipv_preference: 4 o ipv_preference: 6, puede seleccionar el tipo de dirección IP (IPv4 o IPv6) que aparece en la UI de New Relic.

Cuando está habilitado, el agente recopila la instancia de almacenamiento de datos métrica (como host y puerto) para algún controlador de la base de datos. Estos se informan en consulta lenta traza y traza de la transacción.

Cuando está habilitado, el agente recopila el nombre de la base de datos en consulta lenta traza y traza de la transacción para algún controlador de la base de datos.

Cuando se establece en true, permite el seguimiento de transacciones en más de una aplicación de monitor New Relic.

Cuando false, el agente redactará los mensajes de los errores capturados.

Establezca esto en false para deshabilitar el rastreo distribuido. Por ejemplo, en el archivo de configuración, usarías:

distributed_tracing: {
    enabled: false
}

Establezca esto en true para excluir el encabezado New Relic que se adjunta a las solicitudes salientes y, en su lugar, confíe únicamente en los encabezados W3C Trace Context para el rastreo distribuido. Si es false , se utilizan ambos tipos de encabezados.

Por ejemplo, para habilitar esto en el archivo de configuración, usaría:

distributed_tracing: {
    enabled: true,
    exclude_newrelic_header: true
}

Cuando está habilitado, el agente enviará todos los códigos de estado de gRPC de error a New Relic, es decir, códigos de estado distintos de cero. Si está deshabilitado, la instrumentación del servidor no enviará ningún código de estado distinto de cero a New Relic.

Activa o desactiva los informes de eventos de intervalo.

Esta configuración se puede utilizar para activar o desactivar los informes de atributos para tramos. Si attributes.enabled en el nivel raíz es false, no se enviará ningún atributo con intervalos, independientemente de cómo esté configurado.

Si los atributos están habilitados para los tramos, todas las claves de atributos que se encuentran en esta lista se adjuntarán a los tramos. Para obtener más información, consulte las reglas de atributos del agente.

Todas las claves de atributos que se encuentran en esta lista no se enviarán con intervalos. Para obtener más información, consulte las reglas de atributos del agente.

Para obtener ayuda para obtener una entrada de host de observador de traza Infinite Tracing válida, consulte Buscar o crear un extremo de observador de traza.

La cantidad de tramos de Infinite Tracing que el agente mantendrá en la memoria antes de eliminarlos.

Rara vez será necesario cambiar esta configuración respecto a la predeterminada, ya que la cola no está en uso la mayor parte del tiempo. La cola está en uso solo durante las reconexiones al extremo Infinite Tracing mientras el agente no puede transmitir datos. Es posible que el agente elimine los intervalos de seguimiento infinito durante estos períodos; en ese caso, aumentar este número puede ser útil.

Permite generar automáticamente el logs en el contexto.

Por ejemplo, para desactivar esta característica en el archivo de configuración, usaría:

application_logging: {
    enabled: false
}

Alterna si el agente recopila la métrica de registro utilizada en el gráfico de registro en la página Resumen de APM.

Alterna si el agente recopila log para enviarlos a New Relic.

Número de log para enviar por minuto a New Relic. Controla el consumo general de memoria cuando se utiliza el reenvío de registros.

Establezca esto en un valor más bajo para reducir la cantidad de líneas log enviadas (puede causar muestreo log ). Establezca esto en un valor más alto para enviar más líneas log .

Cada log recibe la misma prioridad que su transacción asociada. Los registros que ocurren fuera de una transacción recibirán una prioridad aleatoria. Es posible que algunos registros no se incluyan porque están limitados por max_samples_stored. Por ejemplo, si el registro max_samples_stored se establece en 10 000 y la transacción 1 tiene 10 000 entradas log , solo se registrarán las entradas log de la transacción 1. Si la transacción 1 tiene menos de 10 000 registros, recibirá todos los registros de la transacción 1. Si todavía hay espacio, recibirás todo el registro de la transacción 2, y así sucesivamente.

Si después de todo se registran los registros de transacciones muestreadas y no han alcanzado el límite en max_samples_stored, entonces se envían mensajes de registro de transacciones que no estaban en nuestro muestreo. Si queda alguno, se registran mensajes de registro fuera de la transacción.

Alterna si el agente realiza la decoración log local en la salida log estándar.

Alterna si se deben capturar atributos adicionales en extensiones de middleware para todo el marco web Node.js que ayudan a impulsar el nivel de código métrico. Los atributos adicionales son: code.filepath, code.function, code.lineno y code.column.

Habilita la ofuscación de URL del agente de nodo basado en expresiones regulares.

Especifica el patrón de expresiones regulares que se utilizará para la ofuscación de URL. Si no se establece esto, no se realizará ninguna ofuscación de URL.

Especifica los indicadores de expresiones regulares que se utilizarán para la coincidencia de patrones de ofuscación de URL, por ejemplo g para coincidencias globales, i para coincidencias que no distinguen entre mayúsculas y minúsculas, etc. Se pueden especificar varios indicadores como una cadena, por ejemplo gi. Si no se establece esto, no se utilizarán banderas.

Especifica la cadena de reemplazo que se utilizará para la ofuscación de URL. Puede contener referencias para capturar grupos en el patrón, por ejemplo. $1. Si no se establece esto, todo será reemplazado por una única cadena vacía.

Alterna si los datos del agente de New Relic Security se envían a New Relic o no. Cuando esto está deshabilitado y security.agente.enabled es verdadero, el agente de seguridad se registrará pero no se enviarán datos.

Alterna si el agente New Relic Security está cargado. Esta propiedad se lee solo una vez al inicio de la aplicación.

Modo proporcionado por New Relic Security: IAST. El valor predeterminado es IAST. Debido a la naturaleza invasiva del escaneo IAST, NO habilite este modo ni en un entorno de producción ni en un entorno donde se procesen datos de producción.

New Relic Security. Este es el extremo al que el agente de seguridad envía datos, debe coincidir con el entorno que ha configurado para el agente Node.js.

Habilite la detección de eventos de seguridad de RCI.

Habilite la detección de eventos de seguridad RXSS.

Habilite la detección de eventos de seguridad de deserialización.

Si es verdadero, el agente utiliza nombres de dinamómetros Heroku como nombre de host.

Si es verdadero, el agente se cargará cuando esté en un subproceso de trabajo si se especifica.

Ruta al directorio que contiene newrelic.js. Esto solo está disponible como variable de entorno. No puede configurarlo en su archivo de configuración.

Si se usa, esto evita que el agente lea los ajustes de configuración de newrelic.js. Los valores predeterminados y los valores de las variables de entorno aún estarán establecidos.

Esto solo está disponible como variable de entorno. No puede configurarlo en su archivo de configuración.

Los tipos de matriz se definen como cadenas delimitadas por comas.

NEW_RELIC_ERROR_COLLECTOR_IGNORE_ERROR_CODES=404,500,429

Los tipos de objetos se definen como una cadena json.

NEW_RELIC_ERROR_COLLECTOR_EXPECTED_MESSAGES='{"Error":["Undefined", "No soup for you!"]}'