go exporter开发 第一篇

161 阅读3分钟

为什么go程序要采集指标?

通过采集指标,可以从外部观测到程序运行中的一些运行中的数据,比如协程数,web请求的接口等情况,从而进一步分析程序是否有不退出的协程,以及性能,是否存在内存泄漏,通过对接Prometheus,能够观测接口请求时间,访问量,访问成功和访问失败等

一、使用

package main

import (
	"strconv"
	"time"

	"github.com/gin-gonic/gin"
	"github.com/prometheus/client_golang/prometheus"
	"github.com/prometheus/client_golang/prometheus/promhttp"
)

func main() {
	router := gin.New()
	router.Use(Prometheus())

	router.GET("/metrics", gin.WrapH(promhttp.Handler()))
	router.GET("/", func(ctx *gin.Context) {
		ctx.Writer.Write([]byte("test"))
	})
	router.Run(":38010")
}

var (
	requestsTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "http_requests_total",
			Help: "Total number of HTTP requests processed",
		},
		[]string{"uri", "method", "status"},
	)

	requestDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "http_request_duration_seconds",
			Help:    "Histogram of request duration for HTTP handler",
			Buckets: prometheus.DefBuckets,
		},
		[]string{"uri", "method", "status"},
	)
)

func init() {
	prometheus.MustRegister(requestsTotal)
	prometheus.MustRegister(requestDuration)
}

func Prometheus() gin.HandlerFunc {
	return func(c *gin.Context) {
		start := time.Now()

		// Process request
		c.Next()

		// Record metrics
		duration := time.Since(start).Seconds()
		// uri := c.FullPath()
		uri := c.Request.URL.Path
		method := c.Request.Method
		status := c.Writer.Status()

		requestsTotal.WithLabelValues(uri, method, strconv.Itoa(status)).Inc()
		requestDuration.WithLabelValues(uri, method, strconv.Itoa(status)).Observe(duration)
	}
}

二、自带Go指标

1、含义

go_* 表示这个采集器使用go编写的,并且这个采集器暴露的go相关指标

go_gc_duration_seconds{quantile="0"}:表示垃圾回收的最小持续时间,单位秒 go_gc_duration_seconds{quantile="0.25"}:表示垃圾回收的第25个百分位的值,单位秒 go_gc_duration_seconds{quantile="0.5"}:表示垃圾回收的中位数(第50个百分位的值),单位秒 go_gc_duration_seconds{quantile="0.75"}:表示垃圾回收的第75个百分位的值,单位秒 go_gc_duration_seconds{quantile="1"}:表示垃圾回收的最大持续时间,单位秒

go_gc_duration_seconds_sum:检测期间累积的垃圾回收总持续时间 go_gc_duration_seconds_count:检测期间总共的gc次数

go_goroutines:当前协程数

go_info{version="go1.22.0"}:go信息,label标签是版本,值是1

go_memstats_alloc_bytes{}:当前已分配且仍在使用的字节数 go_memstats_alloc_bytes_total{}:已分配的总字节数,包括已释放和仍在使用的字节数 go_memstats_back_hash_sys_bytes{} 含义:当前在使用map所使用的内存数 类型:gauge go_memstats_frees_total{} 含义:总是否内存次数 类型:counter go_memstats_gc_sys_bytes{} 含义:gc元数据所使用的字节数 类型:gauge go_memstats_heap_alloc_byte{} 含义:当前仍在使用堆内存分配的字节数 类型:gauge go_memstats_heap_idle_bytes{} 含义:等待被使用的堆内存字节数 类型:gauge go_memstats_heap_inuse_bytes{} 含义:当前正在使用的堆内存使用字节数 类型:gauge go_memstats_heap_objects{} 含义:当前已分配的对象数 类型:gauge 用处:通过观察一段时间的对象数,进一步知道是不是存在已分配的对象数是不是太多以及间接去观察是否存在对象不断被分配和释放 go_memstats_heap_released_bytes{} 含义:已释放给操作系统的堆内存字节数 类型:gauge 用处:通过观察这个数据,去优化程序,对很多程序减少内存分配释放的资源消耗 go_memstats_heap_sys_bytes{} 含义:从操作系统获取的堆内存字节数 类型:gauge go_memstats_last_gc_time_seconds{} 含义:最后一次gc的时间戳 类型:gauge go_memstats_lookups_total{}

2、作用

监控协程是否有僵死协程 监控是否会有内存泄漏

三、参考文档