指标收集 - 全局属性

Code Source: https://github.com/gogf/examples/tree/main/observability/metric/global_attributes

简介

本示例演示了如何在 GoFrame 中使用 OpenTelemetry 和 Prometheus 集成来实现全局指标属性。主要展示：

• 设置和管理全局属性
• 在多个指标中应用全局属性
• 配置属性作用域和匹配模式
• 组合使用全局属性和局部属性

目录结构

.
├── go.mod            # Go模块文件
├── go.sum            # Go模块校验和
└── main.go           # 主程序，演示全局属性使用

功能特性

本示例展示了以下功能：

1. 全局属性

   • 全局属性配置
   • 属性继承机制
   • 基于模式的应用
   • 版本控制支持

2. 带全局属性的指标类型

   • 带全局属性的计数器
   • 带全局属性的可观察计数器
   • 局部属性组合
   • 属性优先级

3. 属性管理

   • 全局属性作用域
   • 基于版本的过滤
   • 基于模式的过滤
   • 属性继承规则

环境要求

• Go 1.22 或更高版本
• GoFrame 框架
• GoFrame OpenTelemetry Metric 扩展

使用说明

1. 运行示例：

   go run main.go

2. 访问指标：

   # 使用curl
   curl http://localhost:8000/metrics
   
   # 或在浏览器中打开
   http://localhost:8000/metrics

3. 指标输出示例：

   # HELP goframe_metric_demo_counter 这是Counter使用的简单演示
   goframe_metric_demo_counter{const_attr_1="1",global_attr_1="1"} 11
   
   # HELP goframe_metric_demo_observable_counter 这是ObservableCounter使用的简单演示
   goframe_metric_demo_observable_counter{const_attr_2="2",global_attr_1="1"} 10

实现说明

1. 设置全局属性

   gmetric.SetGlobalAttributes(gmetric.Attributes{
       gmetric.NewAttribute("global_attr_1", 1), // 全局属性
   }, gmetric.SetGlobalAttributesOption{
       Instrument:        instrument,        // 仅应用于特定的instrument
       InstrumentVersion: instrumentVersion, // 仅应用于特定版本
       InstrumentPattern: "",               // 空模式表示应用于所有指标
   })

2. 带全局属性的指标

   counter := meter.MustCounter(
       "goframe.metric.demo.counter",
       gmetric.MetricOption{
           Help: "计数器示例",
           Unit: "bytes",
           Attributes: gmetric.Attributes{
               gmetric.NewAttribute("const_attr_1", 1), // 局部常量属性
           },
       },
   )

3. 在可观察指标中使用全局属性

   meter.MustRegisterCallback(func(ctx context.Context, obs gmetric.Observer) error {
       obs.Observe(observableCounter, 10) // 全局属性会自动添加
       return nil
   }, observableCounter)