Agente de inicio de logs en el contexto de Java

Este es el enfoque más simple y es una excelente opción para desarrolladores que quizás no tengan acceso o interés en configurar un reenviador de registros, o para cuentas que quieran ver el poder de los registros y otros metadatos de enlace en el contexto de sus aplicaciones. sin muchos gastos generales.

Al utilizar esta opción, el agente agrega span.id, trace.id, hostname, entity.guid y entity.name. Obtenga más información sobre las limitaciones del reenvío de registros.

Esta funcionalidad está habilitada de forma predeterminada.

Todo lo que necesita hacer es instalar una versión del agente con capacidades de reenvío de registros (agente de Java 7.6.0 o superior). Si el reenvío está deshabilitado, puede usar esta configuración:

Archivo de configuración (newrelic.yml), con sangría de 2 espacios debajo de la sección común:

application_logging:
  enabled: true
  forwarding:
    enabled: true
    max_samples_stored: 10000 
  local_decorating: 
    enabled: false

Variable ambiental:

NEW_RELIC_APPLICATION_LOGGING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED=10000
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=false

Propiedad del sistema:

-Dnewrelic.config.application_logging.enabled=true
-Dnewrelic.config.application_logging.forwarding.enabled=true
-Dnewrelic.config.application_logging.forwarding.max_samples_stored=10000
-Dnewrelic.config.application_logging.local_decorating.enabled=false

Optional adjustments (max_samples_stored):

Una vez que esta característica está habilitada, también tienes control sobre la cantidad máxima de líneas log enviadas a New Relic cada minuto. El valor predeterminado es 10.000. Si el agente ve más de 10,000 líneas log en una ventana de 60 segundos, se comenzará a muestrear su registro.

Configúrelo en un número más alto para recibir más registros. Configúrelo en un número más bajo para recibir menos registros. Cualquier número entero no negativo es válido.

Archivo de configuración (newrelic.yml):

application_logging:
  enabled: true
  forwarding:
    enabled: true
      max_samples_stored: 10000
  local_decorating: 
    enabled: false

Variable ambiental:

NEW_RELIC_APPLICATION_LOGGING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED=10000
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=false

Propiedad del sistema:

-Dnewrelic.config.application_logging.enabled=true
-Dnewrelic.config.application_logging.forwarding.enabled=true
-Dnewrelic.config.application_logging.forwarding.max_samples_stored=10000
-Dnewrelic.config.application_logging.local_decorating.enabled=false

¿Ya tienes un reenviador de logs que te gusta? ¡Te tenemos cubierto! El agente de Java puede decorar su registro con los metadatos de enlace necesarios para brindar acceso a la característica de contexto de inicio de sesión automático, y usted puede enviarlos a New Relic usando su reenviador de registros manual.

Actualice la configuración de su agente para deshabilitar el reenvío de registros y habilitar la decoración local, luego reinicie el agente para comenzar a decorar su registro.

Archivo de configuración (newrelic.yml), con sangría de 2 espacios debajo de la sección común:

application_logging:
   enabled: true
   local_decorating: 
     enabled: true
   forwarding:
     enabled: false

Variable ambiental:

NEW_RELIC_APPLICATION_LOGGING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=false

Propiedad del sistema:

-Dnewrelic.config.application_logging.enabled=true
-Dnewrelic.config.application_logging.local_decorating.enabled=true
-Dnewrelic.config.application_logging.forwarding.enabled=false

Nuestro decorador agrega cinco atributos a cada mensaje de registro en su archivo de registro de aplicación: entity.guid, hostname, trace.id, span.id y entity.name. Ejemplo:

This is my log message. NR-LINKING|{entity.guid}|{hostname}|{trace.id}|{span.id}|{entity.name}|

Algunos atributos pueden estar vacíos si el log ocurrió fuera de una transacción o si no son aplicables al contexto de su aplicación.

Ofrecemos una extensión Dropwizard para logs en el contexto con el agente de Java. Para comenzar, revise el código y una aplicación de ejemplo en GitHub.

Para configurar el logs en el contexto para su aplicación Java con la extensión DropWizard:

1. Asegúrese de tener el paquete Dropwizard 1.3 o superior instalado y funcionando en su aplicación. Utilice los complementos originales de Dropwizard y la fábrica de registros instalados y funcionando en la aplicación.

