Tracer des applications Java

Installation et démarrage

Pour commencer le tracing d’applications écrites dans n’importe quel langage, vous devez d’abord installer et configurer l’Agent Datadog. Pour obtenir davantage d’informations, consultez la documentation relative au tracing d’applications Docker ou au tracing d’applications Kubernetes.

Téléchargez ensuite dd-java-agent.jar, qui contient les fichiers de classe de l’Agent :

wget -O dd-java-agent.jar 'https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.datadoghq&a=dd-java-agent&v=LATEST'

Enfin, vous devez ajouter l’argument JVM suivant lors du démarrage de votre application dans votre script d’application IDE, Maven ou Gradle ou la commande java -jar :

-javaagent:/chemin/vers/agent-java-dd.jar

Remarque :

• Le -javaagent doit être exécuté avant le fichier -jar en l’ajoutant en tant qu’option JVM et non en tant qu’argument d’application. Pour en savoir plus, consultez la documentation Oracle.

• Les artefacts de dd-trace-java (dd-java-agent.jar, dd-trace-api.jar, dd-trace-ot.jar) prennent en charge tous les langages basés sur JVM, tels que Scala, Groovy, Kotlin, Clojure, etc. Si vous avez besoin d’utiliser un framework spécifique, pensez à effectuer une contribution open source.

Instrumentation automatique

L’instrumentation automatique pour Java utilise les fonctionnalités d’instrumentation java-agent fournies par JVM. Lorsqu’un java-agent est enregistré, celui-ci a la capacité de modifier les fichiers de classe durant le chargement. Le java-agent utilise le framework Byte Buddy pour trouver les classes définies pour l’instrumentation et modifier ces octets de classe en conséquence.

L’instrumentation peut provenir de l’instrumentation automatique, de l’API OpenTracing ou d’un mélange des deux. L’instrumentation capture généralement les informations suivantes :

• La durée est capturée à l’aide de l’horloge nanoseconde de JVM, sauf si un horodatage est fourni à partir de l’API OpenTracing
• Les paires de tags clé/valeur
• Les erreurs et les traces de pile non gérées par l’application
• Le nombre total de traces (requêtes) transmises via le système

Compatibilité

Datadog prend officiellement en charge l’environnement Java JRE 1.7 et versions ultérieures d’Oracle JDK et OpenJDK. Datadog ne prend pas officiellement en charge toute version de Java en accès anticipé.

Intégrations

La plupart des intégrations sont activées par défaut. Le paramètre suivant peut être utilisé pour les désactiver par défaut.

• Propriété système : -Ddd.integrations.enabled=false
• Variable d’environnement : DD_INTEGRATIONS_ENABLED=false

Les intégrations peuvent être activées ou désactivées individuellement (ce qui remplace le paramètre par défaut ci-dessus).

• System Property: -Ddd.integration.<NOM_INTÉGRATION>.enabled=true
• Variable d’environnement : DD_INTEGRATION_<NOM_INTÉGRATION>_ENABLED=true

(Le nom de chaque intégration est affiché ci-dessous.)

Les intégrations bêta sont désactivées par défaut, mais peuvent être activées individuellement.

Compatibilité des frameworks Web

dd-java-agent prend en charge le tracing automatique des frameworks Web suivants :

Le tracing de frameworks Web permet : le calcul du délai entre la requête HTTP et la réponse, l’application de tags à la requête HTTP (code de statut, méthode, etc.), la capture des erreurs et des traces de pile, la mise en corrélation des requêtes Web avec les opérations en backend ainsi que la mise en place d’un tracing distribué.

Remarque : de nombreux serveurs d’applications sont compatibles avec les servlets et sont automatiquement couverts par cette instrumentation. C’est le cas de Tomcat, Jetty, Websphere, Weblogic, etc. En outre, certains frameworks comme Spring Boot sont automatiquement pris en charge car ils utilisent généralement un serveur d’applications intégré compatible avec les servlets (Tomcat/Jetty/Netty).

Les instrumentations en version bêta sont désactivées par défaut. Pour les activer, ajoutez l’une des configurations suivantes :

• System Property: -Ddd.integration.<NOM_INTÉGRATION>.enabled=true
• Variable d’environnement : DD_INTEGRATION_<NOM_INTÉGRATION>_ENABLED=true

Vos frameworks Web préférés ne sont pas disponibles ? Datadog élargit continuellement la liste des frameworks pris en charge. Contactez l’assistance Datadog si vous avez besoin d’aide.

Compatibilité des frameworks réseau

dd-java-agent prend en charge le tracing automatique des frameworks réseau suivants :

Le tracing de frameworks réseau permet : le calcul du délai entre la requête et la réponse, l’application de tags à la requête (par exemple le code de réponse), la capture des erreurs et des traces de pile, ainsi que la mise en place d’un tracing distribué.

Votre framework réseau préféré n’est pas disponible ? Datadog élargit continuellement la liste des frameworks pris en charge. Contactez l’assistance Datadog si vous avez besoin d’aide.

Compatibilité des datastores

