监控metrics系列——Prometheus Client_golang使用指南

2024-08-10 23:55:14作者：范靓好Udolf

一、项目介绍

Prometheus Client_golang是Prometheus监控生态系统中的重要组件之一，专门为Golang应用程序提供了Prometheus监控指标的嵌入式工具包。此库支持Prometheus的数据采集标准和API，允许您轻松地在Golang服务中添加监控功能。

主要特性

简单易用: 提供了一系列API简化在Golang服务中增加监控指标的过程。
功能完备: 支持多种类型的度量类型，包括计数器、摘要、直方图等。
高度兼容性: 严格遵循Prometheus的数据模型，确保无缝集成至Prometheus服务器或Grafana视图。

核心组件

prometheus: 核心仪表盘库，用于创建各种类型的度量。
examples: 示例目录，展示了如何使用Client_golang进行常用操作和高级用例。
api: 包含了对Prometheus HTTP API的客户端绑定。

版本要求

Prometheus Client_golang要求至少使用Go1.20版本，对于旧版本的Go（如Go1.17），虽然可以运行，但是只保证最新三个主要版本的支持。

二、项目快速启动

要在您的Golang项目中引入Prometheus Client_golang并立即开始监控，您可以参考以下步骤：

第一步：导入库

首先，在你的main.go文件或适当的初始化文件中，导入必要的Client_golang包：

import (
    "github.com/prometheus/client_golang/prometheus"
    "github.com/prometheus/client_golang/prometheus/promhttp"
)

第二步：注册度量

接下来，定义并注册您的第一个监控指标：

var myCounter = prometheus.NewCounter(
    prometheus.CounterOpts{
        Name: "my_service_requests_total",
        Help: "Total number of service requests.",
    },
)

func init() {
    // Register your metric with the global registry.
    prometheus.MustRegister(myCounter)
}

第三步：更新度量值

每次当您的服务处理完一个请求，即可更新此计数器：

// Increment the counter each time a request completes.
myCounter.Inc()

第四步：启动HTTP服务

最后，启动一个HTTP服务以暴露Prometheus格式的指标数据给监控代理：

func main() {
    // Expose the registered metrics via HTTP.
    http.Handle("/metrics", promhttp.Handler())
    log.Fatal(http.ListenAndServe(":8080", nil))
}

三、应用案例和最佳实践

案例分析：记录RPC延迟分布

作为示例，我们可以采用随机分布（均匀、正态、指数）来表示虚构的RPC延迟性能，并将其作为Prometheus监控指标进行曝光：

package main

import (
	"math/rand"
	"time"

	"github.com/prometheus/client_golang/prometheus"
	"github.com/prometheus/client_golang/prometheus/promhttp"
	"net/http"
	"log"
)

var uniformLatency = prometheus.NewHistogram(prometheus.HistogramOpts{
	Name: "rpc_uniform_latency_seconds",
	Help: "Latency distribution of uniform random RPCs.",
	Buckets: []float64{0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1},
})

var normalLatency = prometheus.NewHistogram(prometheus.HistogramOpts{
	Name: "rpc_normal_latency_seconds",
	Help: "Latency distribution of normally distributed RPCs.",
	Buckets: prometheus.ExponentialBuckets(0.001, 2, 10),
})

var expLatency = prometheus.NewHistogram(prometheus.HistogramOpts{
	Name: "rpc_exponential_latency_seconds",
	Help: "Latency distribution of exponentially distributed RPCs.",
	Buckets: prometheus.ExponentialBuckets(0.001, 2, 10),
})

func init() {
	prometheus.MustRegister(uniformLatency, normalLatency, expLatency)
}

func recordRandomLatency() float64 {
	return rand.ExpFloat64()*rand.NormFloat64() + rand.Float64()
}

func main() {
	http.Handle("/metrics", promhttp.Handler())

	for {
		lat := recordRandomLatency()
		uniformLatency.Observe(lat)
		normalLatency.Observe(lat)
		expLatency.Observe(lat)
		time.Sleep(time.Millisecond * 10)
	}
	log.Fatal(http.ListenAndServe(":8080", nil))
}