Utilitaire de collecte et de supervision de diagnostic (dotnet-monitor)
Cet article s’applique à : ✔️ dotnet-monitor
version 6.0.0 et ultérieures
Installer
Il y a deux moyens de télécharger dotnet-monitor
:
outil global dotnet :
Pour installer la dernière version de version du
dotnet-monitor
package NuGet, utilisez la commande d’installation de l’outil dotnet :dotnet tool install --global dotnet-monitor
Image Docker :
Téléchargez une image Docker pour l’utiliser dans des environnements multiconteneurs :
docker pull mcr.microsoft.com/dotnet/monitor
Synopsis
dotnet-monitor [-h|--help] [--version] <command>
Description
L’outil dotnet-monitor
global permet de monitorer les applications .NET dans les environnements de production, et de collecter des artefacts de diagnostic (par exemple, des images mémoire, des traces, des journaux et des métriques) à la demande ou en utilisant des règles automatisées pour la collecte dans des conditions spécifiées.
Options
--version
Affiche la version de l’utilitaire dotnet-monitor.
-h|--help
Affiche l’aide en ligne de commande.
Commandes
Commande |
---|
dotnet monitor collect |
dotnet monitor config show |
dotnet monitor generatekey |
dotnet-monitor collect
Monitorez les applications .NET, autorisez la collecte d’artefacts de diagnostic et envoyez les résultats à une destination choisie.
Synopsis
dotnet-monitor collect [-h|--help] [-u|--urls] [-m|--metrics] [--metricUrls] [--diagnostic-port] [--no-auth] [--temp-apikey] [--no-http-egress]
Options
-h|--help
Affiche l’aide en ligne de commande.
-u|--urls <urls>
Liaisons pour l’API HTTP. La valeur par défaut est
https://localhost:52323
.-m|--metrics [true|false]
Active la publication des métriques sur la route
/metrics
. La valeur par défaut esttrue
--metricUrls <urls>
Liaisons pour l’API HTTP de métriques. La valeur par défaut est
http://localhost:52325
.--diagnostic-port <path>
Chemin complet et nom de fichier du port de diagnostic auquel les instances du runtime peuvent se connecter. La spécification de cette option place
dotnet-monitor
en mode 'listen'. Quand elle n’est pas spécifiée,dotnet-monitor
est en mode 'connect'.Sur Windows, doit être un nom de canal nommé valide. Sur Linux et macOS, doit être un chemin de socket de domaine Unix valide.
--no-auth
Désactive l’authentification par clé API. La valeur par défaut est
false
.Nous vous recommandons vivement de ne pas utiliser cette option dans les environnements de production.
--temp-apikey
Génère une clé API temporaire pour l’instance
dotnet-monitor
.--no-http-egress
Désactive la sortie des artefacts de diagnostic via la réponse HTTP. Quand elle est spécifiée, les artefacts doivent être sortis avec un fournisseur de sortie.
dotnet monitor config show
Affiche la configuration, comme si dotnet-monitor collect
avait été exécuté avec ces paramètres.
Synopsis
dotnet-monitor config show [-h|--help] [-u|--urls] [-m|--metrics] [--metricUrls] [--diagnostic-port] [--no-auth] [--temp-apikey] [--no-http-egress] [--level] [--show-sources]
Options
-h|--help
Affiche l’aide en ligne de commande.
-u|--urls <urls>
Liaisons pour l’API HTTP. La valeur par défaut est
https://localhost:52323
.Cette valeur est mappée dans la configuration comme clé
urls
.-m|--metrics [true|false]
Active la publication des métriques sur la route
/metrics
. La valeur par défaut esttrue
.Cette valeur est mappée dans la configuration comme clé
Metrics:Enabled
.--metricUrls <urls>
Liaisons pour l’API HTTP de métriques. La valeur par défaut est
http://localhost:52325
.Cette valeur est mappée dans la configuration comme clé
Metrics:Endpoints
.--diagnostic-port <path>
Chemin complet et nom de fichier du port de diagnostic auquel les instances du runtime peuvent se connecter. La spécification de cette option place
dotnet-monitor
en mode 'listen'. Quand elle n’est pas spécifiée,dotnet-monitor
est en mode 'connect'.Sur Windows, doit être un nom de canal nommé valide. Sur Linux et macOS, doit être un chemin de socket de domaine Unix valide.
Cette valeur est mappée dans la configuration comme clé
DiagnosticPort:EndpointName
.--no-auth
Désactive l’authentification par clé API. La valeur par défaut est
false
.Nous vous recommandons vivement de ne pas utiliser cette option dans les environnements de production.
Cette valeur n’est pas mappée dans la configuration.
--temp-apikey
Génère une clé API temporaire pour l’instance
dotnet-monitor
.Cette valeur est mappée dans la configuration comme clé
Authentication:MonitorApiKey
.--no-http-egress
Désactive la sortie des artefacts de diagnostic via la réponse HTTP. Quand elle est spécifiée, les artefacts doivent être sortis avec un fournisseur de sortie.
Cette valeur n’est pas mappée dans la configuration.
--level
Niveau de configuration. La configuration
Full
peut afficher des informations sensibles. Il y a deux niveaux :Full
- Configuration complète sans censure de valeurs.Redacted
- Configuration complète, mais les informations sensibles, comme les secrets connus, sont censurées.
--show-sources
Identifie la source de configuration qui fournit chaque valeur de configuration effective.
dotnet monitor generatekey
Génère une clé API et un hachage pour l’authentification HTTP.
Synopsis
dotnet-monitor generatekey [-h|--help] [-o|--output]
Options
-h|--help
Affiche l’aide en ligne de commande.
-o|--output <Cmd|Json|MachineJson|PowerShell|Shell|Text>
Format de sortie dans lequel les informations de clé API sont écrites dans la sortie standard.
Les valeurs autorisées sont les suivantes :
Cmd
- Sorties dans un format utilisable dans l’invite de commandes Windows ou les fichiers de commandes.Json
- Sorties au format d’un objet JSON.MachineJson
- Sorties au format d’un objet JSON sans commentaires ni explication. Utile pour les scénarios d’automatisation.PowerShell
- Sorties dans un format utilisable dans les invites et les scripts PowerShell.Shell
- Sorties dans un format utilisable dans les interpréteurs de commandes Linux comme Bash.Text
- Sorties au format de texte brut.