Go 語言開發的基于指標的監控系統 Prometheus
01 介紹
Go 語言開發的基于指標的監控系統 Prometheus，主要采用拉取方式收集監控數據，通過 Pushgateway 也可以采用推送方式收集監控數據。
關于 Prometheus 的客戶端庫和 PromQL 的使用，是 Go 開發者重點需要掌握的部分。
本文我們介紹通過使用 Prometheus 官方提供的 golang 客戶端庫，使用 Counter 數據類型記錄 HTTP 接口的調用量。
02 安裝、啟動 Prometheus server
Prometheus server 可以直接使用二進制文件的方式安裝，在 Prometheus 官網[1]下載二進制文件，示例：
- 下載二進制文件。
- 解壓縮二進制文件。
- 啟動 Prometheus server。
cd ~/Download
wget https://github.com/prometheus/prometheus/releases/download/v2.48.0-rc.2/prometheus-2.48.0-rc.2.darwin-amd64.tar.gz
tar zxvf prometheus-2.48.0-rc.2.darwin-amd64.tar.gz
cd prometheus-2.48.0-rc.2.darwin-amd64
ll
total 472152
-rw-r--r--@ 1 frank staff 11357 10 13 00:41 LICENSE
-rw-r--r--@ 1 frank staff 3773 10 13 00:41 NOTICE
drwxr-xr-x@ 4 frank staff 128 10 13 00:41 console_libraries
drwxr-xr-x@ 9 frank staff 288 10 13 00:41 consoles
-rwxr-xr-x@ 1 frank staff 123733776 10 13 00:09 prometheus
-rw-r--r--@ 1 frank staff 934 10 13 00:41 prometheus.yml
-rwxr-xr-x@ 1 frank staff 117982832 10 13 00:11 promtool
./prometheus --config.file=prometheus.yaml啟動 Prometheus server 后，可以在瀏覽器訪問 http://localhost:9090/graph，查看 Prometheus 提供的可視化控制面板，也可以使用 Grafana。
03 Golang 客戶端庫
安裝并成功啟動 Prometheus server 后，我們就可以通過 Prometheus 官方提供的 Golang 客戶端庫在我們的 Go 項目代碼埋點。
Prometheus client 支持 4 種數據類型，分別是 Counter、Gauge、Histogram 和 Summary。
本文我們以 Counter 數據類型為例，介紹如何在 Go 項目中使用 Prometheus go client 庫的函數埋點。
所謂埋點，就是在我們的 Go 項目中，導入 github.com/prometheus/client_golang/prometheus，調用庫函數，記錄監控數據。
示例代碼：
package prom
import "github.com/prometheus/client_golang/prometheus"
var (
labelNames = []string{"service", "code", "path", "method"}
RequestCounter = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "http_request_count_total",
Help: "Total number of HTTP requests made.",
}, labelNames,
)
)
func init() {
prometheus.MustRegister(RequestCounter)
}閱讀上面這段代碼，我們調用 prometheus.NewCounterVec()，記錄 HTTP 接口的調用量。
我們為 HTTP 接口定義 4 個標簽，分別是 service，code，path，method。
然后通過 /metrics 接口，讓 Prometheus server 拉取數據。
curl http://localhost:8080/metrics
// ...
# HELP http_request_count_total Total number of HTTP requests made.
# TYPE http_request_count_total counter
http_request_count_total{code="200",method="GET",path="/metrics",service="example-service"} 3
http_request_count_total{code="200",method="GET",path="/ping",service="example-service"} 2
// ...04 修改配置文件
接下來，我們需要修改 YAML 格式的配置文件 prometheus.yaml，添加一個 job。
scrape_configs:
# The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
- job_name: "prometheus"
# metrics_path defaults to '/metrics'
# scheme defaults to 'http'.
static_configs:
- targets: ["localhost:9090"]
# Example service
- job_name: "example-service"
static_configs:
- targets: ["localhost:8080"]閱讀上面這段代碼，我們在 prometheus.yaml 的 scrape_configs 部分，添加一個 job。
然后重啟 Prometheus server，使修改后的配置文件生效。
05 總結
本文我們通過示例，介紹怎么使用 Prometheus 監控 Go 項目，讀者朋友們可以參照文章，動手操作一遍。
感興趣的讀者朋友們，閱讀 Prometheus golang client[2] 官方文檔，了解更多。