dd-java-agent prend en charge le tracing automatique des frameworks/pilotes de base de données suivants :

dd-java-agent est également compatible avec les pilotes JDBC courants, notamment :

• Apache Derby
• Firebird SQL
• Moteur de base de données H2
• HSQLDB
• IBM DB2
• MariaDB
• MSSQL (Microsoft SQL Server)
• MySQL
• Oracle
• Postgres SQL

Le tracing de datastores permet : le calcul du délai entre la requête et la réponse, la récupération des informations sur la requête (par exemple, la chaîne de requête expurgée) ainsi que la capture des erreurs et des traces de pile.

Vos datastores préférés ne sont pas disponibles ? Datadog élargit continuellement la liste des datastores pris en charge. Contactez l’assistance Datadog si vous avez besoin d’aide.

Compatibilité avec les autres frameworks

dd-java-agent prend en charge le tracing automatique des frameworks suivants :

Votre framework préféré n’est pas disponible ? Datadog élargit continuellement la liste des frameworks pris en charge. Contactez l’assistance Datadog si vous avez besoin d’aide.

Pour profiter d’une meilleure visibilité sur vos applications utilisant des frameworks non pris en charge, vous pouvez :

• Ajouter une instrumentation personnalisée (avec OpenTracing ou l’annotation @Trace)
• Envoyer une pull request avec l’instrumentation en vue de son ajout dans une version future
• Contacter l’assistance Datadog et envoyer une demande d’ajout de fonctionnalité

Configuration

Le traceur est configuré à l’aide des propriétés système et des variables d’environnement comme suit : (Voir la configuration spécifique de l’intégration dans la section Intégrations ci-dessus.)

Remarques :

• Si le même type de clé est défini pour les deux, la configuration de la propriété système est prioritaire.
• Les propriétés système peuvent être utilisées comme paramètres JVM.
• Par défaut, les métriques JMX de votre application sont envoyées à l’Agent Datadog via DogStatsD sur le port 8125. Vérifiez que DogStatsD est activé pour l’Agent. Si vous exécutez l’Agent en tant que conteneur, vérifiez que DD_DOGSTATSD_NON_LOCAL_TRAFFIC est définie sur true et que le port 8125 est ouvert sur le conteneur de l’Agent. Dans Kubernetes, liez le port DogStatsD à un port de host ; dans ECS, définissez les flags adéquats dans la définition de votre tâche.

Exemples de configuration

dd.trace.enabled

Exemple avec une propriété système et le mode app de debugging

java -javaagent:/chemin/vers/agent-dd-java.jar -Ddd.trace.enabled=false -Ddatadog.slf4j.simpleLogger.defaultLogLevel=debug -jar chemin/vers/application.jar

Les logs de l’app de debugging indiquent, avec le message Tracing is disabled, not installing instrumentations, que le tracing est désactivé et qu’aucune instrumentation n’est en cours d’installation.

dd.service.name

Exemple avec une propriété système

java -javaagent:/chemin/vers/agent-dd-java.jar -Ddd.service.name=web-app -jar chemin/vers/application.jar

dd.service.mapping

Exemple avec une propriété système

java -javaagent:/chemin/vers/agent-dd-java.jar -Ddd.service.name=web-app -Ddd.service.mapping=postgresql:web-app-pg -jar chemin/vers/application.jar

dd.trace.global.tags

Configuration d’un environnement global pour les spans et les métriques JMX

java -javaagent:/chemin/vers/agent-dd-java.jar -Ddd.service.name=web-app -Ddd.trace.global.tags=env:dev -jar chemin/vers/application.jar

dd.trace.span.tags

Exemple d’ajout de project:test à chaque span

java -javaagent:/chemin/vers/agent-java-dd.jar -Ddd.service.name=web-app -Ddd.trace.global.tags=env:dev -Ddd.trace.span.tags=project:test -jar chemin/vers/application.jar

dd.trace.jmx.tags

Définition de custom.type:2 sur une métrique JMX

java -javaagent:/chemin/vers/agent-dd-java.jar -Ddd.service.name=web-app -Ddd.trace.global.tags=env:dev -Ddd.trace.span.tags=project:test -Ddd.trace.jmx.tags=custom.type:2 -jar chemin/vers/application.jar

dd.trace.methods

Exemple avec une propriété système

java -javaagent:/chemin/vers/agent-dd-java.jar -Ddd.trace.global.tags=env:dev -Ddd.service.name=web-app -Ddd.trace.methods=notes.app.NotesHelper[customMethod3] -jar chemin/vers/application.jar

dd.trace.db.client.split-by-instance

Exemple avec une propriété système :

java -javaagent:/chemin/vers/agent-dd-java.jar -Ddd.trace.global.tags=env:dev -Ddd.service.name=web-app -Ddd.trace.db.client.split-by-instance=TRUE -jar chemin/vers/application.jar

L’instance de base de données 1, webappdb, possède désormais son propre nom de service, le même que celui indiqué dans les métadonnées de span db.instance :

L’instance de base de données 2, secondwebappdb, possède désormais son propre nom de service, le même que celui indiqué dans les métadonnées de span db.instance :