2. Asegúrese de tener instalado en su aplicación New Relic agente de Java versión 5.6.0 o superior y de haber habilitado el argumentoJVM -javaagent.

3. Actualice la dependencia de su proyecto para incluir la extensión Dropwizard 1.3 según corresponda:

   Gradle: Agregue lo siguiente a su archivo build.gradle :

   dependencies {
       implementation("com.newrelic.logging:dropwizard:2.0")
       }

   Copia

   Maven: Agregue lo siguiente a su archivo pom.xml :

   <dependencies>
       <dependency>
           <groupId>com.newrelic.logging</groupId>
           <artifactId>dropwizard</artifactId>
           <version>2.0</version>
       </dependency>
   </dependencies>

   Copia

4. Actualice su archivo de configuración .yaml de Dropwizard con un diseño newrelic-json , reemplazando el type: console o type: file actualmente utilizado por type: newrelic-console o type: newrelic-file según corresponda. Por ejemplo:

   logging:
     appenders:
       - type: newrelic-console
         # Add the two lines below if you don't have a layout specified on the appender.
         # If you have a layout, remove all parameters to the layout and set the type.
         layout:
           type: newrelic-json

   Copia

   La extensión New Relic Dropwizard también admite un tipo de diseño log-format que utiliza el registro estándar de Dropwizard. Para fines de prueba, puede cambiar el tipo de diseño con un cambio de una línea:

   logging:
     appenders:
       - type: newrelic-file
         # This format will be ignored by the newrelic-json layout, but used by the log-format layout.
         logFormat: "%date{ISO8601} %c %-5p: %m trace.id=%mdc{trace.id} span.id=%mdc{span.id}%n"
         layout:
           # type: newrelic-json
           type: log-format

   Copia

Ofrecemos una extensión java.util.logging para logs en el contexto con el agente de Java. Para comenzar, revise el código y una aplicación de ejemplo en GitHub.

Para configurar el logs en el contexto para su aplicación Java con la extensión java.util.logging :

1. Asegúrese de tener el paquete java.util.logging instalado y funcionando en la aplicación.

2. Asegúrese de tener instalado en su aplicación New Relic agente de Java versión 5.6.0 o superior y de haber habilitado el argumentoJVM -javaagent.

3. Actualice la dependencia de su proyecto para incluir la extensión java.util.logging según corresponda. Si no puede editar estos archivos, puede agregar los archivos jar directamente a la aplicación classpath.

   Gradle: Agregue lo siguiente a su archivo build.gradle :

   dependencies {
     implementation("com.newrelic.logging:jul:2.0")
     }

   Copia

   Maven: Agregue lo siguiente a su archivo pom.xml :

   <dependencies>
     <dependency>
         <groupId>com.newrelic.logging</groupId>
         <artifactId>jul</artifactId>
         <version>2.0</version>
     </dependency>
   </dependencies>

   Copia

4. Compruebe si la propiedad handlers de su archivo de registro está configurada en algo distinto de NewRelicMemoryHandler. Busque una línea que enumere los controladores del logger raíz, como esta:

   handlers = java.util.logging.FileHandler

   Copia

5. Actualice su archivo de propiedades de registro para configurar el controlador del logger raíz en NewRelicMemoryHandler para que intercepte los mensajes destinados a otro controlador:

   handlers = com.newrelic.logging.jul.NewRelicMemoryHandler

   Copia

6. Configure NewRelicMemoryHandler estableciendo el objetivo en el controlador que se asignó previamente al logger raíz, para que capture los datos que New Relic necesita en el hilo del que proviene el mensaje de registro:

   com.newrelic.logging.jul.NewRelicMemoryHandler.target = java.util.logging.FileHandler

   Copia

7. Utilice un NewRelicFormatter para el controlador final. Actualice su archivo de propiedades de registro para establecer la propiedad formatter como en el siguiente ejemplo. Asegúrese de que el controlador donde configuró el formateador sea el controlador target del paso anterior (java.util.logging.FileHandler en este ejemplo).

   java.util.logging.FileHandler.formatter = com.newrelic.logging.jul. NewRelicFormatter

   Copia

   El formato de New Relic Logs es JSON con metadatos de telemetría que utilizamos para correlacionar transacciones y registrar juntos. Actualmente no admitimos ninguna personalización de ese formato.

   Una vez completado, JSON es un registro en lugar de texto. El JSON debe tener el formato de objetos individuales, uno por línea, y debe contener campos como log.level y thread.name. El trace.id, que es necesario para logs en el contexto, solo debe tener un valor para el mensaje de registro que ocurre dentro de una transacción.

