asp.net core監視 - Prometheus導入（四）


前のブログポストでは、PrometheusにはCounter（カウンタ）, Gauge（ゲージ）, Histogram（ヒストグラム）, Summary（サマリー）の4種類のメトリックタイプがあると語った。そして、私たちはカウンタのデモを作成した。次にHistogram（ヒストグラム）を見てみよう。

3、Histogram：ヒストグラム

ヒストグラムとは、データ分布をグラフィカルに表現するものであり、2次元の統計グラフである。二つの軸はそれぞれ、統計サンプルとそのサンプルの特性のメジャーを表している。バーグラフ（bar）の形で具体的に表現される。ヒストグラムの長さと幅は量の変化を表現するのに適しているため、少数値の相違を解読するのが比較的容易である。

前述したSampleを使って説明してみましょう。例えば、各注文には一定の金額があり、注文時に戻り値{result=true,data=1000}のdata属性で返すとします。この金額をヒストグラムで収集することができます。注文の金額がそれぞれ異なるため、ヒストグラムを使用して一定範囲の金額の注文データを表示し、一定の金額範囲内の注文比率を監視することができます。つまり、一定数の注文の中で、1000円未満の注文が何件あるか、2000円未満の注文が何件あるか、3000円未満の注文が何件あるかを調べることができます...

まず、BusinessController内のOrder Actionのビジネスロジックを修正し、注文金額を戻り値として返すようにします：

```csharp
[HttpGet("/order")]
public IActionResult Order(string orderno)
{
    try
    {
        _logger.LogInformation("下单");
        //返回订单金额
        var random = new Random();
        return new JsonResult(new { Result = true, data = random.Next(1, 8000) });
    }
    catch (Exception exc)
    {
        _logger.LogCritical(exc, exc.Message);
        return new JsonResult(new
        {
            Result = false,
            Message = exc.Message
        });
    }
}
```

ここでは、デモのために金額をランダムに生成しています。1から8000の間でランダムな数値を生成します。

次に、MetricsHub.csにHistogramタイプのメトリック収集コレクションを追加する必要があります：

```csharp
using Prometheus;
using System.Collections.Generic;

namespace PrometheusSample.Middlewares
{
    public class MetricsHub
    {
        private static Dictionary<string, Counter> _counterDictionary = new Dictionary<string, Counter>();
        private static Dictionary<string, Dictionary<string, Gauge>> _gaugeDictionary = new Dictionary<string, Dictionary<string, Gauge>>();
        private static Dictionary<string, Histogram> _histogramDictionary = new Dictionary<string, Histogram>();

        public Counter GetCounter(string key)
        {
            if (_counterDictionary.ContainsKey(key))
            {
                return _counterDictionary[key];
            }
            else
            {
                return null;
            }
        }
        public Dictionary<string, Gauge> GetGauge(string key)
        {
            if (_gaugeDictionary.ContainsKey(key))
            {
                return _gaugeDictionary[key];
            }
            else
            {
                return null;
            }
        }
        public Histogram GetHistogram(string key)
        {
            if (_histogramDictionary.ContainsKey(key))
            {
                return _histogramDictionary[key];
            }
            else
            {
                return null;
            }
        }
        public void AddCounter(string key, Counter counter)
        {
            _counterDictionary.Add(key, counter);
        }
        public void AddGauge(string key, Dictionary<string, Gauge> gauges)
        {
            _gaugeDictionary.Add(key, gauges);
        }
        public void AddHistogram(string key, Histogram histogram)
        {
            _histogramDictionary.Add(key, histogram);
        }
    }
}
```

次に、BusinessMetricsMiddlewareの中間ワードにHistogram指標の処理コードを追加する必要があります：

```csharp
using Microsoft.AspNetCore.Http;
using PrometheusSample.Models;
using System.IO;
using System.Threading.Tasks;

namespace PrometheusSample.Middlewares
{
    /// <summary>
    /// 请求记录中间件
    /// </summary>
    public class BusinessMetricsMiddleware
    {
        private readonly RequestDelegate _next;
        public BusinessMetricsMiddleware(RequestDelegate next)
        {
            _next = next;
        }
        public async Task InvokeAsync(HttpContext context, MetricsHub metricsHub)
        {
            var originalBody = context.Response.Body;
            try
            {
                using (var memStream = new MemoryStream())
                {
                    //从管理返回的Response中取出返回数据，根据返回值进行监控指标计数
                    context.Response.Body = memStream;
                    await _next(context);

                    memStream.Position = 0;
                    string responseBody = new StreamReader(memStream).ReadToEnd();
                    memStream.Position = 0;
                    await memStream.CopyToAsync(originalBody);
                    if (metricsHub.GetCounter(context.Request.Path) != null || metricsHub.GetGauge(context.Request.Path) != null)
                    {
                        //这里约定所有action返回值是一个APIResult类型
                        var result = System.Text.Json.JsonSerializer.Deserialize<APIResult>(responseBody, new System.Text.Json.JsonSerializerOptions { PropertyNameCaseInsensitive = true });
                        if (result != null && result.Result)
                        {
                            //获取到Counter
                            var counter = metricsHub.GetCounter(context.Request.Path);
                            if (counter != null)
                            {
                                //计数
                                counter.Inc();
                            }

                            var gauges = metricsHub.GetGauge(context.Request.Path);
                            if (gauges != null)
                            {
                                //存在增加指标+就Inc
                                if (gauges.ContainsKey("+"))
                                {
                                    gauges["+"].Inc();
                                }
                                //存在减少指标-就Dec
                                if (gauges.ContainsKey("-"))
                                {
                                    gauges["-"].Dec();
                                }
                            }
                            var histogram = metricsHub.GetHistogram(context.Request.Path);
                            if (histogram != null)
                            {
                                var parseResult = int.TryParse(result.Data.ToString(), out int i);
                                if (parseResult)
                                {
                                    histogram.Observe(i);
                                }
                            }
                        }
                    }
                }
            }
            finally
            {
                context.Response.Body = originalBody;
            }
        }
    }
}
```

