Associer vos logs Python à vos traces

Injection automatique d’ID de trace

Activez l’injection avec la variable d’environnement DD_LOGS_INJECTION=true lorsque vous utilisez ddtrace-run.

Remarque : l’auto-injection prend en charge la bibliothèque standard logging, ainsi que toutes les bibliothèques qui complètent le module de bibliothèque standard, comme la bibliothèque json_log_formatter. ddtrace-run appelle logging.basicConfig avant l’exécution de votre application. Si le logger racine possède un gestionnaire configuré, votre application doit modifier directement le logger racine et le gestionnaire.

Injection manuelle d’ID de trace

Avec le module Logging de la bibliothèque standard

Si vous préférez corréler manuellement vos traces avec vos logs, patchez votre module logging en modifiant votre formateur de log de façon à inclure les attributs dd.trace_id et dd.span_id à partir de l’entrée de log.

La configuration ci-dessous est utilisée par la méthode d’injection automatique et prise en charge par défaut par l’intégration de log Python :

from ddtrace import patch_all; patch_all(logging=True)
import logging
from ddtrace import tracer

FORMAT = ('%(asctime)s %(levelname)s [%(name)s] [%(filename)s:%(lineno)d] '
          '[dd.trace_id=%(dd.trace_id)s dd.span_id=%(dd.span_id)s] '
          '- %(message)s')
logging.basicConfig(format=FORMAT)
log = logging.getLogger(__nom__)
log.level = logging.INFO

@tracer.wrap()
def hello():
    log.info('Hello, World!')

hello()

Sans le module Logging de la bibliothèque standard

Si vous n’utilisez pas le module logging de la bibliothèque standard, vous pouvez utiliser la commande ddtrace.helpers.get_correlation_ids() pour injecter les informations du traceur dans vos logs. Les exemples suivants illustrent cette approche, en définissant une fonction en tant que processeur dans structlog afin d’ajouter dd.trace_id et dd.span_id à la sortie de log :

from ddtrace.helpers import get_correlation_ids

import structlog

def tracer_injection(logger, log_method, event_dict):
    # obtenir les identifiants de corrélation à partir du contexte du traceur actuel
    trace_id, span_id = get_correlation_ids()

    # ajouter des identifiants au dictionnaire d'événement structlog
    # en l'absence de trace, définir les identifiants sur 0
    event_dict['dd.trace_id'] = trace_id or 0
    event_dict['dd.span_id'] = span_id or 0

    return event_dict

structlog.configure(
    processors=[
        tracer_injection,
        structlog.processors.JSONRenderer()
    ]
)
log = structlog.get_logger()

Une fois le logger configuré, si vous exécutez une fonction tracée qui logue un événement, vous obtenez les informations du traceur injecté :

>>> traced_func()
{"event": "In tracer context", "trace_id": 9982398928418628468, "span_id": 10130028953923355146}

Remarque : si vous n’utilisez pas une intégration de log de Datadog pour analyser vos logs, des règles de parsing de log personnalisées doivent s’assurer que dd.trace_id et dd.span_id sont analysés en tant que chaînes de caractères. Pour en savoir plus, consultez la FAQ à ce sujet.

Consultez la documentation relative à la journalisation Python pour vérifier que l’intégration de log Python est bien configurée et que vos logs Python sont automatiquement analysés.

Pour aller plus loin

Documentation, liens et articles supplémentaires utiles:

Instrumenter vos applications manuellement pour créer des tracesDOCUMENTATION Implémenter Opentracing dans vos applicationsDOCUMENTATION Explorer vos services, ressources et tracesDOCUMENTATION Corréler automatiquement des logs de requête avec des tracesBLOG