Le traceur .NET prend en charge l’instrumentation automatique sur .NET Framework 4.5 et ultérieur. Pour obtenir la liste complète des bibliothèques prises en charge, consultez la page Exigences de compatibilité.
Si vous avez déjà un compte Datadog, vous trouverez des instructions détaillées dans nos guides intégrés à l’application pour les configurations basées sur un host et les configurations basées sur un conteneur.
Sinon, pour commencer le tracing d’applications écrites dans n’importe quel langage, commencez par installer et configurer l’Agent Datadog. Le traceur .NET instrumente vos applications et envoie leurs traces à l’Agent en s’exécutant au sein du processus.
Remarque : le traceur .NET prend en charge tous les langages basés sur .NET (C#, F#, Visual Basic, etc.).
Avec l’instrumentation automatique, vous pouvez recueillir des données de performance sur votre application sans avoir à modifier son code. Il vous suffit juste de configurer quelques options. Le traceur .NET est prêt à l’emploi : il instrumente automatiquement toutes les bibliothèques prises en charge.
L’instrumentation automatique capture :
Pour appliquer l’instrumentation automatique sur Windows, installez le traceur .NET sur le host à l’aide du programme d’installation MSI pour Windows. Choisissez le programme d’installation correspondant à l’architecture de votre système d’exploitation (x64 ou x86).
Une fois le traceur .NET installé, redémarrez les applications de sorte qu’elles puissent lire les nouvelles variables d’environnement. Pour redémarrer IIS, exécutez les commandes suivantes en tant qu’administrateur :
net stop /y was
net start w3svc
Si votre application fonctionne dans IIS, passez directement à la section suivante.
Pour les applications Windows ne fonctionnant pas dans IIS, définissez les deux variables d’environnement suivantes avant de démarrer votre application pour activer l’instrumentation automatique :
Remarque : le runtime .NET tente de charger un profileur dans n’importe quel processus .NET démarré lorsque ces variables d’environnement sont définies. Assurez-vous de limiter l’instrumentation aux applications devant être tracées. Nous vous déconseillons de définir ces variables d’environnement globalement, au risque d’activer le chargement du profileur par tous les processus .NET sur le host.
| Nom | Valeur |
|---|---|
COR_ENABLE_PROFILING | 1 |
COR_PROFILER | {846F5F1C-F9AE-4B07-969E-05C26BC060D8} |
Pour instrumenter automatiquement un service Windows, définissez les variables d’environnement pour ce service dans le registre Windows. Créez une valeur multi-chaînes appelée Environment dans la clé HKLM\System\CurrentControlSet\Services\<NOM_SERVICE>. Ensuite, définissez les données de la clé sur les valeurs du tableau comme suit :
COR_ENABLE_PROFILING=1
COR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
Vous pouvez utiliser l’éditeur de registre comme dans l’image ci-dessous ou passer par PowerShell :
add-env-var.ps1
[String[]] $v = @("COR_ENABLE_PROFILING=1", "COR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}")
Set-ItemProperty HKLM:SYSTEM\CurrentControlSet\Services\<NOM> -Name Environment -Value $vDéfinissez les variables d’environnement à partir d’un fichier batch avant de démarrer votre application :
rem Définir des variables d'environment
SET COR_ENABLE_PROFILING=1
SET COR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
rem Démarrer l'application
example.exe
Pour instrumenter manuellement votre code, ajoutez le paquet NuGet Datadog.Trace à votre application. Dans votre code, accédez au traceur global via la propriété Datadog.Trace.Tracer.Instance pour créer de nouvelles spans.
Pour en savoir plus sur l’instrumentation manuelle et l’application de tags personnalisés, consultez la documentation relative à l’instrumentation manuelle.
L’instrumentation manuelle est prise en charge pour .NET Framework 4.5 et ultérieur sur Windows, ainsi que pour .NET Core 2.1, 3.0 et 3.1 sur Windows et Linux.
Remarque : lorsque vous utilisez à la fois l’instrumentation manuelle et l’instrumentation automatique, il est essentiel de veiller à ce que les versions du package NuGet et du programme d’installation MSI correspondent.
Il existe plusieurs façons de configurer le traceur .NET :
app.config/web.config de l’application (.NET Framework uniquement) ;datadog.json.Pour configurer le traceur à l’aide de variables d’environnement, définissez-les avant le lancement de l’application instrumentée.
Par exemple :
rem Définir les variables d'environnement
SET DD_TRACE_AGENT_URL=http://localhost:8126
SET DD_ENV=prod
SET DD_SERVICE=MyService
SET DD_VERSION=abc123
rem Lancer l'application
example.exe
Remarque : pour définir les variables d’environnement pour un service Windows, utilisez la clé multi-chaînes HKLM\System\CurrentControlSet\Services\{nom du service}\Environment dans le registre Windows.
Pour configurer le traceur dans le code de l’application, créez un TracerSettings à partir des sources de configuration par défaut. Définissez les propriétés de cette instance TracerSettings avant de la transmettre à un constructeur Tracer. Par exemple :
using Datadog.Trace;
// lire les sources de configuration par défaut (variables d'environnement, web.config, datadog.json)
var settings = TracerSettings.FromDefaultSources();
// modifier certains paramètres
settings.Environment = "prod";
settings.ServiceName = "MyService";
settings.ServiceVersion = "abc123";
settings.AgentUri = new Uri("http://localhost:8126/");
// créer un nouveau traceur à l'aide de ces paramètres
var tracer = new Tracer(settings);
// définir le traceur global
Tracer.Instance = tracer;
Remarque : les paramètres de TracerSettings doivent être définis avant la création du Tracer. Toute modification apportée aux propriétés de TracerSettings après la création du Tracer sera ignorée.
Pour configurer le traceur à l’aide d’un fichier app.config ou web.config, utilisez la section <appSettings>. Par exemple :
<configuration>
<appSettings>
<add key="DD_TRACE_AGENT_URL" value="http://localhost:8126"/>
<add key="DD_ENV" value="prod"/>
<add key="DD_SERVICE" value="MyService"/>
<add key="DD_VERSION" value="abc123"/>
</appSettings>
</configuration>
Pour configurer le traceur à l’aide d’un fichier JSON, créez datadog.json dans le répertoire de l’application instrumentée. L’objet JSON racine doit être un hash avec une paire key/value pour chaque paramètre. Par exemple :
{
"DD_TRACE_AGENT_URL": "http://localhost:8126",
"DD_ENV": "prod",
"DD_SERVICE": "MyService",
"DD_VERSION": "abc123",
}
Le tableau suivant énumère les variables de configuration prises en charge. Utilisez le premier nom (p. ex., DD_TRACE_AGENT_URL) pour les variables d’environnement ou les fichiers de configuration. Lorsqu’il est précisé, le deuxième nom (p. ex., AgentUri) correspond au nom de la propriété de TracerSettings à utiliser lors du changement des paramètres dans le code.
| Nom du paramètre | Description |
|---|---|
DD_ENVEnvironment | Lorsqu’il est défini, ce paramètre ajoute le tag env avec la valeur spécifiée à toutes les spans générées. Consultez la documentation relative à la [configuration de l’Agent][8] pour en savoir plus sur le tag env. Disponible pour les versions 1.17.0+ |
DD_SERVICEServiceName | Lorsqu’il est spécifié, ce paramètre définit le nom du service. Sinon, le traceur .NET tente de déterminer automatiquement le nom du service à partir du nom de l’application (p. ex. nom de l’application IIS, exécutable du processus ou nom du processus). Disponible pour les versions 1.17.0+ |
DD_VERSIONServiceVersion | Lorsqu’il est spécifié, ce paramètre définit la version du service. Disponible pour les versions 1.17.0+ |
DD_TAGSGlobalTags | Lorsqu’il est défini, ce paramètre ajoute tous les tags spécifiés à l’ensemble des spans générées (p. ex. layer:api,team:intake). Disponible pour les versions 1.17.0+ |
Nous vous conseillons fortement d’utiliser DD_ENV, DD_SERVICE et DD_VERSION pour définir les paramètres env, service et version pour vos services.
Consultez la documentation sur le Tagging de service unifié pour en savoir plus sur la configuration de ces variables d’environnement.
| Nom du paramètre | Description |
|---|---|
DD_TRACE_AGENT_URLAgentUri | Définit l’URL d’endpoint où les traces sont envoyées. Utilisé à la place de DD_AGENT_HOST et DD_TRACE_AGENT_PORT si défini. La valeur par défaut est http://<DD_AGENT_HOST>:<DD_TRACE_AGENT_PORT>. |
DD_AGENT_HOST | Définit le host vers lequel les traces sont envoyées (le host qui exécute l’Agent). Il peut s’agir d’un hostname ou d’une adresse IP. Ce paramètre est ignoré si DD_TRACE_AGENT_URL est défini. Valeur par défaut : localhost. |
DD_TRACE_AGENT_PORT | Définit le port sur lequel les traces sont envoyées (le port où l’Agent écoute les connexions). Ce paramètre est ignoré si DD_TRACE_AGENT_URL est défini. Valeur par défaut : 8126. |
DD_LOGS_INJECTIONLogsInjectionEnabled | Active ou désactive l’injection automatique d’identificateurs de corrélation dans les logs de l’application. |
DD_TRACE_DEBUG | Active ou désactive les logs de debugging. Valeurs acceptées : true ou false (par défaut). |
DD_TRACE_HEADER_TAGS | Accepte une liste des correspondances entre les clés d’en-tête (insensibles à la casse) et les noms de tag et applique automatiquement les valeurs d’en-tête correspondantes en tant que tags sur les spans racine. (Ex. : en-tête-insensible-CASSE:nom-du-tag,User-ID:userId). Disponible pour les versions 1.18.3+ |
Le tableau suivant énumère les variables de configuration disponibles uniquement pour les instrumentations automatiques.
| Nom du paramètre | Description |
|---|---|
DD_TRACE_ENABLEDTraceEnabled | Active ou désactive toute instrumentation automatique. Lorsque la variable d’environnement est définie sur false, le profileur CLR est entièrement désactivé. Pour les autres méthodes de configuration, le profileur CLR est quand même chargé, mais aucune trace n’est générée. Valeurs acceptées : true (par défaut) ou false. |
DD_TRACE_LOG_PATH | Définit le chemin du fichier de log du profileur CLR. Valeur par défaut : %ProgramData%\Datadog .NET Tracer\logs\dotnet-profiler.log. |
DD_DISABLED_INTEGRATIONSDisabledIntegrationNames | Définit la liste des intégrations à désactiver. Toutes les autres intégrations restent activées. Si ce paramètre n’est pas défini, toutes les intégrations sont activées. Ce paramètre accepte plusieurs valeurs séparées par des points-virgules. Les valeurs valides correspondent aux noms d’intégration énumérés dans la section Intégrations. |
DD_TRACE_ANALYTICS_ENABLEDAnalyticsEnabled | Raccourci qui active les paramètres App Analytics par défaut pour les intégrations de framework Web. Valeurs acceptées : true ou false (par défaut). |
Le tableau suivant énumère les variables de configuration qui sont uniquement disponibles en utilisant l’instrumentation automatique, et qui peuvent être définies pour chaque intégration. Utilisez le premier nom (p. ex., DD_<INTÉGRATION>_ENABLED) pour les variables d’environnement et les fichiers de configuration. Le deuxième nom (p. ex., Enabled) correspond au nom de la propriété IntegrationSettings à utiliser lors du changement des paramètres dans le code. Accédez à ces propriétés à l’aide de l’indexeur TracerSettings.Integrations[]. Les noms d’intégrations sont énumérés dans la section Intégrations.
| Nom du paramètre | Description |
|---|---|
DD_TRACE_<INTÉGRATION>_ENABLEDEnabled | Active ou désactive une intégration spécifique. Valeurs acceptées : true (par défaut) ou false. |
DD_TRACE_<INTÉGRATION>_ANALYTICS_ENABLEDAnalyticsEnabled | Active ou désactive App Analytics pour une intégration spécifique. Valeurs acceptées : true ou false (par défaut). |
DD_TRACE_<INTÉGRATION>_ANALYTICS_SAMPLE_RATEAnalyticsSampleRate | Définit le taux d’échantillonnage App Analytics pour une intégration spécifique. Doit être un nombre flottant entre 0.0 et 1.0 (par défaut). |
Documentation, liens et articles supplémentaires utiles:
Sur cette page