De même, sur la service map, une app Web appelle désormais deux bases de données Postgres distinctes.

dd.http.server.tag.query-string

Exemple avec une propriété système :

java -javaagent:/chemin/vers/agent-dd-java.jar -Ddd.service.name=web-app -Ddd.trace.global.tags=env:dev -Ddd.http.server.tag.query-string=TRUE -jar chemin/vers/application.jar

Extraction et injection d’en-têtes B3

Le traceur de l’APM Datadog prend en charge l’extraction et l’injection d’en-têtes B3 pour le tracing distribué.

L’injection et l’extraction distribuées d’en-têtes sont contrôlées en configurant des styles d’injection/extraction. Deux styles sont actuellement pris en charge :

• Datadog : Datadog
• B3 : B3

Les styles d’injection peuvent être configurés via :

• Propriété système : -Ddd.propagation.style.inject=Datadog,B3
• Variable d’environnement : DD_PROPAGATION_STYLE_INJECT=Datadog,B3

La valeur de la propriété ou de la variable d’environnement est une liste de styles d’en-tête séparés par des virgules (ou des espaces) qui sont activés pour l’injection. Par défaut, seul le style d’injection Datadog est activé.

Les styles d’extraction peuvent être configurés via :

• Propriété système : -Ddd.propagation.style.extract=Datadog,B3
• Variable d’environnement : DD_PROPAGATION_STYLE_EXTRACT=Datadog,B3

La valeur de la propriété ou de la variable d’environnement est une liste de styles d’en-tête séparés par des virgules (ou des espaces) qui sont activés pour l’extraction. Par défaut, seul le style d’extraction Datadog est activé.

Si plusieurs styles d’extraction sont activés, une tentative d’extraction est effectuée dans l’ordre selon lequel ces styles ont été configurés, et la première valeur extraite avec succès est utilisée.

Transmission de traces

Voici à quoi ressemble le processus de transmission de trace à Datadog :

• La trace est recueillie.
• La trace est transférée dans une file d’attente asynchrone de traces.
  • La file d’attente présente une limite fixe de 7 000 traces.
  • Une fois la limite atteinte, les traces sont supprimées.
  • Le nombre total de traces est capturé pour assurer l’intégrité des données.
• Dans un thread de transmission distinct, la file d’attente de traces est vidée et les traces sont codées via msgpack, puis envoyées à l’Agent Datadog via http.
• La file d’attente est vidée toutes les secondes.

Pour voir le code utilisé, la documentation ou des exemples d’utilisation des bibliothèques et frameworks pris en charge par Datadog, consultez la liste complète des composants à instrumentation automatique pour les applications Java dans la section Intégrations.

Annotation de trace

Ajoutez la dépendance dd-trace-api à votre projet. Pour Maven, ajoutez ce qui suit à pom.xml :

<dependency>
    <groupId>com.datadoghq</groupId>
    <artifactId>dd-trace-api</artifactId>
    <version>{version}</version>
</dependency>

Pour Gradle, ajoutez :

compile group: 'com.datadoghq', name: 'dd-trace-api', version: {version}

Ajoutez maintenant @Trace aux méthodes pour permettre leur tracing lors d’une exécution avec dd-java-agent.jar. Si l’Agent n’est pas associé, cette annotation n’a aucun effet sur votre application.

Les annotations @Trace prennent le nom d’opération par défaut trace.annotation, tandis que la méthode tracée prend la ressource par défaut.

Performances

L’APM Java a un impact minimal sur la charge d’une application :

• Toutes les collectes assurées par l’APM Java sont soumises à des limites de mémoire
• La transmission de traces ne bloque pas le thread de l’application
• L’APM Java charge des classes supplémentaires pour la collecte de traces et l’instrumentation de la bibliothèque
• L’APM Java entraîne généralement une augmentation de la charge processeur inférieure à 3 %
• L’APM Java entraîne généralement une augmentation de la charge mémoire de JVM inférieure à 3 %

Modifier le hostname de l’Agent

Configurez vos traceurs d’applications de façon à envoyer des traces à un hostname d’Agent personnalisé :

Le module de tracing Java recherche automatiquement les variables ENV DD_AGENT_HOST et DD_TRACE_AGENT_PORT et s’initialise avec celles-ci.

java -javaagent:<CHEMIN-AGENT-JAVA-DD>.jar -jar <CHEMIN_VOTRE_APPLICATION>.jar

Vous pouvez également utiliser des propriétés système :

java -javaagent:<CHEMIN-AGENT-JAVA-DD>.jar \
     -Ddd.agent.host=$DD_AGENT_HOST \
     -Ddd.agent.port=$DD_TRACE_AGENT_PORT \
     -jar <CHEMIN_VOTRE_APPLICATION>.jar

Pour aller plus loin

Documentation, liens et articles supplémentaires utiles:

Code source de l'APM Datadog JavaGITHUB Explorer vos services, ressources et tracesDOCUMENTATION Utilisation avancéeUTILISATION AVANCÉE