La forma más directa de obtener las extensiones de contexto de inicio de sesión es agregar estas dependencias a pom.xml de Maven o build.gradle de Gradle. Esto permite que las herramientas de embalaje recojan la dependencia correcta.

Si no puede editar estos archivos, puede agregar los archivos jar directamente a la aplicación classpath para la configuración de su framework de registro.

Antes de modificar el classpath:

1. Habilite el argumentoJVM -javaagent en el agente de Java de su aplicación.
2. Verifique qué framework de registro está utilizando la aplicación.
3. Asegúrese de poder cambiar la configuración de su framework de registro.
4. Agregue los siguientes tres archivos jar al classpath si aún no están presentes. Generalmente, recomendamos utilizar las últimas versiones publicadas en Maven Central.

• ID de grupo com.newrelic.logging e ID de artefacto: seleccione el artefacto que lleva el nombre del framework de registro de su aplicación en Maven.
• ID de grupo com.fasterxml.jackson.core e ID de artefacto: utilice jackson-core.
• ID de grupo com.newrelic.agent.java e ID de artefacto: utilice newrelic-api.

Ofrecemos una extensión Log4j 1.x para logs en el contexto manual con el agente de Java. Para comenzar, revise el código y una aplicación de ejemplo en GitHub.

Para configurar el inicio de logs en el contexto manual para su aplicación Java con la extensión Log4j 1.x, debe configurar la extensión Log4j en código o mediante XML. Los archivos de propiedades no son compatibles porque la instancia AsyncAppender solo se puede configurar automáticamente a través de XML.

1. Asegúrese de tener el paquete Log4j 1.x instalado y funcionando en la aplicación.

2. Asegúrese de tener instalado en su aplicación New Relic agente de Java versión 5.6.0 o superior y de haber habilitado el argumentoJVM -javaagent.

3. Actualice la dependencia de su proyecto para incluir la extensión Log4j 1.x según corresponda.

   Gradle: Agregue lo siguiente a su archivo build.gradle :

   dependencies {
     implementation("com.newrelic.logging:log4j1:2.0")
     }

   Copia

   Maven: Agregue lo siguiente a su archivo pom.xml :

   <dependencies>
       <dependency>
           <groupId>com.newrelic.logging</groupId>
           <artifactId>log4j1</artifactId>
           <version>2.0</version>
       </dependency>
   </dependencies>

   Copia

4. En su archivo XML de configuración de registro, actualice su elemento <appender> con un NewRelicLayout, agregando <layout class="com.newrelic.logging.log4j1.NewRelicLayout"/>:

   <appender name="TypicalFile" class="org.apache.log4j.FileAppender">
     <param name="file" value="logs/log4j1-app.log"/>
     <param name="append" value="false"/>
     <layout class="com.newrelic.logging.log4j1.NewRelicLayout"/> <!-- only this line needs to be added -->
   </appender>

   Copia

5. Utilice NewRelicAsyncAppender para envolver cualquier apéndice que tenga como objetivo el reenviador de registros de New Relic. Por ejemplo:

   <appender name="NewRelicFile" 
             class="com.newrelic.logging.log4j1.NewRelicAsyncAppender">
     <appender-ref ref="TypicalFile" />
   </appender>

   Copia

6. Utilice el agregador asíncrono en el logger raíz. Por ejemplo:

   <root>
       <appender-ref ref="NewRelicFile" />
   </root>

   Copia

   Example configuration file for the Log4j 1.x extension:

   <?xml version="1.0" encoding="UTF-8" ?>
   <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
   <log4j:configuration debug="false">
     <appender name="TypicalFile" class="org.apache.log4j.FileAppender">
         <param name="file" value="logs/log4j1-app.log"/>
         <param name="append" value="false"/>
         <!-- layout has been replaced -->
         <layout class="com.newrelic.logging.log4j1.NewRelicLayout"/>
     </appender>
   
       <!-- this appender was added -->
     <appender name="NewRelicFile" 
               class="com.newrelic.logging.log4j1.NewRelicAsyncAppender">
         <appender-ref ref="TypicalFile" />
     </appender>
   
     <appender name="TypicalConsole" class="org.apache.log4j.ConsoleAppender">
       <layout class="org.apache.log4j.PatternLayout"> 
         <param name="ConversionPattern" value="%-5p %c{1} - %m%n"/> 
       </layout> 
     </appender>
   
     <root>        ​
         <!-- the new appender was used here -->​​
         <appender-ref ref="NewRelicFile" />
         <appender-ref ref="TypicalConsole" />
     </root>
   
   </log4j:configuration>

   Copia

