JF91.AppMetrics.InfluxDB2.Net7

このパッケージを作成したのは、App.Metrics を ASP WEB API に簡単に統合して、収集したメトリクスを InfluxDB2 サーバーに送信できるようにするためです。

セットアップは非常に簡単で、Nuget パッケージをインストールし、appsettings.json に config セクションを追加して、program.cs にサービスを挿入するだけです。

指示に注意深く従ってください。

Nuget をインストールします。

 dotnet add package JF91.AppMetricsInfluxDB2 --version 1.2.0

1 - このセクションをappsettings.jsonに追加し、必要に応じて変更します。

 "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 - この環境変数をlaunchSettings.jsonに追加します。

 "APPLICATION_NAME": "MyKickassApi"

3 - これをbuilder.Build()の前に追加します。

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

4 - これをbuilder.Build()の後に追加します。

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

5 - これをapp.Run()前に追加します。

 app.UseHttpStatusCodesCounterMiddleware();

---

新しいメトリクス ミドルウェアを追加する方法:

1 - インターセプターミドルウェアを作成します。

2 - 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 - ミドルウェアをアプリ パイプラインに追加します。

 builder.UseMiddleware();

---

コントローラーに新しいメトリクスを追加する方法:

1 - IMetricsコントローラーに挿入します。

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

2 - 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();
}