Logs en contexte de l'agent Java

Il s'agit de l'approche la plus simple et constitue un excellent choix pour les développeurs qui n'ont peut-être pas l'accès ou l'intérêt de configurer un redirecteur de log , ou pour les comptes qui souhaitent voir la puissance des logs et autres liens métadonnées dans le contexte de leurs applications, sans beaucoup de frais généraux.

En utilisant cette option, l'agent ajoute span.id, trace.id, hostname, entity.guid et entity.name. Renseignez-vous sur les limites du transfert de log .

Cette fonctionnalité est activée par défaut.

Il vous suffit d'installer une version d'agent avec des capacités de transfert de log (agent Java 7.6.0 ou supérieur). Si le transfert est désactivé, vous pouvez utiliser cette configuration :

Fichier de configuration (newrelic.yml), en retrait de 2 espaces sous la section commune :

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

Variable d'environnement :

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

Propriété du système :

-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):

Une fois cette fonctionnalité activée, vous avez également le contrôle sur le nombre maximal de lignes log envoyées à New Relic chaque minute. La valeur par défaut est 10 000. Si plus de 10 000 lignes log sont vues par l'agent dans une fenêtre de 60 secondes, votre log commencera à être échantillonné.

Réglez-le sur un nombre plus élevé pour recevoir plus de logs. Réglez-le sur un nombre inférieur pour recevoir moins de logs. Tout entier non négatif est valide.

Fichier de configuration (newrelic.yml):

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

Variable d'environnement :

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

Propriété du système :

-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

Vous avez déjà un redirecteur de logqui vous plaît ? Nous sommes là pour vous ! L'agent Java peut décorer votre log avec les métadonnées de liaison nécessaires pour fournir l'accès aux logs automatiques dans le contexte de la fonctionnalité, et vous pouvez les envoyer à New Relic en utilisant votre redirecteur de logmanuel.

Mettez à jour configuration de votre agent pour désactiver le transfert de loget activer la décoration locale, puis redémarrez l'agent pour commencer à décorer votre log.

Fichier de configuration (newrelic.yml), en retrait de 2 espaces sous la section commune :

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

Variable d'environnement :

NEW_RELIC_APPLICATION_LOGGING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=true
NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=false

Propriété du système :

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

Notre décorateur ajoute cinq attributs à chaque message de log dans votre fichier log d'application : entity.guid, hostname, trace.id, span.id et entity.name. Exemple:

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

Si le message de log est vide ou vierge, le message de sortie sera également vide. Exemple:

NR-LINKING|{entity.guid}|{hostname}|{trace.id}|{span.id}|{entity.name}|.

Le message de sortie du log sera une chaîne vide.

Certains attributs peuvent être vides si le log s'est produit en dehors d'une transaction ou s'ils ne sont pas applicables au contexte de votre application.

Nous proposons une extension Dropwizard pour les logs en contexte avec l'agent Java. Pour commencer, consultez le code et un exemple d’application sur GitHub.

Pour configurer les logs en contexte pour votre application Java avec l'extension DropWizard :

1. Assurez-vous que le package Dropwizard 1.3 ou supérieur est installé et fonctionne sur votre application. Utilisez les appenders Dropwizard d'origine et l'usine de logging installés et fonctionnant sur l'application.

2. Assurez-vous que l'agent Java New Relic version 5.6.0 ou supérieure est installé sur votre application et que vous avez activé l' argument JVM -javaagent.

3. Mettez à jour les dépendances de votre projet pour inclure l'extension Dropwizard 1.3, le cas échéant :

   Gradle: Ajoutez ce qui suit à votre fichier build.gradle :

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

   Copier

   Maven: Ajoutez ce qui suit à votre fichier pom.xml :

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

   Copier

4. Mettez à jour votre fichier de configuration Dropwizard .yaml avec une disposition newrelic-json , en remplaçant le type: console ou type: file actuellement utilisé par type: newrelic-console ou type: newrelic-file selon le cas. Par exemple:

   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

   Copier

   L'extension New Relic Dropwizard prend également en charge un type de mise en page log-format qui utilise le logging Dropwizard standard. À des fins de test, vous pouvez modifier le type de mise en page avec une modification d'une seule ligne :

   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

   Copier

Nous proposons une extension java.util.logging pour les logs en contexte avec l'agent Java . Pour commencer, consultez le code et un exemple d’application sur GitHub.

Pour configurer les logs en contexte pour votre application Java avec l'extension java.util.logging :

1. Assurez-vous que le package java.util.logging est installé et fonctionne sur l'application.

2. Assurez-vous que l'agent Java New Relic version 5.6.0 ou supérieure est installé sur votre application et que vous avez activé l' argument JVM -javaagent.

3. Mettez à jour la dépendance de votre projet pour inclure l'extension java.util.logging le cas échéant. Si vous ne pouvez pas modifier ces fichiers, vous pouvez à la place ajouter les fichiers jar directement à l'application classpath.

   Gradle: Ajoutez ce qui suit à votre fichier build.gradle :

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

   Copier

   Maven: Ajoutez ce qui suit à votre fichier pom.xml :

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

   Copier