次に、Starsupで対応するurlのHistogramパラメータを設定する必要があります：

```csharp
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.OpenApi.Models;
using Prometheus;
using PrometheusSample.Middlewares;
using PrometheusSample.Services;

namespace PrometheusSample
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            MetricsHandle(services);
            services.AddScoped<IOrderService, OrderService>();
            services.AddControllers();
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "PrometheusSample", Version = "v1" });
            });
        }

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
                app.UseSwagger();
                app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "PrometheusSample v1"));
            }

            app.UseRouting();
            //http请求的中间件
            app.UseHttpMetrics();
            app.UseAuthorization();

            //自定义业务跟踪
            app.UseBusinessMetrics();

            app.UseEndpoints(endpoints =>
            {
                //映射监控地址为  /metrics
                endpoints.MapMetrics();
                endpoints.MapControllers();
            });
        }
        /// <summary>
        /// 处理监控事项
        /// </summary>
        /// <param name="services"></param>
        void MetricsHandle(IServiceCollection services)
        {
            var metricsHub = new MetricsHub();
            metricsHub.AddCounter("/register", Metrics.CreateCounter("business_register_user", "注册用户数。"));
            metricsHub.AddCounter("/order", Metrics.CreateCounter("business_order_total", "下单总数。")); 
            metricsHub.AddCounter("/pay", Metrics.CreateCounter("business_pay_total", "支付总数。"));
            metricsHub.AddCounter("/ship", Metrics.CreateCounter("business_ship_total", "发货总数。"));

            var orderHistogram = Metrics.CreateHistogram("business_order_histogram", "订单直方图。", new HistogramConfiguration
            {
                Buckets = Histogram.LinearBuckets(start: 1000, width: 1000, count: 5)
            });
            metricsHub.AddHistogram("/order", orderHistogram);
            services.AddSingleton(metricsHub);
        }
    }
}
```

Histogram.LinearBuckets(start: 1000, width: 1000, count: 5)とは、金額が1000から始まり、1000ごとに1段階、計6段階です。0～1000、1001～2000、2001～3000、3001～4000、4001～5000、そして5000を超えるものです。

最後のステップは、Grafanaを開いてチャートを設定することです。

注文金額分布図

![alt 图片](https://mmbiz.qpic.cn/mmbiz_png/4CAA63nvHRAHk0GFVCeROvoBbMPEa1LdSbrjGyVibQIRc8OG8worAAwKfz1tElRhl53EyWcH1b1PjtXoF16ekng/640?wx_fmt=png)

注文比率分布図

![alt 图片](https://mmbiz.qpic.cn/mmbiz_png/4CAA63nvHRAHk0GFVCeROvoBbMPEa1LdJIzCKlSG9NV8GAYZRaJKD71yGIcKicuziabls8moPzmvWNRIVAmvfEgg/640?wx_fmt=png)

このグラフの中で、「histogram_quantile(0.80, sum(rate(business_order_histogram_bucket[5m])) by (le))」の意味は、「80%の注文金額がこの値以下である」の5分以内の値です。

最終的な表示結果：

![alt 图片](https://mmbiz.qpic.cn/mmbiz_png/4CAA63nvHRAHk0GFVCeROvoBbMPEa1Ld4gpdFjicMVAG947SaJB0ettSdFMGjMsQRsMcUtk43HYYAhQ6r2ImrVQ/640?wx_fmt=png)

あなたが賢いなら、このブログポストと前回のポストがほとんど同じであることに気付くでしょう。そうです、監視指標の表示タイプが異なるだけです。

(Translated by GPT)

元のリンク：https://mp.weixin.qq.com/s?__biz=MzA3NDM1MzIyMQ==&mid=2247483755&idx=1&sn=f7765dcb3f8011e1d5ebbe3470a7d0ac&chksm=9f005e41a877d757d8c9a018525fc39f541edd01ac3ad325f75471a5d52d2662c3b7679370f7&token=418912929&lang=zh_CN#rd