JF91.OpenTelemetry.Net7

Utilisez ce package pour intégrer OpenTelemetry dans votre API Web ASP.NET à l'aide de appsettings.json

Suivez ces étapes pour le faire :

1 : Installer le package Nuget

 dotnet add package JF91.OpenTelemetry

2 : Ajoutez ceci après var builder = WebApplication.CreateBuilder(args);

 builder.Services.AddOpenTelemetryServices(builder.Configuration);

2.2 : Personnaliser les paramètres (facultatif) :

Les options personnalisées sont facultatives, ce qui signifie que vous pouvez mélanger les options de appsettings.json avec celles définies ci-dessous

{ zipkinOptions.Enabled = true; zipkinOptions.Endpoint = "http://www.test.com"; }, influxdbOptions => { influxdbOptions.Enabled = true; influxdbOptions.Url = "http://www.test.com"; influxdbOptions.Protocol = JaegerProtocols.Http; }, new List> { otlp_one => { otlp_one.Enabled = true; otlp_one.Url = "http://www.test.com"; otlp_one.Protocol = OtlpProtocols.Http; }, otlp_two => { otlp_two.Enabled = true; otlp_two.Url = "http://www.test2.com"; otlp_two.Protocol = OtlpProtocols.Grpc; } }, prometheusOptions => { prometheusOptions.Enabled = true; prometheusOptions.ScrapeEndpointPath = "/test"; prometheusOptions.ScrapeResponseCacheDurationMilliseconds = 1000; } );">

 builder.Services.AddOpenTelemetryServices
(
    builder.Configuration,
    jaegerOptions =>
    {
        jaegerOptions.Enabled = true;
        jaegerOptions.Endpoint = "http://www.test.com";
        jaegerOptions.Protocol = JaegerProtocols.Http;
    },
    zipkinOptions =>
    {
        zipkinOptions.Enabled = true;
        zipkinOptions.Endpoint = "http://www.test.com";
    },
    influxdbOptions =>
    {
        influxdbOptions.Enabled = true;
        influxdbOptions.Url = "http://www.test.com";
        influxdbOptions.Protocol = JaegerProtocols.Http;
    },
    new List>
    {
        otlp_one =>
        {
            otlp_one.Enabled = true;
            otlp_one.Url = "http://www.test.com";
            otlp_one.Protocol = OtlpProtocols.Http;
        },
        otlp_two =>
        {
            otlp_two.Enabled = true;
            otlp_two.Url = "http://www.test2.com";
            otlp_two.Protocol = OtlpProtocols.Grpc;
        }
    },
    prometheusOptions =>
    {
        prometheusOptions.Enabled = true;
        prometheusOptions.ScrapeEndpointPath = "/test";
        prometheusOptions.ScrapeResponseCacheDurationMilliseconds = 1000;
    }
);

IMPORTANT : pour une liste d'options personnalisées pour les exportateurs OTLP, vous devez avoir le même nombre d'entrées dans appsettings.json avec le même ordre.

Exemple 1 : 3 exportateurs OTLP dans appsettings.json et 2 options personnalisées remplaceront les 2 premières exportations OTLP dans appsettings.json à partir des 2 premières options personnalisées.

Exemple 2 : 2 exportateurs OTLP dans appsettings.json et 3 options personnalisées remplaceront les 2 exportateurs OTLP dans appsettings.json à partir des 2 premières options personnalisées.

3 : Ajoutez ceci avant app.Run();

 app.AddOpenTelemetryExtensions();

4 : Ajoutez ceci à votre appsettings.json et modifiez-le selon vos besoins :

 "OpenTelemetrySettings": {
    "EnableTraces": true,
    "EnableMetrics": true,
    "Exporters": {
        "Console": {
            "Enabled": true
        },
        "Jaeger": {
            "Enabled": true,
            "Endpoint": "http://localhost:14268/api/traces",
            "Protocol": "udp"
        },
        "Zipkin": {
            "Enabled": false,
            "Endpoint": " https://localhost:9411/api/v2/spans"
        },
        "Prometheus": {
            "Enabled": true,
            "ScrapeEndpointPath": "/metrics-text",
            "ScrapeResponseCacheDurationMilliseconds": 300
        },
        "InfluxDB": {
            "Enabled": false,
            "Url": "http://localhost:8086",
            "Protocol": "http"
        },
        "Otlp": [
        {
          "Enabled": true,
          "Url": "http://localhost:4317",
          "Protocol": "grpc"
        },
        {
          "Enabled": false,
          "Url": "http://localhost:4317",
          "Protocol": "http"
        }
      ]
    },
    "Instrumentation": {
        "Http": true,
        "EfCore": false,
        "Hangfire": false,
        "SqlClient": false,
        "Redis": false
    }
}

Valeurs des propriétés :

• Jaeger.Protocole : udp / http | Par défaut => udp

• [OtlpProtocols] > InfluxDB.Protocol : grpc / http | Par défaut => grpc

Référence : https://opentelemetry.io/docs/instrumentation/net/exporters/