asp.net core監視—引入Prometheus（三）


前回のブログで、Prometheusには4種類の指標タイプがあると説明しました：Counter（カウンター）、Gauge（ゲージ）、Histogram（ヒストグラム）、Summary（サマリー）。そして、Counterのデモを行いましたが、今回はGaugeを見てみましょう。

2、Gauge： ゲージ、増減可能
この指標は自動車のスピードメーターに非常に似ており、針は特定の範囲内で増減します。以下、前回のブログのSampleを引き続き使用して、現在、「注文完了」、「支払い完了」、「発送完了」の状態の注文データと、3つの状態の割合をリアルタイムで監視する必要がある場面を見てみましょう。1つの注文が一つの瞬間に1つの状態のみを持つことができるため、注文時には注文数の指標を増やすことができますが、注文がpay状態に移行すると、pay指標が増加し、同時にorder指標が減少します。このシナリオではGaugeを使用します。

この考え方があれば、コードに取り掛かることができます。BusinessControllerのコードは変わらず（ビジネスロジックコードと監視データの指標収集を分離実装したため）、MetricsHub.csにGaugeタイプの指標収集コレクションを追加する必要があります：

```csharp
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>>();
    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 void AddCounter(string key, Counter counter)
    {
        _counterDictionary.Add(key, counter);
    }
    public void AddGauge(string key, Dictionary<string, Gauge> gauges)
    {
        _gaugeDictionary.Add(key, gauges);
    }
}
```

分析で述べたように、例えばpayアクションを行った時、2つの指標が変更されます。order指標が減少し、pay指標が増加するため、Gaugeは`Dictionary<string, Dictionary<string, Gauge>>`型で、内部の辞書には増加と減少のGaugeの監視指標オブジェクトが保存されます。

次に、BusinessMetricsMiddlewareのミドルウェアにGauge指標の増加と減少のコードを追加する必要があります：

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

namespace PrometheusSample.Middlewares
{
    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())
                {
                    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)
                    {
                        var result = System.Text.Json.JsonSerializer.Deserialize<APIResult>(responseBody, new System.Text.Json.JsonSerializerOptions { PropertyNameCaseInsensitive = true });
                        if (result != null && result.Result)
                        {
                            var counter = metricsHub.GetCounter(context.Request.Path);
                            if (counter != null)
                            {
                                counter.Inc();
                            }
                            var gauges = metricsHub.GetGauge(context.Request.Path);
                            if (gauges != null)
                            {
                                if (gauges.ContainsKey("+"))
                                {
                                    gauges["+"].Inc();
                                }
                                if (gauges.ContainsKey("-"))
                                {
                                    gauges["-"].Dec();
                                }
                            }
                        }
                    }
                }
            }
            finally
            {
                context.Response.Body = originalBody;
            }
        }
    }
}
```

そして、Startupで対応するurlのGaugeパラメータを設定します：

```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;
using System.Collections.Generic;

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();
            app.UseHttpMetrics();
            app.UseAuthorization();
            app.UseBusinessMetrics();
            app.UseEndpoints(endpoints =>
            {
                endpoints.MapMetrics();
                endpoints.MapControllers();
            });
        }

        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 orderGauge = Metrics.CreateGauge("business_order_count", "現在の注文数。");
            var payGauge = Metrics.CreateGauge("business_pay_count", "現在の支払数。");
            var shipGauge = Metrics.CreateGauge("business_ship_count", "現在の出荷データ。");
            metricsHub.AddGauge("/order", new Dictionary<string, Gauge> {
                { "+", orderGauge}
            });
            metricsHub.AddGauge("/pay", new Dictionary<string, Gauge> {
                {"-",orderGauge},
                {"+",payGauge}
            });
            metricsHub.AddGauge("/ship", new Dictionary<string, Gauge> {
                {"+",shipGauge},
                {"-",payGauge}
            });
            services.AddSingleton(metricsHub);
        }
    }
}
```

最後のステップは、Grafanaを開いてグラフを設定することです。

注文状態データのダッシュボード
![alt 画像](画像URL)
注文状態の比率グラフ
![alt 画像](画像URL)
最終表示結果
![alt 画像](画像URL)

前回、カスタムビジネスカウンタータイプのステップについて言及しましたが、ゲージのステップも同じです。
1、ビジネスを分析し、監視トラックの指標を計画する
2、指標収集器を定義する
3、プログラミングを侵害する（可能な限り開発中にビジネスの実装と監視チケットの収集コードを分離する）
4、grafana表示テンプレートを開発し、表示を完了する

(Translated by GPT)

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