Ofrecemos una extensión Log4j 2.x para logs en el contexto con el agente de Java. Para comenzar, revise el código y una aplicación de ejemplo en GitHub.

Para configurar el logs en el contexto para su aplicación Java con la extensión Log4j 2.x:

1. Asegúrese de tener el paquete de enlace Log4j 2.13.2 o superior o Logs4j 2 instalado y funcionando en su aplicación.

2. Asegúrese de tener instalado en su aplicación New Relic agente de Java versión 5.6.0 o superior y de haber habilitado el argumentoJVM -javaagent.

3. Actualice la dependencia de su proyecto para incluir la extensión Log4j 2.x según corresponda:

   Gradle: Agregue la sección resaltada a su archivo build.gradle :

   dependencies {
       implementation("com.newrelic.logging:log4j2:2.0")
   }

   Copia

   Maven: Agregue la sección resaltada a su archivo pom.xml :

   <dependencies>
     <dependency>
             <groupId>com.newrelic.logging</groupId>
             <artifactId>log4j2</artifactId>
             <version>2.0</version>
           </dependency>
   </dependencies>

   Copia

4. En su archivo XML de configuración de registro, actualice su elemento <configuration> agregando la sección resaltada:

   <Configuration xmlns="http://logging.apache.org/log4j/2.0/config"
         packages="com.newrelic.logging.log4j2"
   >

   Copia

   Si está utilizando un archivo de propiedades, agregue packages=com.newrelic.logging.log4j2.

5. Agregue <NewRelicLayout/> para usar un elemento NewRelicLayout dentro de uno de los apéndices. Por ejemplo:

   <File name="MyFile" fileName="logs/app-log-file.log">
       <NewRelicLayout/>
   </File>

   Copia

   Si está utilizando un archivo de propiedades, solo cambie layout.type:

   appender.console.type = Console
   appender.console.name = STDOUT
   appender.console.layout.type = NewRelicLayout

   Copia

6. Si solo modificó un apéndice existente, omita este paso. Si agregó un nuevo agregador, agregue <AppenderRef/> dentro de <Root> para usar este agregador. Utilice el atributo ref para hacer referencia al anexo name que creó en el paso anterior. Por ejemplo:

   <Root level="info">
       <AppenderRef ref="MyFile"/>
   
   </Root>

   Copia

   Si está utilizando un archivo de propiedades y agregó un nuevo apéndice, agregue:

   rootLogger.level = info
       rootLogger.appenderRef.stdout.ref = STDOUT
   ​​​​​

   Copia

Ofrecemos una extensión Logback para logs en el contexto con el agente de Java. Para comenzar, revise el código y una aplicación de ejemplo en GitHub.

Para configurar el logs en el contexto para su aplicación Java con Logback:

1. Asegúrese de tener Logback versión 1.2.0 o superior y New Relic agente de Java versión 5.6.0 o superior instalado y funcionando en su aplicación.

2. Asegúrese de tener instalado en su aplicación New Relic agente de Java versión 5.6.0 o superior y de haber habilitado el argumentoJVM -javaagent.

3. Actualice la dependencia de su proyecto para incluir la extensión Logback según corresponda:

   Gradle: Agregue la sección resaltada a su archivo build.gradle :

   dependencies {
       implementation("com.newrelic.logging:logback:2.0")
   }

   Copia

   Maven: Agregue la sección resaltada a su archivo pom.xml :

   <dependencies>
     <dependency>
             <groupId>com.newrelic.logging</groupId>
             <artifactId>logback</artifactId>
             <version>2.0</version>
           </dependency>
   </dependencies>

   Copia

4. Actualice su configuración de registro xml para reemplazar cualquier elemento <encoder> existente.

   Si está iniciando sesión en la consola (stdout/stderr), busque ConsoleAppender y reemplace:

   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
       <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
   </appender>

   Copia

   Si está iniciando sesión en un archivo, busque FileAppender y reemplace <encoder>:

   <appender name="LOG_FILE" class="ch.qos.logback.core.FileAppender">
       <file>logs/app-log-file.log</file>
       <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
   </appender>

   Copia