4. Vérifiez si la propriété handlers de votre fichier de logging est définie sur autre chose que NewRelicMemoryHandler. Recherchez une ligne répertoriant les gestionnaires de l'enregistreur racine, comme ceci :

   handlers = java.util.logging.FileHandler

   Copier

5. Mettez à jour votre fichier de propriétés de logging pour définir le gestionnaire de l'enregistreur racine sur NewRelicMemoryHandler afin qu'il intercepte les messages destinés à un autre gestionnaire :

   handlers = com.newrelic.logging.jul.NewRelicMemoryHandler

   Copier

6. Configurez le NewRelicMemoryHandler en définissant la cible sur le gestionnaire qui a été précédemment assigné à l'enregistreur racine, afin qu'il capture les données dont New Relic a besoin sur le thread d'où provient le message de log :

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

   Copier

7. Utilisez un NewRelicFormatter pour le gestionnaire final. Mettez à jour votre fichier de propriétés de logging pour définir la propriété formatter comme dans l'exemple suivant. Assurez-vous que le gestionnaire dans lequel vous définissez le formateur est le gestionnaire target de l’étape précédente (java.util.logging.FileHandler dans cet exemple).

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

   Copier

   Le format des logs New Relic est JSON avec télémétrie mémorisée que nous utilisons pour corréler les transactions et les connecter ensemble. Actuellement, nous ne prenons en charge aucune personnalisation de ce format.

   Une fois terminé, JSON est un log au lieu d'un texte. Le JSON doit être formaté sous forme d'objets uniques, un par ligne, et doit contenir des champs tels que log.level et thread.name. Le trace.id, qui est requis pour les logs en contexte, ne devrait avoir une valeur que pour les messages de log qui se produisent dans une transaction.

Le moyen le plus direct d'obtenir les extensions de logs en contexte est d'ajouter ces dépendances à pom.xml de Maven ou build.gradle de Gradle. Cela permet aux outils d'emballage de détecter la dépendance correcte.

Si vous ne pouvez pas modifier ces fichiers, vous pouvez à la place ajouter les fichiers jar directement à l'application classpath pour de votre de framework configuration logging.

Avant de modifier le classpath :

1. Activez l’ argument JVM -javaagent sur l’agent Java de votre application.
2. Vérifiez quel framework de logging l’application utilise.
3. Assurez-vous que vous êtes en mesure de modifier de votre framework de configuration logging.
4. Ajoutez les trois fichiers JAR suivants au classpath s’ils ne sont pas déjà présents. En règle générale, nous recommandons de prendre les dernières versions publiées sur Maven Central.

• ID de groupe com.newrelic.logging et ID d'artefact : sélectionnez l'artefact nommé d'après le framework de logging de votre application dans Maven.
• ID de groupe com.fasterxml.jackson.core et ID d'artefact : utilisez jackson-core.
• ID de groupe com.newrelic.agent.java et ID d'artefact : utilisez newrelic-api.

Nous proposons une extension Log4j 1.x pour les logs en contexte manuels avec l'agent Java . Pour commencer, consultez le code et un exemple d’application sur GitHub.

Pour configurer les logs manuels en contexte pour votre application Java avec l'extension Log4j 1.x, vous devez configurer l'extension Log4j dans le code ou via XML. Les fichiers de propriétés ne sont pas pris en charge car l'instance AsyncAppender ne peut être configurée automatiquement que via XML.

1. Assurez-vous que le package Log4j 1.x est installé et fonctionne sur l'application.

2. Assurez-vous que l'agent Java New Relic version 5.6.0 ou supérieure est installé sur votre application et que vous avez activé l' argument JVM -javaagent.

3. Mettez à jour les dépendances de votre projet pour inclure l'extension Log4j 1.x le cas échéant.

   Gradle: Ajoutez ce qui suit à votre fichier build.gradle :

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

   Copier

   Maven: Ajoutez ce qui suit à votre fichier pom.xml :

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

   Copier

4. Dans votre fichier XML de configuration de logging, mettez à jour votre élément <appender> avec un NewRelicLayout, en ajoutant <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>

   Copier

5. Utilisez NewRelicAsyncAppender pour encapsuler tous les appenders qui cibleront le redirecteur de logde New Relic. Par exemple:

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

   Copier

6. Utilisez l'appender asynchrone sur l'enregistreur racine. Par exemple:

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

   Copier

   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>

   Copier

Nous proposons une extension Log4j 2.x pour les logs en contexte avec l'agent Java. Pour commencer, consultez le code et un exemple d’application sur GitHub.

Pour configurer les logs en contexte pour votre application Java avec l'extension Log4j 2.x :

1. Assurez-vous que le package de liaison Log4j 2.13.2 ou supérieur ou Logs4j 2 est installé et fonctionne sur votre application.

2. Assurez-vous que l'agent Java New Relic version 5.6.0 ou supérieure est installé sur votre application et que vous avez activé l' argument JVM -javaagent.

3. Mettez à jour la dépendance de votre projet pour inclure l'extension Log4j 2.x, le cas échéant :

   Gradle: Ajoutez la section en surbrillance à votre fichier build.gradle :

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

   Copier

   Maven: Ajoutez la section en surbrillance à votre fichier pom.xml :

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

   Copier

