JF91.AppMetrics.InfluxDB2.Net7

J'ai créé ce package afin que vous puissiez facilement intégrer App.Metrics dans votre API WEB ASP pour envoyer les métriques collectées à un serveur InfluxDB2.

La configuration est très simple, installez simplement le package Nuget, ajoutez la section de configuration à votre appsettings.json et injectez les services dans votre program.cs.

Veuillez suivre attentivement les instructions.

Installez Nuget :

 dotnet add package JF91.AppMetricsInfluxDB2 --version 1.2.0

1 - Ajoutez cette section à votre appsettings.json et modifiez-la selon vos besoins :

 "MetricsOptions": {
    "DefaultContextLabel": "MyCustomContext",
    "Enabled": true
},
    "MetricsWebTrackingOptions": {
    "ApdexTrackingEnabled": true,
    "ApdexTSeconds": 0.1,
    "IgnoredHttpStatusCodes": [ 404 ],
    "IgnoredRoutesRegexPatterns": [],
    "OAuth2TrackingEnabled": true
},
    "MetricEndpointsOptions": {
    "MetricsEndpointEnabled": true,
    "MetricsTextEndpointEnabled": true,
    "PingEndpointEnabled": true,
    "EnvironmentInfoEndpointEnabled": true
},
    "MetricsReportingInfluxDb2Options": {
    "InfluxDb2": {
    "BaseUri": "http://127.0.0.1:8086",
    "Organization": "metrics",
    "Bucket": "metrics",
    "Token": "changeme"
},
    "HttpPolicy": {
    "BackoffPeriod": "0:0:30",
    "FailuresBeforeBackoff": 5,
    "Timeout": "0:0:40"
},
    "ReportInterval": "0:0:1"
}

2 - Ajoutez cette variable d'environnement à votre launchSettings.json :

 "APPLICATION_NAME": "MyKickassApi"

3 - Ajoutez ceci avant builder.Build() :

 builder.Services.AddMetricsServices();
builder.WebHost.AddInfluxDb2AppMetrics(builder.Configuration);

4 - Ajoutez ceci après builder.Build() :

 app.UseRequestsCounterMiddleware();
app.UseRequestsDurationMiddleware();
app.UseResponsesSizeMiddleware();
app.UseResponsesApdexMiddleware();
app.UseMetricsAllMiddleware();
app.UseMetricsAllEndpoints();

5 - Ajoutez ceci avant app.Run() :

 app.UseHttpStatusCodesCounterMiddleware();

---

Comment ajouter un nouveau middleware de métriques :

1 - Créer un middleware intercepteur ;

2 - Injecter IMetrics ;

 public class MyNewMetricMiddleware
{
    private readonly RequestDelegate _next;
    private readonly IMetrics _metrics;

    public MyNewMetricMiddleware(RequestDelegate next, IMetrics metrics)
    {
        _next = next;
        _metrics = metrics;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        try
        {
            await _next(context);

            var tags = new MetricTags
            (
                new[] { "Tag1-Key", "Tag2-Key" },
                new[] { "Tag1-Value, "Tag2-Value }
            );

            _metrics.Measure.Counter.Increment
            (
                new CounterOptions
                {
                    Name = "my-new-metric",
                    Context = "my-new-context",
                    MeasurementUnit = Unit.Calls,
                    Tags = tags
                }
            );
        }
        catch (Exception ex)
        {
        }
    }
}

3 - Ajoutez un middleware au pipeline d'application :

 builder.UseMiddleware();

---

Comment ajouter une nouvelle métrique dans le contrôleur :

1 - Injectez IMetrics dans le contrôleur :

 public WeatherForecastController(ILogger logger, IMetrics metrics)
{
    _logger = logger;
    _metrics = metrics;
}

2 - Utilisez IMetrics :

Get() { var tags = new MetricTags ( new[] { "Tag1-Key", "Tag2-Key" }, new[] { "Tag1-Value, "Tag2-Value } ); _metrics.Measure.Counter.Increment ( new CounterOptions { Name = "my-new-metric", Context = "my-new-context", MeasurementUnit = Unit.Calls, Tags = tags } ); return Enumerable.Range(1, 5).Select ( index => new WeatherForecast { Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)), TemperatureC = Random.Shared.Next(-20, 55), Summary = Summaries[Random.Shared.Next(Summaries.Length)] } ) .ToArray(); }">

 [HttpGet(Name = "GetWeatherForecast")]
public IEnumerable Get()
{
    var tags = new MetricTags
    (
        new[] { "Tag1-Key", "Tag2-Key" },
        new[] { "Tag1-Value, "Tag2-Value }
    );
    
    _metrics.Measure.Counter.Increment
    (
        new CounterOptions
        {
            Name = "my-new-metric",
            Context = "my-new-context",
            MeasurementUnit = Unit.Calls,
            Tags = tags
        }
    );

    return Enumerable.Range(1, 5).Select
        (
            index => new WeatherForecast
            {
                Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
                TemperatureC = Random.Shared.Next(-20, 55),
                Summary = Summaries[Random.Shared.Next(Summaries.Length)]
            }
        )
        .ToArray();
}