5. Actualice su configuración de registro xml con el NewRelicAsyncAppender. Para asegurarse de que NewRelicAsyncAppender incluya los apéndices que apuntarán al reenviador de registros de New Relic, agregue la siguiente sección. Cambie "LOG_FILE" por el nombre del appender que actualizó en el paso anterior.

   <appender name="ASYNC" class="com.newrelic.logging.logback.NewRelicAsyncAppender">
       <appender-ref ref="LOG_FILE" />
   </appender>

   Copia

6. Asegúrese de que NewRelicAsyncAppender sea el complemento first utilizado en su logger. Reemplace los apéndices de su loggerraíz con el apéndice ASYNC creado en el paso anterior. Luego, enumere los demás apéndices after o NewRelicAsyncAppender en la lista <root> .

   <root>
       <appender-ref ref="ASYNC" />
   </root>

   Copia

   A continuación se muestran ejemplos de un archivo de registro .xml actualizado para la extensión Logback. También puedes ver un ejemplo funcional en GitHub.

   Single console appender example

   Archivo de configuración de ejemplo después de agregar la información de la extensión de registro:

   <configuration>
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
   
       <!-- changed the encoder -->
       <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
   
     </appender>
   
     <!-- added the ASYNC appender -->
     <appender name="ASYNC" class="com.newrelic.logging.logback.NewRelicAsyncAppender">
       <appender-ref ref="STDOUT" />
     </appender>
   
     <root level="debug">
   
       <!-- changed the root logger -->
       <appender-ref ref="ASYNC" /> 
   
     </root>
   </configuration>

   Copia

   Two console appenders example

   Este ejemplo envía el registro de New Relic a un archivo, pero aún envía el registro estándar a la consola:

   <configuration>
     <appender name="FILE" class="ch.qos.logback.core.FileAppender">
       <file>myApp.log</file>
       <!-- encoder changed -->
       <encoder class="com.newrelic.logging.logback.NewRelicEncoder"/>
     </appender>
   
     <!-- this appender does normal console logging -->
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
       <encoder>
         <pattern>%msg%n</pattern>
       </encoder>
     </appender>
   
     <!-- The required New Relic ASYNC appender wraps the FILE appender -->
     <appender name="ASYNC" class="com.newrelic.logging.logback.NewRelicAsyncAppender">
       <appender-ref ref="FILE" /> 
     </appender>
   
     <root level="debug">
       <!-- ASYNC is one of the main appenders -->
       <appender-ref ref="ASYNC" /> 
   
       <!-- Send every message to normal console logging, as well. -->
       <appender-ref ref="STDOUT" />
     </root>
   </configuration>

   Copia

Ofrecemos extensiones para las versiones actuales de Spring y Spring Boot. Si ya conoce la biblioteca de registro, puede pasar directamente a esa documentación:

• java.util.logging

• log4j 1

• log4j 2

• logback

  Las extensiones admiten la configuración predeterminada solo en Spring Boot 2.0 y superior.

  With Spring Boot:

  A continuación se ofrecen algunos consejos para determinar qué biblioteca de registro tiene:

• Si tienes spring-boot-starter-log4j2 en tu dependencia, estás usando log4j 2.x. Consulte la documentación de Spring Boot log4j 2.x para conocer la configuración básica y la extensión New Relic log4j 2 para personalizar su configuración.

• Si estás usando Spring Boot pero no starter-log4j2, estás usando logback de forma predeterminada. Consulte la documentación de inicio de sesión de Spring Boot para conocer la configuración básica y la extensión de inicio de sesión de New Relic para personalizar su configuración.

  With Spring (but not Spring Boot):

  Primavera 5 o superior:

  Spring implementa un puente hacia otras bibliotecas de registro que las encontrará automáticamente. Sin embargo, esas bibliotecas individuales deben configurarse e incluirse explícitamente en la dependencia de su proyecto.

  Para identificar su dependencia de registro, consulte el árbol de dependencias de Gradle, Maven u otra herramienta de compilación. Luego siga los procedimientos para configurar el logs en el contexto para su aplicación Java con esa extensión.

  Primavera 4 o inferior:

  La versión 4 de Spring y versiones anteriores utilizan Apache Commons Logging para su puente. Consulte la documentación de Spring para obtener información sobre cómo configurar su puente.