OpenTelemetry
Identificateur : PowerShellUniversal.Plugins.OpenTelemetry
Le module d'extension OpenTelemetry exporte les métriques de PowerShell Universal et les traces ASP.NET Core via OTLP. Utilisez un collecteur, un tableau de bord ou un backend de métriques compatible avec OpenTelemetry pour inspecter l'activité de la plateforme et les requêtes des points de terminaison d'API personnalisés.
Activer le module d'extension
Ajoutez l'identificateur complet et exact du module d'extension au tableau Plugins dans appsettings.json. Le fournisseur de persistance par défaut est SQLite.
{
"Plugins": [
"PowerShellUniversal.SQLite",
"PowerShellUniversal.Plugins.OpenTelemetry"
]
}Configurez le point de terminaison OTLP et redémarrez PowerShell Universal après avoir modifié les paramètres du module d'extension ou de télémétrie.
Configurer l'exportation OTLP
Définissez OpenTelemetry:Otlp:Endpoint pour utiliser un seul point de terminaison à la fois pour les métriques et les traces. Si le point de terminaison de repli se termine par /v1/metrics, PowerShell Universal utilise cette URL pour les métriques et utilise automatiquement l'URL /v1/traces correspondante pour les traces.
{
"OpenTelemetry": {
"Otlp": {
"Endpoint": "http://localhost:4318/v1/metrics"
}
}
}Pour utiliser des collecteurs ou des points de terminaison distincts, configurez les paramètres propres à chaque signal. Ces paramètres remplacent le point de terminaison de repli pour leurs signaux respectifs.
Le nom de service par défaut est PowerShellUniversal. OTLP utilise HTTP/protobuf par défaut. Pour définir le protocole explicitement, définissez OTEL_EXPORTER_OTLP_PROTOCOL sur le nom d'énumération .NET HttpProtobuf ou Grpc.
Télémétrie des points de terminaison d'API personnalisés
Le module d'extension instrumente les requêtes des points de terminaison d'API personnalisés, y compris les points de terminaison conventionnels et ceux à expression régulière. Chaque requête produit une étendue de trace ASP.NET Core nommée avec la méthode HTTP et la définition du point de terminaison, comme GET /users/{id}.
Les étendues de points de terminaison comprennent les attributs suivants :
http.route
L'URL ou le modèle de point de terminaison configuré.
psu.endpoint.id
L'ID du point de terminaison PowerShell Universal.
psu.endpoint.url
L'URL ou le modèle de point de terminaison configuré.
http.response.status_code
Le code de statut HTTP retourné par le point de terminaison.
Utilisez ces attributs pour filtrer les traces d'un point de terminaison ou d'un statut de réponse particulier dans votre backend de télémétrie.
Le module d'extension exporte également les métriques de points de terminaison via le compteur PSU.Endpoints :
PSU.Endpoint.Execution.CountPSU.Endpoint.Execution.Durationen millisecondesPSU.Endpoint.Execution.IncomingContentLengthen octetsPSU.Endpoint.Execution.OutgoingContentLengthen octets
Métriques Prometheus
Prometheus peut recevoir des métriques OTLP lorsque son récepteur OTLP est activé.
Configurez le point de terminaison des métriques avec l'URL des métriques OTLP de Prometheus. Prometheus est un backend de métriques ; configurez séparément un collecteur ou un backend capable de gérer les traces lorsque vous souhaitez aussi exporter des traces.
Variables d'environnement
Utilisez des doubles traits de soulignement pour les clés de configuration imbriquées et des index à base zéro pour le tableau Plugins. Cet exemple Docker Compose active le module d'extension et exporte les métriques et les traces via HTTP/protobuf :
Vous pouvez aussi configurer des points de terminaison propres à chaque signal :
Mis à jour
Ce contenu vous a-t-il été utile ?