Instrumentation de lʼapplication

Aperçu

Application Instrumentation is the process of adding code to your application to capture and report observability data to Datadog, such as traces, metrics, and logs.Glossary avec Datadog APM implique :

  1. Configuration du SDK : Ajout d’un SDK Datadog à votre application.

  2. Création de spans : Capturer des données d’observabilité sous forme de spans.

    Les spans sont générés automatiquement par défaut dès que le SDK est chargé. Ceci est connu sous le nom de auto-instrumentation et fournit une visibilité suffisante pour la plupart des utilisateurs. Si vous avez besoin de plus de contrôle, vous pouvez ajouter des spans personnalisés en option.

Remarque : Ces étapes supposent que vous avez un Agent Datadog installé et configuré pour recevoir des traces.

Le pipeline APM

Commencer

Préférez-vous une instrumentation neutre vis-à-vis des fournisseurs ? Consultez la documentation OpenTelemetry pour utiliser OpenTelemetry avec Datadog.

Instrumentation en une seule étape (SSI) installe et configure automatiquement les SDK Datadog avec une seule commande. L’auto-instrumentation commence alors immédiatement à capturer des traces de vos frameworks et bibliothèques pris en charge, sans nécessiter de modifications de code.


Configuration manuelle et spans personnalisés

À mesure que vos besoins en matière d’observabilité augmentent, vous pouvez ajouter plus de contrôle et de personnalisation :

Pour un contrôle complet de la configuration du SDK : Utilisez les SDK Datadog gérés manuellement si vous avez besoin d’un contrôle granulaire sur le comportement et la configuration du SDK.


Pour des spans personnalisés sans modifications de code : Utilisez l’instrumentation dynamique pour créer des spans personnalisés depuis l’interface utilisateur de Datadog sans redéployer votre application.


Pour des spans personnalisés dans le code : Ajoutez une instrumentation personnalisée basée sur le code pour instrumenter la logique métier personnalisée ou ajouter des métadonnées spécifiques à l’application aux spans.


Ces options peuvent être combinées. Par exemple, vous pouvez commencer avec l’instrumentation en une seule étape et ajouter une instrumentation personnalisée basée sur le code pour des spans spécifiques, ou utiliser des SDK Datadog gérés manuellement avec l’instrumentation dynamique pour ajouter des spans sans déploiement.

Comparaison détaillée

Configuration du SDK

L’instrumentation en une seule étape est le point de départ recommandé pour la plupart des utilisateurs. Si vous avez besoin de plus de contrôle sur la configuration du SDK, vous pouvez utiliser des SDK gérés manuellement à la place :

L'instrumentation en une seule étape (recommandée)SDK gérés manuellement
Comment cela fonctionneDatadog installe et charge automatiquement les SDK dans vos processus d'application, au moment de l'exécution, avec une seule commande.Vous installez et configurez les SDK directement dans votre code d'application ou votre processus de construction.
Changements de code ?NonOui
Complexité de configurationFaible - configuration minimale requiseMoyenne - nécessite une configuration d'environnement et de construction
Contrôle de configurationValeurs par défaut standard avec options de remplacementContrôle total via des variables d'environnement et du code
Quand utiliserCommencez ici pour une instrumentation rapide et cohérente à travers les services sans nécessiter de modifications de code.Progressez vers cela lorsque vous avez besoin d'un contrôle granulaire sur le comportement et la configuration des SDK.

Personnalisation des spans

L’auto-instrumentation crée automatiquement des spans pour les frameworks et bibliothèques pris en charge, fournissant une observabilité essentielle sans travail supplémentaire. Lorsque vous avez besoin de visibilité sur des chemins de code personnalisés ou que vous souhaitez enrichir les traces avec des données spécifiques à l’application, vous pouvez ajouter des spans personnalisés en utilisant soit l’instrumentation dynamique, soit l’instrumentation personnalisée basée sur le code :

Instrumentation dynamiqueInstrumentation personnalisée basée sur le code
Comment cela fonctionneConfigurez les règles d'instrumentation dans l'interface utilisateur de Datadog ; les règles sont appliquées au moment de l'exécution.Ajoutez des appels d'API de traçage explicites dans le code de votre application.
Changements de code ?NonOui
Déploiement requisNonOui (pour ajouter ou modifier des spans)
Quand utiliserAjoutez des spans personnalisés sans modifications de code ni redéploiements.Progressez vers cela lorsque vous avez besoin d'une logique d'instrumentation complexe ou souhaitez que les spans soient définis de manière permanente dans le code.

Tutoriels de configuration APM

Les tutoriels suivants vous guident à travers la configuration du traçage distribué pour une application d’exemple dans divers scénarios d’infrastructure, avec à la fois une instrumentation automatique et personnalisée :


Lecture complémentaire