Après avoir configuré la bibliothèque de tracing avec votre code ainsi que l’Agent de façon à recueillir des données APM, vous pouvez ajuster sa configuration selon vos besoins, notamment en configurant le tagging de service unifié.
Toutes les options de configuration ci-dessous ont une propriété système et une variable d’environnement équivalentes. 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 définies en tant que flags JVM.
Remarque : si vous utilisez les propriétés système du traceur Java, assurez-vous de les spécifier avant -jar, afin qu’elles soient lues en tant qu’options JVM.
dd.serviceDD_SERVICEunnamed-java-appdd.tagsDD_TAGSnulllayer:api,team:intakedd.envDD_ENVnonedd.versionDD_VERSIONnulldd.logs.injectionDD_LOGS_INJECTIONtruedd.trace.configDD_TRACE_CONFIGnull-Ddd.trace.config=<CHEMIN_FICHIER>.properties, en définissant le nom du service dans le fichier avec dd.service=<NOM_SERVICE>.dd.service.mappingDD_SERVICE_MAPPINGnullmysql:my-mysql-service-name-db, postgres:my-postgres-service-name-dbdd.writer.typeDD_WRITER_TYPEDDAgentWriterLoggingWriter dans votre configuration, les traces sont écrites dans la console.dd.agent.hostDD_AGENT_HOSTlocalhostdd.trace.agent.portDD_TRACE_AGENT_PORT8126dd.trace.agent.unix.domain.socketDD_TRACE_AGENT_UNIX_DOMAIN_SOCKETnulldd.trace.agent.urlDD_TRACE_AGENT_URLnullhttp:// pour une connexion via HTTP ou par unix:// pour connexion via un socket de domaine Unix. Une fois cette option définie, elle a la priorité sur DD_AGENT_HOST et DD_TRACE_AGENT_PORT. Disponible à partir de la version 0.65.dd.trace.agent.timeoutDD_TRACE_AGENT_TIMEOUT10dd.trace.header.tagsDD_TRACE_HEADER_TAGSnullCASE-insensitive-Header:my-tag-name,User-ID:userId,My-Header-And-Tag-Namehttp.request.headers.<nom_en-tête> et http.response.headers.<nom_en-tête>, respectivement.-Ddd.trace.header.tags.legacy.parsing.enabled=true ou la variable d’environnement DD_TRACE_HEADER_TAGS_LEGACY_PARSING_ENABLED=true.dd.trace.request_header.tagsDD_TRACE_REQUEST_HEADER_TAGSnullCASE-insensitive-Header:my-tag-name,User-ID:userId,My-Header-And-Tag-Namehttp.request.headers.<nom_en-tête>.dd.trace.response_header.tagsDD_TRACE_RESPONSE_HEADER_TAGSnullCASE-insensitive-Header:my-tag-name,User-ID:userId,My-Header-And-Tag-Namehttp.response.headers.<nom_en-tête>.dd.trace.annotationsDD_TRACE_ANNOTATIONScom.some.Trace;io.other.Trace@Trace.dd.trace.methodsDD_TRACE_METHODSnullpackage.ClassName[method1,method2,...];AnonymousClass$1[call];package.ClassName[*]@Trace, mais sans changer le code. Remarque : l’utilisation d’un wildcard ([*]) ne prend pas en compte les appels de méthode constructors, getters, setters, synthetic, toString, equals, hashcode ou finalizer.dd.trace.classes.excludeDD_TRACE_CLASSES_EXCLUDEnullpackage.ClassName,package.ClassName$Nested,package.Foo*,package.other.*dd.trace.partial.flush.min.spansDD_TRACE_PARTIAL_FLUSH_MIN_SPANS1000dd.trace.split-by-tagsDD_TRACE_SPLIT_BY_TAGSnullaws.servicedd.trace.db.client.split-by-instanceDD_TRACE_DB_CLIENT_SPLIT_BY_INSTANCEfalsetrue, les spans de base de données reçoivent le nom de l’instance en tant que nom du service.dd.trace.health.metrics.enabledDD_TRACE_HEALTH_METRICS_ENABLEDtruetrue, des métriques de santé sur le traceur sont envoyées.dd.trace.health.metrics.statsd.hostDD_TRACE_HEALTH_METRICS_STATSD_HOSTdd.jmxfetch.statsd.hostdd.trace.health.metrics.statsd.portDD_TRACE_HEALTH_METRICS_STATSD_PORTdd.jmxfetch.statsd.portdd.http.client.tag.query-stringDD_HTTP_CLIENT_TAG_QUERY_STRINGfalsetrue, les paramètres de chaîne de requête et le fragment sont ajoutés aux spans du client Web.dd.http.client.error.statusesDD_HTTP_CLIENT_ERROR_STATUSES400-499dd.http.client.error.statuses=400-403,405,410-499.dd.http.server.error.statusesDD_HTTP_SERVER_ERROR_STATUSES500-599dd.http.server.error.statuses=500,502-599.dd.http.server.tag.query-stringDD_HTTP_SERVER_TAG_QUERY_STRINGfalsetrue, les paramètres de chaîne de requête et le fragment sont ajoutés aux spans du serveur Web.dd.trace.enabledDD_TRACE_ENABLEDtruefalse, l’Agent de tracing est désactivé.dd.jmxfetch.enabledDD_JMXFETCH_ENABLEDtruedd.jmxfetch.config.dirDD_JMXFETCH_CONFIG_DIRnull/chemin/vers/répertoire/etc/conf.djvm_direct:true dans la section instance du fichier yaml pour changer la configuration.dd.jmxfetch.configDD_JMXFETCH_CONFIGnullchemin/vers/fichier/conf.yaml,autre/chemin/vers/fichier/conf.yamljvm_direct:true dans la section instance du fichier yaml pour changer la configuration.dd.jmxfetch.check-periodDD_JMXFETCH_CHECK_PERIOD1500dd.jmxfetch.refresh-beans-periodDD_JMXFETCH_REFRESH_BEANS_PERIOD600dd.jmxfetch.statsd.hostDD_JMXFETCH_STATSD_HOSTagent.hostunix:///var/datadog-agent/dsd.socket.dd.jmxfetch.statsd.portDD_JMXFETCH_STATSD_PORT8125dd.integration.opentracing.enabledDD_INTEGRATION_OPENTRACING_ENABLEDtruedd.hystrix.tags.enabledDD_HYSTRIX_TAGS_ENABLEDfalsedd.trace.servlet.async-timeout.errorDD_TRACE_SERVLET_ASYNC_TIMEOUT_ERRORtruedd.trace.startup.logsDD_TRACE_STARTUP_LOGStruefalse, les logs de lancement informatifs sont désactivés. Disponible à partir de la version 0.64.dd.trace.servlet.principal.enabledDD_TRACE_SERVLET_PRINCIPAL_ENABLEDfalsetrue, l’objet principal utilisateur est recueilli. Disponible à partir de la version 0.61.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.
DD_DOGSTATSD_NON_LOCAL_TRAFFIC est défini sur true et que le port 8125 est ouvert sur le conteneur de l’Agent.Pour découvrir comment désactiver des intégrations, consultez la section relative à la compatibilité des intégrations.
dd.service.mappingExemple avec une propriété système :
java -javaagent:/chemin/vers/dd-java-agent.jar -Ddd.service=web-app -Ddd.service.mapping=postgresql:web-app-pg -jar chemin/vers/application.jar
dd.tagsConfiguration d’un environnement global pour les spans et les métriques JMX :
java -javaagent:/chemin/vers/dd-java-agent.jar -Ddd.service=web-app -Ddd.env=dev -jar chemin/vers/application.jar
dd.trace.span.tagsExemple d’ajout de project:test à chaque span :
java -javaagent:/chemin/vers/dd-java-agent.jar -Ddd.service=web-app -Ddd.env=dev -Ddd.trace.span.tags=project:test -jar chemin/vers/application.jar
dd.trace.jmx.tagsDéfinition de custom.type:2 sur une métrique JMX :
java -javaagent:/chemin/vers/dd-java-agent.jar -Ddd.service=web-app -Ddd.env=dev -Ddd.trace.span.tags=project:test -Ddd.trace.jmx.tags=custom.type:2 -jar chemin/vers/application.jar
dd.trace.methodsExemple avec une propriété système :
java -javaagent:/chemin/vers/agent-java-dd.jar -Ddd.service=web-app -Ddd.env=dev -Ddd.trace.methods="hello.GreetingController[doSomeStuff,doSomeOtherStuff];hello.Randomizer[randomize]" -jar chemin/vers/application.jar
dd.trace.db.client.split-by-instanceExemple avec une propriété système :
java -javaagent:/chemin/vers/dd-java-agent.jar -Ddd.env=dev -Ddd.service=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-stringExemple avec une propriété système :
java -javaagent:/chemin/vers/dd-java-agent.jar -Ddd.service=web-app -Ddd.env=dev -Ddd.http.server.tag.query-string=TRUE -jar chemin/vers/application.jar
dd.trace.enabledExemple avec une propriété système et le mode debugging d’app
java -javaagent:/chemin/vers/agent-java-dd.jar -Ddd.trace.enabled=false -Ddatadog.slf4j.simpleLogger.defaultLogLevel=debug -jar chemin/vers/application.jar
Les logs de debugging d’app 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.jmxfetch.config.dir et dd.jmxfetch.configExemple de configuration :
DD_JMXFETCH_CONFIG_DIR=<CHEMIN_RÉPERTOIRE> + DD_JMXFETCH_CONFIG=conf.yamlDD_JMXFETCH_CONFIG=<CHEMIN_RÉPERTOIRE>/conf.yamlAvec le contenu suivant pour conf.yaml :
init_config:
instances:
- jvm_direct: true
port: '<PORT>'
conf:
- include:
bean:
- java.lang:type=MemoryPool,name=Metaspace
attribute:
Usage.used:
metric_type: gauge
alias: sb.usage.used
On obtient le résultat suivant :
Consultez la documentation relative à l’intégration Java pour en savoir plus sur la collecte de métriques Java avec JMXFetch.
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 :
DatadogB3Les styles d’injection peuvent être configurés via :
-Ddd.propagation.style.inject=Datadog,B3DD_PROPAGATION_STYLE_INJECT=Datadog,B3La propriété ou la variable d’environnement prend pour valeur 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 :
-Ddd.propagation.style.extract=Datadog,B3DD_PROPAGATION_STYLE_EXTRACT=Datadog,B3La propriété ou la variable d’environnement prend pour valeur 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.
Documentation, liens et articles supplémentaires utiles:
