prometheus client_golang 使用详解

Prometheus 是一个开源的监控和警报工具包,用于收集和处理应用程序和系统的指标数据。Prometheus 提供了多种客户端库,可以轻松地集成到各种编程语言中。这里我们详细讲解如何在 Go 语言(Golang)应用程序中使用 Prometheus 的 client_golang 库。

1、安装 Prometheus Go 客户端库:

在你的 Go 项目中,使用以下命令安装 Prometheus Go 客户端库:

go get github.com/prometheus/client_golang/prometheus
go get github.com/prometheus/client_golang/prometheus/promhttp

2、引入库并定义指标:

package main

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

在这里,我们引入了 Prometheus 客户端库,并定义了一个简单的 HTTP 服务器。接下来,我们将定义一些 Prometheus 指标,例如计数器(Counter)、仪表(Gauge)和直方图(Histogram)。

// Counter 示例
var httpRequestsTotal = prometheus.NewCounterVec(
	prometheus.CounterOpts{
		Name: "http_requests_total",
		Help: "Number of HTTP requests",
	},
	[]string{"method", "path"},
)

// Gauge 示例
var systemLoad = prometheus.NewGauge(
	prometheus.GaugeOpts{
		Name: "system_load",
		Help: "Current system load",
	},
)

// Histogram 示例
var requestDuration = prometheus.NewHistogram(
	prometheus.HistogramOpts{
		Name:    "request_duration_seconds",
		Help:    "Histogram of the duration of HTTP requests",
		Buckets: prometheus.DefBuckets,
	},
)

3、注册指标:

在 init 函数中,我们需要注册这些指标,以便 Prometheus 能够收集它们:

func init() {
	prometheus.MustRegister(httpRequestsTotal)
	prometheus.MustRegister(systemLoad)
	prometheus.MustRegister(requestDuration)
}

4、更新指标:

在你的应用程序中,你需要更新这些指标以反映当前状态。例如,在 HTTP 服务器中,我们可以记录每个请求的数量、系统负载和请求持续时间:

http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
	httpRequestsTotal.With(prometheus.Labels{"method": r.Method, "path": r.URL.Path}).Inc()

	// 更新 Gauge
	systemLoad.Set(getSystemLoad())

	timer := prometheus.NewTimer(requestDuration)
	defer timer.ObserveDuration()

	w.Write([]byte("Hello, world!"))
})

在这个例子中,我们首先增加了 httpRequestsTotal 计数器。然后,我们更新了 systemLoad 仪表。接着,我们使用 NewTimer 函数创建了一个新的计时器,它会在请求处理完成时自动更新 requestDuration 直方图。

5、暴露指标:

最后,我们需要暴露这些指标,以便 Prometheus 能够抓取它们。我们可以使用 promhttp.Handler() 函数创建一个 HTTP处理程序,并将其添加到我们的 HTTP 服务器中:

// 暴露 Prometheus 指标端点
http.Handle("/metrics", promhttp.Handler())
http.ListenAndServe(":8080", nil)

这将在我们的 HTTP 服务器上添加一个 “/metrics” 端点,Prometheus 将从该端点抓取指标数据。

6、配置并运行 Prometheus:

创建一个名为 prometheus.yml 的配置文件,指向你的 Go 应用程序实例:

global:
  scrape_interval: 15s

scrape_configs:
  - job_name: 'go_app'
    static_configs:
      - targets: ['localhost:8080']

使用以下命令启动 Prometheus,并指定配置文件:

./prometheus --config.file=prometheus.yml

现在,Prometheus 会定期从你的 Go 应用程序抓取指标。你可以在 Prometheus Web UI(默认为 http://localhost:9090)上查询和查看这些指标。

7、使用 Grafana 可视化指标:

如果你想以更直观的方式查看指标数据,可以使用 Grafana。首先,安装并运行 Grafana,然后添加 Prometheus 数据源。接下来,创建一个新的仪表板,向其中添加图表和面板,以展示你的 Go 应用程序中的指标。例如,你可以创建一个图表,显示随时间变化的 HTTP 请求总数,或者创建一个面板,显示当前的系统负载。

你可能感兴趣的:(prometheus,golang,开发语言)