基本介绍

同步类型 用于快速暴露监控指标，无论 metrics reader 是否使用该监控指标，指标的计算结果已完成，待读取使用。例如，HTTP的请求总数、请求大小，这些数值必须在请求执行流程中记录到对应的监控指标数值中，适合作为同步指标来管理。

gmetric 提供的同步类型指标包含： Counter, UpDownCounter, Histogram。

我们用一个简单的示例来演示同步指标的基本使用。

  1. package main
  3. import (
  4.     "go.opentelemetry.io/otel/exporters/prometheus"
  6.     "github.com/gogf/gf/contrib/metric/otelmetric/v2"
  7.     "github.com/gogf/gf/v2/frame/g"
  8.     "github.com/gogf/gf/v2/os/gctx"
  9.     "github.com/gogf/gf/v2/os/gmetric"
  10. )
  12. var (
  13.     meter = gmetric.GetGlobalProvider().Meter(gmetric.MeterOption{
  14.         Instrument:        "github.com/gogf/gf/example/metric/basic",
  15.         InstrumentVersion: "v1.0",
  16.     })
  17.     counter = meter.MustCounter(
  18.         "goframe.metric.demo.counter",
  19.         gmetric.MetricOption{
  20.             Help: "This is a simple demo for Counter usage",
  21.             Unit: "bytes",
  22.         },
  23.     )
  24.     upDownCounter = meter.MustUpDownCounter(
  25.         "goframe.metric.demo.updown_counter",
  26.         gmetric.MetricOption{
  27.             Help: "This is a simple demo for UpDownCounter usage",
  28.             Unit: "%",
  29.         },
  30.     )
  31.     histogram = meter.MustHistogram(
  32.         "goframe.metric.demo.histogram",
  33.         gmetric.MetricOption{
  34.             Help:    "This is a simple demo for histogram usage",
  35.             Unit:    "ms",
  36.             Buckets: []float64{0, 10, 20, 50, 100, 500, 1000, 2000, 5000, 10000},
  37.         },
  38.     )
  39. )
  41. func main() {
  42.     var ctx = gctx.New()
  44.     // Prometheus exporter to export metrics as Prometheus format.
  45.     exporter, err := prometheus.New(
  46.         prometheus.WithoutCounterSuffixes(),
  47.         prometheus.WithoutUnits(),
  48.     )
  49.     if err != nil {
  50.         g.Log().Fatal(ctx, err)
  51.     }
  53.     // OpenTelemetry provider.
  54.     provider := otelmetric.MustProvider(otelmetric.WithReader(exporter))
  55.     provider.SetAsGlobal()
  56.     defer provider.Shutdown(ctx)
  58.     // Counter.
  59.     counter.Inc(ctx)
  60.     counter.Add(ctx, 10)
  62.     // UpDownCounter.
  63.     upDownCounter.Inc(ctx)
  64.     upDownCounter.Add(ctx, 10)
  65.     upDownCounter.Dec(ctx)
  67.     // Record values for histogram.
  68.     histogram.Record(1)
  69.     histogram.Record(20)
  70.     histogram.Record(30)
  71.     histogram.Record(101)
  72.     histogram.Record(2000)
  73.     histogram.Record(9000)
  74.     histogram.Record(20000)
  76.     // HTTP Server for metrics exporting.
  77.     otelmetric.StartPrometheusMetricsServer(8000, "/metrics")
  78. }

Counter&UpDownCounter

其中的 Counter 和 UpDownCounter 比较简单，这里就不详细介绍了，需要注意的是 Counter 和 UpDownCounter 虽然看起来差不多，实际上也是如此，只是为了更严谨和精细化区分使用场景。如果将这两种数据类型映射到经典的 Prometheus 指标类型中， Counter 对应的就是 Prometheus 的 Counter 指标类型，而 UpDownCounter 对应的是 Prometheus 的 Gauge 指标类型。

Histogram

Histogram 是一种统计类型，通过该指标可以快速统计出指标的 p95, p99 等百分位统计结果直方图，例如时间开销、成功/失败率等指标。但需要注意该指标比较占内存和空间，不能为其添加过多的 动态属性，因为不同的属性会衍生出同一种 Histogram 指标不同的存储数值。

Primetheus Exporter

在该示例中，我们使用了比较常用的 Prometheus 协议输出指标内容，通常用于对外暴露指标供外部组件抓取。通过以下路由将指标通过 Prometheus 协议暴露：

  1. otelmetric.StartPrometheusMetricsServer(8000, "/metrics")

执行后，访问 http://127.0.0.1:8000/metrics 查看暴露的指标：

监控告警-同步指标 - 图1

我们这里只关注本次示例中的指标，其他自动暴露的指标在后续章节介绍。