metrics

README

metrics

Prometheus 指标门面——framework-agnostic Registry 与弹性指标族。

项目主页：https://oekit.github.io/ · 名称由来：Open Easy Kit（开源 · 易用 · 工具集合） 🤖 AI Agent：本仓规范与硬规则见 AGENTS.md；机器可读索引见 llms.txt（接口签名以源码为准）。

本仓库是 ekit（git.enjoye.top/enjoydream/ekit v0.34.0） 拆分出的独立 Go module，属于 oekit（Open Easy Kit）模块矩阵。

安装

go get github.com/oekit/metrics@v0.1.4

能做什么

• Init(serviceName)：一键初始化统一 Registry
• 弹性指标族：熔断状态/迁移/拒绝/重试计数，httpx/nns-endpoint/kitex 三路共享契约
• 配合 oekit/hertz 的 /metrics 端点暴露

使用示例

接入

import "github.com/oekit/metrics"

metrics.Init("my-service") // 之后 hertz 挂 /metrics 端点即可被抓取

自定义 Registry

h.GET("/metrics", hertzmetrics.MetricsHandlerFor(myRegistry))

包清单

• 根包 `metrics`（import `github.com/oekit/metrics`）— Registry、Init(service)、默认注册
• `resilience/` — 熔断/重试共享指标族（httpx/nns/kitex 共用，契约 §5.5）

矩阵总览（23 活跃模块，自动生成）

模块	内容	矩阵内依赖
pkg	微工具集 16 合 1（errors/validator/stringx/slicex/enumx/convert/encoding/jsonrepair/httpjson/mathx/pathx/pagination/ptrx/timex/uidgen/cache）	—
concurrency	并发与流控原语（async/group/singleflight/progress/syncx/ratelimit/retry）	—
logx	统一日志门面（多后端可替换 + Sink + caller 归属）+ 优雅关停	—
core	应用基建件（governance 治理 schema / lifecycle 契约 / network IP 工具 / version）	—
istio	Istio Proxyless——Kitex xDS 动态熔断	—
metrics	Prometheus 门面 + 弹性指标族	core
tracing	OpenTelemetry 追踪 + trace_id 真相源	logx
registry	注册发现核心 + Nacos 实现 + 配置加载 + sdbridge	core、logx
data	缓存检查器（TTL/failTTL/inflight 合并）+ LocalCache	concurrency、logx
gorm	SQL/GORM 全家——连接池增强、框架无关 CRUD Service、仓储	logx、pkg
redis	Redis 全家——客户端封装、缓存后端、分布式锁	concurrency、data、logx
httpx	HTTP 客户端 + 负载均衡——服务发现/熔断/重试/指标/OTel 透传	concurrency、core、logx、metrics、registry、tracing
network	轻量网络客户端——WebSocket/NATS/MQ 抽象、连接与流工具、Octopus 推送	concurrency、logx、tracing
timertask	分片定时任务（FNV-1a、心跳续约）	concurrency、logx
middleware	Hertz 自研标准中间件栈 + contrib 桥接 + hmw	concurrency、core、logx、metrics、pkg、registry、tracing
nns	NNS 服务治理客户端——provider 无关发现/配置/实例缓存	concurrency、core、logx、registry
nns-endpoint	NNS 端点工厂——per-service 熔断、换实例重试、gRPC 池	concurrency、core、httpx、logx、metrics、nns、registry
bootstrap	应用生命周期引导——bootstrap.Run 骨架 + healthz	concurrency、logx
handler	HTTP handler 层——通用 CRUD Handler、参数绑定、版本端点	concurrency、core、gorm、logx、metrics、middleware、pkg、registry、tracing
hertz	Hertz 运行时集成——日志桥接、生命周期、SSE/health/metrics、适配器、OTel	bootstrap、concurrency、core、logx、metrics、nns、registry、tracing
kitex	Kitex 生态——日志桥接、治理热更、生命周期、BizError 桥接、kitexotel	bootstrap、concurrency、core、logx、metrics、nns、pkg、registry、tracing
workflow	组合式流程编排——串行/并行/异步/条件分支 + Hook AOP	concurrency、logx
kitex-examples	Kitex echo 示例——client/server + IDL + 治理配置	bootstrap、concurrency、core、kitex、logx、metrics、nns、registry、tracing

当前仓库依赖

详见上方矩阵表中本仓库行。

与 ekit 单体仓库的关系

• 代码与 ekit v0.34.0 等价，module 路径 git.enjoye.top/enjoydream/ekit/... → github.com/oekit/metrics/...
• 各子仓库独立发版（SemVer）；开发规范沿用 ekit AGENTS.md 约定

License

见 LICENSE

Documentation

Overview

Package metrics 提供通用的 Prometheus 指标注册和初始化（framework-agnostic）。

所有 enjoydream 后端服务共享此包，保持指标命名和标签的一致性。 本包只暴露 Registry 与指标类型，不绑定任何 HTTP 框架； HTTP 适配器位于 hertz.MetricsHandler / hertz.MetricsHandlerFor / hertz.InitAndRegister。

提供的指标

• app_build_info{service, commit, branch, build_time, go_version} — 构建信息
• app_start_time_seconds — 进程启动时间戳

快速接入

在 main.go 中：

metrics.Init("my-service")
// Hertz 适配器：
r.GET("/metrics", hertz.MetricsHandler())
// 或使用自定义 Registry（推荐与 middleware.PrometheusMetrics 共享）：
r.GET("/metrics", hertz.MetricsHandlerFor(metrics.Registry))

build.sh 改动

所有服务改为注入 ekit/version 包的变量：

MOD="github.com/oekit/metrics"
LDFLAGS="-X ${MOD}/version.BuildCommit=${GIT_COMMIT} ..."

自定义 Registry

使用独立的 Registry 避免与全局 prometheus.DefaultRegistry 冲突：

registry := metrics.Registry
// 传给 middleware.NewPrometheusMetrics 或 hertz.MetricsHandlerFor

Index

• Variables
• func Init(serviceName string)

Variables

var (
	// BuildInfo 暴露构建元数据（commit、branch、build_time、go_version）。
	BuildInfo = prometheus.NewGaugeVec(prometheus.GaugeOpts{
		Name: "app_build_info",
		Help: "Build information about the service",
	}, []string{"service", "commit", "branch", "build_time", "go_version"})

	// StartTimeSeconds 记录进程启动的 Unix 时间戳。
	StartTimeSeconds = prometheus.NewGauge(prometheus.GaugeOpts{
		Name: "app_start_time_seconds",
		Help: "Unix timestamp of service start time",
	})
)

var Registry = prometheus.NewRegistry()

Registry 是自定义的 Prometheus 注册器。 传入 ekit/middleware 的 PrometheusMetrics 时使用，避免全局 Registry 冲突。

Functions

func Init

func Init(serviceName string)

Init 注册所有通用指标并设置初始值。 参数 serviceName 用于 app_build_info 的 service 标签，如 "fuxi_engine"、"moyu-server"。 必须在 main.go 中调用，且在启动 Hertz server 之前。 多次调用是安全的，只有第一次调用会注册指标。