gmetrics

Introduction

gmetrics是对gin接入Prometheus的封装

默认记录gin http server的指标，支持传入自定义指标，自定义处理函数

Default Metrics

Usage

四种指标类型及对应操作

Counter：Inc、Add

Gauge：Inc、Add、Set

Histogram：Observe

Summary：Observe

option

WithCloseDefault：关闭默认指标

WithExtraMetricHandle：扩展gin中间件自定义metrics处理

WithMetricPath： 定义metrics访问路径

WithReqDuration：定义gin_request_duration请求时间统计维度，[]float64{0.1, 0.5, 1, 5}

WithExcludeFn：过滤掉不需要的path

WithBloomFilter：自定义统计uv的BloomFilter，默认内存版，多实例可使用Redis版（需要注意清理），不统计传入nil

实例

中间件使用见 example 内

import  "github.com/SigmaGavin/slardar/pkg/gmetrics"

......
got, err := gmetrics.NewMonitor("nameSpace", nil) // 初始化metrics
if err != nil {
	log.Fatal(err)
}
r := gin.Default()
err = got.Use(r) // 注册自定义metrics路由
if err != nil {
	log.Fatal(err)
}
......

Grafana

提供默认的图标供参考，可以修改配置导入使用。

接入参考：

替换配置json中的metrics名称，主要为命名空间的替换，如dap_gin_request_total --> {{yours namespace}}_gin_request_total，名字替换完成后，在grafana中导入配置，即可显示指标看板。

参考的grafana图表，Grafana configuration。

AlertManager

告警等级示例

• warning
• critical

告警规则示例

通用规则（对于默认指标的告警规则）

业务规则（根据业务自定义的指标的告警规则）

接入参考：

告警rule文件中修改alert告警规则：

替换alert.expr中指标名称，如dap_gin_request_total --> {{yours namespace}}_gin_request_total；

修改group.name和alert.team名称，与运维确定告警所需要的label；

将告警规则文件和飞书群ID给到运维进行配置。

参考的告警规则，Alert rule。