metrics

Documentation

Overview

Package metrics 提供 Prometheus 指标监控功能

Package metrics 提供 Prometheus 指标监控功能

Index

• Variables
• func NewCounter(name, help string) prometheus.Counter
• func NewCounterVec(name, help string, labels []string) *prometheus.CounterVec
• func NewGauge(name, help string) prometheus.Gauge
• func NewHistogram(name, help string, buckets []float64) prometheus.Histogram
• func StartCollector(ctx context.Context, interval time.Duration)

Variables

var (
	// HttpRequestsTotal HTTP 请求总数
	HttpRequestsTotal = promauto.NewCounterVec(
		prometheus.CounterOpts{
			Name: "http_requests_total",
			Help: "Total number of HTTP requests",
		},
		[]string{"method", "path", "status"},
	)

	// HttpRequestDuration HTTP 请求耗时（秒）
	HttpRequestDuration = promauto.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "http_request_duration_seconds",
			Help:    "HTTP request duration in seconds",
			Buckets: []float64{0.001, 0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10},
		},
		[]string{"method", "path"},
	)

	// HttpRequestsInFlight 当前处理中的请求数
	HttpRequestsInFlight = promauto.NewGauge(
		prometheus.GaugeOpts{
			Name: "http_requests_in_flight",
			Help: "Number of HTTP requests currently being processed",
		},
	)
)

HTTP 请求相关指标

var (
	// DbPoolOpenConnections 数据库打开连接数
	DbPoolOpenConnections = promauto.NewGauge(
		prometheus.GaugeOpts{
			Name: "db_pool_open_connections",
			Help: "Number of open database connections",
		},
	)

	// DbPoolIdleConnections 数据库空闲连接数
	DbPoolIdleConnections = promauto.NewGauge(
		prometheus.GaugeOpts{
			Name: "db_pool_idle_connections",
			Help: "Number of idle database connections",
		},
	)

	// DbPoolInUseConnections 数据库使用中连接数
	DbPoolInUseConnections = promauto.NewGauge(
		prometheus.GaugeOpts{
			Name: "db_pool_in_use_connections",
			Help: "Number of database connections currently in use",
		},
	)

	// DbPoolWaitCount 等待连接累计次数（由 Go runtime 维护的单调递增值）
	DbPoolWaitCount = promauto.NewGauge(
		prometheus.GaugeOpts{
			Name: "db_pool_wait_count",
			Help: "Total number of times waited for a connection (cumulative from runtime)",
		},
	)
)

数据库连接池指标

var (
	// RedisPoolHits Redis 连接池命中累计次数（由 go-redis 维护的单调递增值）
	RedisPoolHits = promauto.NewGauge(
		prometheus.GaugeOpts{
			Name: "redis_pool_hits",
			Help: "Total number of times a free connection was found in the pool (cumulative from runtime)",
		},
	)

	// RedisPoolMisses Redis 连接池未命中累计次数（由 go-redis 维护的单调递增值）
	RedisPoolMisses = promauto.NewGauge(
		prometheus.GaugeOpts{
			Name: "redis_pool_misses",
			Help: "Total number of times a free connection was not found in the pool (cumulative from runtime)",
		},
	)

	// RedisPoolTotalConns Redis 连接池总连接数
	RedisPoolTotalConns = promauto.NewGauge(
		prometheus.GaugeOpts{
			Name: "redis_pool_total_connections",
			Help: "Total number of connections in the Redis pool",
		},
	)

	// RedisPoolIdleConns Redis 连接池空闲连接数
	RedisPoolIdleConns = promauto.NewGauge(
		prometheus.GaugeOpts{
			Name: "redis_pool_idle_connections",
			Help: "Number of idle connections in the Redis pool",
		},
	)
)

Redis 连接池指标

Functions

func NewCounter

func NewCounter(name, help string) prometheus.Counter

NewCounter 创建自定义 Prometheus Counter（计数器）。 Counter 是一种只增不减的指标，适用于请求总数、错误总数等累计统计场景。 通过 promauto 自动注册到默认 Registry，无需手动注册。

参数：

• name: 指标名称，需符合 Prometheus 命名规范（如 "myapp_requests_total"）
• help: 指标描述，展示在 /metrics 页面

func NewCounterVec

func NewCounterVec(name, help string, labels []string) *prometheus.CounterVec

NewCounterVec 创建带标签维度的 Prometheus CounterVec（向量计数器）。 与 NewCounter 不同，CounterVec 支持按标签维度拆分统计， 例如按 method、status 分别统计请求数。

参数：

• name: 指标名称
• help: 指标描述
• labels: 标签名列表，如 []string{"method", "status"}

func NewGauge

func NewGauge(name, help string) prometheus.Gauge

NewGauge 创建自定义仪表

func NewHistogram

func NewHistogram(name, help string, buckets []float64) prometheus.Histogram

NewHistogram 创建自定义 Prometheus Histogram（直方图）。 Histogram 将观测值分桶统计，适用于请求耗时、响应大小等分布型指标， 并自动计算 _count、_sum 和各分位数。

参数：

• name: 指标名称
• help: 指标描述
• buckets: 分桶边界值，如 []float64{0.01, 0.05, 0.1, 0.5, 1, 5}

func StartCollector

func StartCollector(ctx context.Context, interval time.Duration)

StartCollector 启动指标收集器 定期收集数据库和 Redis 连接池指标