4. Dans votre fichier XML de configuration de logging, mettez à jour votre élément <configuration> en ajoutant la section en surbrillance :

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

   Copier

   Si vous utilisez un fichier de propriétés, ajoutez packages=com.newrelic.logging.log4j2.

5. Ajoutez <NewRelicLayout/> pour utiliser un élément NewRelicLayout dans l’un des appenders. Par exemple:

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

   Copier

   Si vous utilisez un fichier de propriétés, modifiez uniquement le layout.type:

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

   Copier

6. Si vous avez uniquement modifié un appender existant, ignorez cette étape. Si vous avez ajouté un nouvel appender, ajoutez <AppenderRef/> dans <Root> pour utiliser cet appender. Utilisez l’attribut ref pour faire référence à l’appender name que vous avez créé à l’étape précédente. Par exemple:

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

   Copier

   Si vous utilisez un fichier de propriétés et que vous avez ajouté un nouvel appender, ajoutez :

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

   Copier

Nous proposons une extension Logback pour les logs en contexte avec l'agent Java. Pour commencer, consultez le code et un exemple d’application sur GitHub.

Pour configurer les logs en contexte pour votre application Java avec Logback :

1. Assurez-vous que vous disposez de la version 1.2.0 ou supérieure de Logback et de la version 5.6.0 ou supérieure de l'agent Java New Relic installée et fonctionnelle sur votre application.

2. Assurez-vous que l'agent Java New Relic version 5.6.0 ou supérieure est installé sur votre application et que vous avez activé l' argument JVM -javaagent.

3. Mettez à jour les dépendances de votre projet pour inclure l'extension Logback, le cas échéant :

   Gradle: Ajoutez la section en surbrillance à votre fichier build.gradle :

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

   Copier

   Maven: Ajoutez la section en surbrillance à votre fichier pom.xml :

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

   Copier

4. Mettez à jour votre configuration de logging xml pour remplacer tout élément <encoder> existant.

   Si vous vous connectez à la console (stdout/stderr), recherchez ConsoleAppender et remplacez :

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

   Copier

   Si vous vous connectez à un fichier, recherchez FileAppender et remplacez <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>

   Copier

5. Mettez à jour votre configuration de logging xml avec le NewRelicAsyncAppender. Pour garantir que NewRelicAsyncAppender encapsule tous les appenders qui cibleront les redirecteurs de logde New Relic, ajoutez la section suivante. Remplacez "LOG_FILE" par le nom de l’appender que vous avez mis à jour à l’étape précédente.

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

   Copier

6. Assurez-vous que NewRelicAsyncAppender est le premier appender utilisé dans votre enregistreur. Remplacez les appenders de votre enregistreur racine par l'appender ASYNC créé à l'étape précédente. Ensuite, répertoriez tous les autres appenders après le NewRelicAsyncAppender dans la liste <root> .

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

   Copier

   Voici quelques exemples d'un fichier de logging .xml mis à jour pour l'extension Logback. Vous pouvez également voir un exemple fonctionnel sur GitHub.

   Single console appender example

   Exemple de fichier de configuration après l'ajout des informations d'extension de logging :

   <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>

   Copier

   Two console appenders example

   Cet exemple envoie le logging New Relic vers un fichier, mais envoie toujours le logging standard à la console :

   <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>

   Copier

Nous proposons des extensions pour les versions actuelles de Spring et Spring Boot. Si vous connaissez déjà la bibliothèque de logging, vous pouvez passer directement à cette documentation :

• java.util.logging

• log4j 1

• log4j 2

• se connecter

  Les extensions prennent en charge la configuration par défaut uniquement sur Spring Boot 2.0 et supérieur.

  With Spring Boot:

  Voici quelques conseils pour déterminer quelle bibliothèque de logging vous possédez :

• Si vous avez spring-boot-starter-log4j2 dans votre dépendance, vous utilisez log4j 2.x. Reportez-vous à la documentation Spring Boot log4j 2.x pour la configuration de base et à l' extension New Relic log4j 2 pour personnaliser votre configuration.

• Si vous utilisez Spring Boot mais pas starter-log4j2, vous utilisez logback par défaut. Reportez-vous à la documentation de Spring Boot logback pour la configuration de base et à l' extension New Relic logback pour personnaliser votre configuration.

  With Spring (but not Spring Boot):

  Printemps 5 ou supérieur :

  Spring implémente un pont vers d'autres bibliothèques de logging qui les trouveront automatiquement. Cependant, ces bibliothèques individuelles doivent être configurées et explicitement incluses dans les dépendances de votre projet.

  Pour identifier votre dépendance de logging, consultez l'arbre de dépendances de votre Gradle, Maven ou autre outil de construction. Suivez ensuite les procédures pour configurer les logs en contexte pour votre application Java avec cette extension.

  Ressort 4 ou inférieur :

  La version Spring 4 et inférieure utilise Apache Commons Logging pour son pont. Reportez-vous à la documentation Spring pour plus d'informations sur la configuration de son pont.