Débuter avec le tracing APM

Présentation

Datadog Application Performance Monitoring (APM) vous permet d’analyser vos applications en détail, et ainsi d’identifier les goulets d’étranglement, de résoudre les problèmes et d’optimiser vos services.

Ce guide explique comment bien débuter avec APM et envoyer votre première trace à Datadog :

  1. Configurez Datadog APM pour envoyer des traces à Datadog.
  2. Exécutez votre application pour générer des données.
  3. Explorez les données collectées dans Datadog.

Configurez APM avec un agent

Install the dd-apm skill in your AI coding agent for guided APM setup.
npx skills add https://github.com/datadog-labs/agent-skills --skill dd-apm --full-depth -y

Prérequis

Pour compléter ce guide, vous avez besoin des éléments suivants :

  1. Créez un compte Datadog si ce n’est pas déjà fait.
  2. Recherchez ou créez une clé d’API Datadog.
  3. Démarrez un host Linux ou une VM.

Créez une application

Pour créer une application à observer dans Datadog :

  1. Sur votre host Linux ou votre VM, créez une nouvelle application Python nommée hello.py. Par exemple, nano hello.py.

  2. Ajoutez le code suivant à hello.py :

    hello.py

      from flask import Flask
      import random
    
      app = Flask(__name__)
      
      quotes = [
          "Strive not to be a success, but rather to be of value. - Albert Einstein",
          "Believe you can and you're halfway there. - Theodore Roosevelt",
          "The future belongs to those who believe in the beauty of their dreams. - Eleanor Roosevelt"
      ]
      
      @app.route('/')
      def index():
          quote = random.choice(quotes)+"\n"
          return quote
      
      if __name__ == '__main__':
          app.run(host='0.0.0.0', port=5050)
      

Configurez Datadog APM

Pour configurer Datadog APM sans avoir à modifier le code de votre application ni le processus de déploiement, utilisez l’instrumentation APM en une étape. Vous pouvez aussi configurer la solution APM à l’aide des bibliothèques de traçage de Datadog.

  1. Exécutez la commande d’installation :

     DD_API_KEY=<YOUR_DD_API_KEY> DD_SITE="<YOUR_DD_SITE>" DD_APM_INSTRUMENTATION_ENABLED=host DD_APM_INSTRUMENTATION_LIBRARIES=python:4 DD_ENV=<AGENT_ENV> bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent7.sh)"
    

    Replace <YOUR_DD_API_KEY> with your Datadog API key, <YOUR_DD_SITE> with your Datadog site, and <AGENT_ENV> with the environment your Agent is installed on (for example, development).

  2. Redémarrez les services sur votre host ou votre VM.

  3. Vérifiez que l’Agent est en cours d’exécution :

    sudo datadog-agent status
    

Cette approche permet d’installer automatiquement le Datadog Agent, d’activer Datadog APM et d’instrumenter votre application au moment de l’exécution.

Exécutez l’application

Lorsque vous configurez Datadog APM avec l’instrumentation en une étape, Datadog instrumente automatiquement votre application au moment de l’exécution.

Pour exécuter hello.py :

  1. Créez un environnement virtuel Python dans le répertoire actuel :

    python3 -m venv ./venv
    
  2. Activez l’venv environnement virtuel :

    source ./venv/bin/activate
    
  3. Installez pip et flask :

    sudo apt-get install python3-pip
    pip install flask
    
  4. Définissez le nom du service et exécutez hello.py :

    export DD_SERVICE=hello
    python3 hello.py
    

Testez l’application

Testez l’application pour envoyer des traces à Datadog :

  1. Dans une nouvelle invite de commande, exécutez ce qui suit :

    curl http://0.0.0.0:5050/
    
  2. Confirmez qu’une citation aléatoire est renvoyée.

    Believe you can and you're halfway there. - Theodore Roosevelt
    

Chaque fois que vous exécutez la commande curl, une nouvelle trace est envoyée à Datadog.

Explorez les traces dans Datadog

  1. Dans Datadog, accédez à APM > Services. Vous devriez voir un service Python nommé hello :

    Le Catalog affiche le nouveau service Python.
  2. Sélectionnez le service pour afficher ses métriques de performance, telles que la latence, le débit et les taux d’erreur.

  3. Accédez à APM > Traces. Vous devriez voir une trace pour le service hello :

    Trace Explorer affiche la trace pour le service hello.
  4. Sélectionnez une trace pour voir ses détails, y compris le graphique en flamme, qui aide à identifier les goulots d’étranglement de performance.

Configuration APM avancée

Jusqu’à présent, vous avez laissé Datadog instrumenter automatiquement l’application hello.py à l’aide de l’instrumentation en une seule étape. Cette approche est recommandée si vous souhaitez capturer des traces essentielles à travers les bibliothèques et langages courants sans toucher au code ni installer manuellement des bibliothèques.

Toutefois, si vous avez besoin de recueillir des traces à partir d’un code personnalisé ou si vous souhaitez un contrôle plus précis, vous pouvez ajouter l’instrumentation personnalisée.

Pour illustrer cela, vous allez importer le SDK Python de Datadog dans hello.py et créer un span personnalisé ainsi qu’un tag de span.

Pour ajouter des instrumentations personnalisées :

  1. Installez le SDK Datadog :

    pip install ddtrace
    
  2. Ajoutez les lignes en surbrillance au code dans hello.py pour créer un tag de span personnalisé get_quote et un tag de span personnalisé quote :

     from flask import Flask
     import random
     from ddtrace import tracer
    
     app = Flask(__name__)
    
     quotes = [
         "Strive not to be a success, but rather to be of value. - Albert Einstein",
         "Believe you can and you're halfway there. - Theodore Roosevelt",
         "The future belongs to those who believe in the beauty of their dreams. - Eleanor Roosevelt"
     ]
    
     @app.route('/')
     def index():
         with tracer.trace("get_quote") as span:
             quote = random.choice(quotes)+"\n"
             span.set_tag("quote", quote)
             return quote
    
     if __name__ == '__main__':
         app.run(host='0.0.0.0', port=5050)
  3. Exécutez hello.py dans l’environnement virtuel créé précédemment :

    ddtrace-run python hello.py
    
  4. Exécutez quelques commandes curl dans une invite de commande séparée :

    curl http://0.0.0.0:5050/
    
  5. Dans Datadog, accédez à APM > Traces.

  6. Sélectionnez la trace hello.

  7. Trouvez le nouveau span personnalisé get_quote dans le graphique en flamme et survolez-le :

    Le span personnalisé get_quote s'affiche dans le graphique en flamme. Au survol, le tag de span de citation est affiché.
  8. Remarquez que le tag de span personnalisé quote s’affiche sur l’onglet Info.

Quelle est la prochaine étape ?

Une fois le tracing configuré et votre application envoyant des données à Datadog, explorez les fonctionnalités APM supplémentaires :

Catalog

Catalog fournit une vue consolidée de vos services, combinant métadonnées de propriété, aperçus de performance, analyse de sécurité et répartition des coûts en un seul endroit. Configurez les métadonnées de service à l’aide de tags, d’annotations ou d’un fichier service.datadog.yaml pour enrichir vos services avec des informations de propriété, des runbooks et des liens de documentation.

Ingestion et rétention des traces

Contrôlez les coûts et gérez le volume de données en configurant des contrôles d’ingestion et des filtres de rétention. Les contrôles d’ingestion vous permettent de personnaliser les taux d’échantillonnage au niveau du Datadog Agent ou du SDK, tandis que les filtres de rétention déterminent quels spans sont indexés pour la recherche et l’analyse.

Pour aller plus loin