✨ feat(metrics): 为监控指标添加构建信息 (#34)

* ✨ feat(metrics): 为监控指标添加构建信息

- 在 Metrics 结构体中新增版本、Git 提交、Go 版本、操作系统架构和构建时间字段
- 新增 build_info 指标用于暴露应用构建信息
- 更新 NewMetrics 函数签名以接收构建信息参数

🌈 style(metrics): 优化代码格式和结构

- 调整代码缩进和空行以提升可读性
- 规范化指标标签名称使用下划线分隔

* 📝 docs(README): Add build_info metric documentation.

- Add build_info metric description in both English and Chinese README files.
- Include detailed metric configuration examples with version, git_commit, go_version, os_arch and build_time fields.

* 🐛 fix(export): 修正结构体字段命名不一致问题

- 将 `gitCommit` 字段重命名为 `goVersion`，确保字段命名与实际用途一致

Author: eryajf

README-en.md

@@ -76,13 +76,21 @@ The indicators provided by this project include the following:
 
 | NAME               | Description                 |
 | ------------------ | -------------------- |
+| `build_info`       | Build Information             |
 | `domain_list`      | Domain Name List             |
 | `record_list`      | Domain name resolution record list     |
 | `record_cert_info` | Parse record certificate information list |
 
 Indicator label description：
 
 ```
+<!-- Build Information -->
+build_info{
+    version="version number",
+    git_commit="git commit number",
+    go_version="go version",
+    os_arch="system architecture",
+    build_time="build time"} 1
 <!-- Domain Name List -->
 domain_list{
     cloud_provider="DNS Provider",

README.md

@@ -78,13 +78,21 @@ docker-compose up -d
 
 | 名称               | 说明                 |
 | ------------------ | -------------------- |
+| `build_info`       | 构建信息             |
 | `domain_list`      | 域名列表             |
 | `record_list`      | 域名解析记录列表     |
 | `record_cert_info` | 解析记录证书信息列表 |
 
 指标标签说明：
 
 ```
+<!-- 构建信息 -->
+build_info{
+    version="版本号",
+    git_commit="git提交号",
+    go_version="go版本",
+    os_arch="系统架构",
+    build_time="构建时间"} 1
 <!-- 域名列表 -->
 domain_list{
     cloud_provider="DNS提供商",

pkg/cmd/root.go

@@ -55,7 +55,8 @@ var rootCmd = &cobra.Command{
 }
 
 func RunServer() {
-	metrics := export.NewMetrics("")
+	osArch := fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH)
+	metrics := export.NewMetrics("", Version, GitCommit, runtime.Version(), osArch, BuildTime)
 	registory := prometheus.NewRegistry()
 	registory.MustRegister(metrics)
 

pkg/export/export_gauge.go

@@ -14,8 +14,13 @@ import (
 
 // 指标结构体
 type Metrics struct {
-	metrics map[string]*prometheus.Desc
-	mutex   sync.Mutex
+	metrics   map[string]*prometheus.Desc
+	mutex     sync.Mutex
+	version   string
+	gitCommit string
+	goVersion string
+	osArch    string
+	buildTime string
 }
 
 // newGlobalMetric 创建指标描述符
@@ -28,8 +33,13 @@ func newGlobalMetric(namespace string, metricName string, docString string, labe
 }
 
 // NewMetrics 初始化指标信息，即Metrics结构体
-func NewMetrics(namespace string) *Metrics {
+func NewMetrics(namespace, version, gitCommit, goVersion, osArch, buildTime string) *Metrics {
 	return &Metrics{
+		version:   version,
+		gitCommit: gitCommit,
+		goVersion: goVersion,
+		osArch:    osArch,
+		buildTime: buildTime,
 		metrics: map[string]*prometheus.Desc{
 			public.DomainList: newGlobalMetric(namespace,
 				public.DomainList,
@@ -82,6 +92,16 @@ func NewMetrics(namespace string) *Metrics {
 					"cert_matched",
 					"error_msg",
 				}),
+			public.BuildInfo: newGlobalMetric(namespace,
+				public.BuildInfo,
+				"Application build information",
+				[]string{
+					"version",
+					"git_commit",
+					"go_version",
+					"os_arch",
+					"build_time",
+				}),
 		},
 	}
 }
@@ -178,4 +198,16 @@ func (c *Metrics) Collect(ch chan<- prometheus.Metric) {
 			ch <- prometheus.MustNewConstMetric(c.metrics[public.RecordCertInfo], prometheus.GaugeValue, float64(v.DaysUntilExpiry), v.CloudProvider, v.CloudName, v.DomainName, v.RecordID, v.FullRecord, v.SubjectCommonName, v.SubjectOrganization, v.SubjectOrganizationalUnit, v.IssuerCommonName, v.IssuerOrganization, v.IssuerOrganizationalUnit, v.CreatedDate, v.ExpiryDate, fmt.Sprintf("%t", v.CertMatched), v.ErrorMsg)
 		}
 	}
+
+	// build info metric
+	ch <- prometheus.MustNewConstMetric(
+		c.metrics[public.BuildInfo],
+		prometheus.GaugeValue,
+		1,
+		c.version,
+		c.gitCommit,
+		c.goVersion,
+		c.osArch,
+		c.buildTime,
+	)
 }

public/public.go

@@ -33,6 +33,7 @@ const (
 	DomainList     string = "domain_list"
 	RecordList     string = "record_list"
 	RecordCertInfo string = "record_cert_info"
+	BuildInfo      string = "build_info"
 	// Cron Config Defaults
 	DefaultDomainRecordSyncInterval = 30   // 默认域名记录同步间隔（秒）
 	DefaultCertInfoSyncInterval     = 3600 // 默认证书信息同步间隔（秒），24小时