编辑“︁Gin指标收集”︁

= Gin指标收集 =  
'''Gin指标收集'''是指在使用[[Gin框架]]开发Web应用时，通过中间件或外部工具采集运行时性能数据（如请求延迟、吞吐量、错误率等）的过程。这些指标可用于监控系统健康状态、优化性能及故障排查。本页面将详细介绍如何在Gin中实现指标收集，包括基础配置、常用工具和实际案例分析。

== 概述 ==  
Gin作为高性能的Go语言Web框架，本身不内置指标收集功能，但可通过以下方式扩展：  
* **中间件集成**：如`gin-contrib/prometheus`  
* **外部库**：如Prometheus客户端库、OpenTelemetry  
* **日志转指标**：通过结构化日志（如JSON）生成时序数据  

核心指标通常包括：  
* 请求总数（HTTP请求计数）  
* 请求延迟（响应时间分布）  
* 错误状态码（4xx/5xx比例）  

== 基础实现 ==  
以下示例使用`gin-contrib/prometheus`中间件暴露Prometheus格式的指标：

<syntaxhighlight lang="go">  
package main

import (
	"github.com/gin-gonic/gin"
	"github.com/gin-contrib/prometheus"
)

func main() {
	r := gin.Default()

	// 初始化Prometheus中间件
	p := prometheus.NewPrometheus("gin")
	p.Use(r)

	r.GET("/hello", func(c *gin.Context) {
		c.JSON(200, gin.H{"message": "Hello, metrics!"})
	})

	r.Run(":8080")
}
</syntaxhighlight>  

'''输出示例'''：  
启动服务后访问`http://localhost:8080/metrics`，将看到类似以下数据：  
<pre>  
gin_requests_total{method="GET",path="/hello",status="200"} 1  
gin_request_duration_seconds_bucket{le="0.1",method="GET",path="/hello"} 1  
</pre>  

== 高级配置 ==  
=== 自定义指标 ===  
通过Prometheus客户端库添加自定义业务指标：  
<syntaxhighlight lang="go">  
import (
	"github.com/prometheus/client_golang/prometheus"
	"github.com/prometheus/client_golang/prometheus/promhttp"
)

var customCounter = prometheus.NewCounter(
	prometheus.CounterOpts{
		Name: "myapp_custom_events_total",
		Help: "Total custom events",
	},
)

func init() {
	prometheus.MustRegister(customCounter)
}

r.GET("/metrics", gin.WrapH(promhttp.Handler()))
</syntaxhighlight>  

=== 监控面板集成 ===  
使用Grafana可视化Prometheus数据：  
<mermaid>  
flowchart LR  
    Gin应用 -->|暴露/metrics| Prometheus  
    Prometheus -->|查询数据| Grafana  
</mermaid>  

== 实际案例 ==  
'''电商平台监控场景'''：  
1. **关键指标**：  
   * 下单接口成功率（`status_code=200`比例）  
   * 99分位延迟（P99响应时间）  
2. **告警规则**：  
   * 当5xx错误率超过1%时触发报警  
   * 延迟超过500ms的请求占比超过5%  

数学表达式：  
<math>  
\text{错误率} = \frac{\sum(\text{5xx请求})}{\sum(\text{总请求})} \times 100\%  
</math>  

== 性能考量 ==  
* **采样频率**：高流量环境下可降低采样率  
* **标签基数**：避免高基数标签（如用户ID）导致内存爆炸  
* **存储优化**：使用Prometheus的`recording rules`聚合数据  

== 参见 ==  
* [[Gin中间件开发]]  
* [[Prometheus查询语言]]  
* [[分布式追踪系统]]  

== 外部资源 ==  
* [https://prometheus.io Prometheus官方文档]  
* [https://grafana.com Grafana可视化工具]  

{{Gin框架学习路径结构}}

[[Category:后端框架]]
[[Category:Gin]]
[[Category:Gin日志与监控]]