使用golang生成prometheus格式數(shù)據(jù)
Prometheus是一個(gè)開源的監(jiān)控系統(tǒng),擁有許多Advanced Feature,他會(huì)定期用HTTP協(xié)議來pull所監(jiān)控系統(tǒng)狀態(tài)進(jìn)行數(shù)據(jù)收集,在加上timestamp等數(shù)據(jù)組織成time series data,用metric name和label來標(biāo)識(shí)不同的time series,用戶可以將數(shù)據(jù)用可視化工具顯示出來,并設(shè)置報(bào)警閾值進(jìn)行報(bào)警。
本文將介紹Primetheus client的使用,基于golang語言,golang client 是當(dāng)pro收集所監(jiān)控的系統(tǒng)的數(shù)據(jù)時(shí),用于響應(yīng)pro的請(qǐng)求,按照一定的格式給pro返回?cái)?shù)據(jù),說白了就是一個(gè)http server。
1. 何為exporter
Prometheus 監(jiān)控基于一個(gè)很簡(jiǎn)單的模型: 主動(dòng)抓取目標(biāo)的指標(biāo)接口(HTTP 協(xié)議)獲取監(jiān)控指標(biāo), 再存儲(chǔ)到本地或遠(yuǎn)端的時(shí)序數(shù)據(jù)庫. Prometheus 對(duì)于指標(biāo)接口有一套固定的格式要求, 格式大致如下:
# HELP http_requests_total The total number of HTTP requests.
# TYPE http_requests_total counter
http_requests_total{method="post",code="200"} 1027
http_requests_total{method="post",code="400"} 3
對(duì)于自己寫的代碼, 我們當(dāng)然可以使用 Prometheus 的 SDK 暴露出上述格式的指標(biāo). 但對(duì)于大量現(xiàn)有服務(wù), 系統(tǒng)甚至硬件, 它們并不會(huì)暴露 Prometheus 格式的指標(biāo).
比如說:
- Linux 的很多指標(biāo)信息以文件形式記錄在 proc 下的各個(gè)目錄中, 如 /proc/meminfo 里記錄內(nèi)存信息, /proc/stat 里記錄 CPU 信息;
- Redis 的監(jiān)控信息需要通過 INFO 命令獲取;
- 路由器等硬件的監(jiān)控信息需要通過 `SNMP 協(xié)議獲取;
- …
要監(jiān)控這些目標(biāo), 我們有兩個(gè)辦法, 一是改動(dòng)目標(biāo)系統(tǒng)的代碼, 讓它主動(dòng)暴露 Prometheus 格式的指標(biāo), 當(dāng)然, 對(duì)于上述幾個(gè)場(chǎng)景這種辦法完全是不現(xiàn)實(shí)的.
這時(shí)候就只能采用第二種辦法:
編寫一個(gè)代理服務(wù), 將其它監(jiān)控信息轉(zhuǎn)化為 Prometheus 格式的指標(biāo)——這個(gè)代理服務(wù)就是exporter
2. exporter簡(jiǎn)介
廣義上講所有可以向Prometheus提供監(jiān)控樣本數(shù)據(jù)的程序都可以被稱為一個(gè)Exporter。而Exporter的一個(gè)實(shí)例稱為target。
從Exporter的來源上來講,主要分為兩類:
1.社區(qū)提供的
Prometheus社區(qū)提供了豐富的Exporter實(shí)現(xiàn),涵蓋了從基礎(chǔ)設(shè)施,中間件以及網(wǎng)絡(luò)等各個(gè)方面的監(jiān)控功能。這些Exporter可以實(shí)現(xiàn)大部分通用的監(jiān)控需求。
https://exporterhub.io/
2.用戶自定義的
除了直接使用社區(qū)提供的Exporter程序以外,用戶還可以基于Prometheus提供的Client Library創(chuàng)建自己的Exporter程序,目前Promthues社區(qū)官方提供了對(duì)以下編程語言的支持:Go、Java/Scala、Python、Ruby。同時(shí)還有第三方實(shí)現(xiàn)的如:Bash、C++、Common Lisp、Erlang,、Haskeel、Lua、Node.js、PHP、Rust等。
prometheus四種類型的指標(biāo)Counter 計(jì)數(shù),Gauge 觀測(cè)類,Histogram 直方,Summary 摘要 用golang語言如何構(gòu)造這4種類型對(duì)應(yīng)的指標(biāo),二是搞清楚修改指標(biāo)值的場(chǎng)景和方式。
在prometheus中如果要監(jiān)控服務(wù)器和應(yīng)用的各種指標(biāo),需要用各種各樣的exporter服務(wù),例如node_exportes、mysql_exportes、pgsql_exportes等。這些都是官方或者第三方已經(jīng)提供好的。
但是如果自己想要監(jiān)控一些其它exportes沒有的指標(biāo),則就需要自己去構(gòu)建一個(gè)屬于自己的exportes,好在官方提供相關(guān)的庫,目前支持以下語言:
官方支持語言:
- Go
- Java or Scala
- Python
- Ruby
- Rust
3. exporter編寫指導(dǎo)
Prometheus 官方文檔中 Writing Exporter 這篇寫得非常全面, 假如你要寫 exporter 推薦先通讀一遍, 限于篇幅, 這里只概括一下:
做到開箱即用(默認(rèn)配置就可以直接開始用)
推薦使用 YAML 作為配置格式
指標(biāo)使用下劃線命名
為指標(biāo)提供 HELP String (指標(biāo)上的 # HELP 注釋, 事實(shí)上這點(diǎn)大部分 exporter 都沒做好)
為 Exporter 本身的運(yùn)行狀態(tài)提供指標(biāo)
可以提供一個(gè)落地頁
metric的類型
在開始之前需要了解下metric的類型劃分
要在Golang中生成Prometheus數(shù)據(jù),你可以使用Prometheus的官方客戶端庫 prometheus/client_golang。這個(gè)庫允許你定義和暴露自定義的指標(biāo),并通過HTTP端點(diǎn)將這些指標(biāo)暴露給Prometheus服務(wù)器。
以下是一個(gè)簡(jiǎn)單的示例,展示如何使用Golang生成Prometheus數(shù)據(jù):
4. 安裝依賴
首先,你需要安裝Prometheus的Golang客戶端庫:
go get github.com/prometheus/client_golang/prometheus go get github.com/prometheus/client_golang/prometheus/promhttp
5. 編寫代碼
接下來,編寫一個(gè)簡(jiǎn)單的Golang程序來生成和暴露Prometheus指標(biāo)。
package main import ( "net/http" "time" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promhttp" ) func main() { // 創(chuàng)建一個(gè)自定義的Gauge指標(biāo) customMetric := prometheus.NewGauge(prometheus.GaugeOpts{ Name: "my_custom_metric", Help: "This is a custom metric", }) // 注冊(cè)指標(biāo) prometheus.MustRegister(customMetric) // 啟動(dòng)一個(gè)goroutine來更新指標(biāo)值 go func() { for { // 模擬一些業(yè)務(wù)邏輯,更新指標(biāo)值 customMetric.Set(float64(time.Now().Unix())) time.Sleep(10 * time.Second) } }() // 暴露指標(biāo)端點(diǎn) http.Handle("/metrics", promhttp.Handler()) http.ListenAndServe(":8080", nil) }
6. 運(yùn)行程序
運(yùn)行這個(gè)Golang程序:
go run main.go
程序?qū)⒃诒镜氐?080端口上啟動(dòng)一個(gè)HTTP服務(wù)器,并暴露 /metrics 端點(diǎn)。
7. 訪問指標(biāo)
你可以通過瀏覽器或 curl 命令訪問 http://localhost:8080/metrics,查看生成的Prometheus指標(biāo)。
curl http://localhost:8080/metrics
你應(yīng)該會(huì)看到類似以下的輸出:
# HELP my_custom_metric This is a custom metric
# TYPE my_custom_metric gauge
my_custom_metric 1.623456789e+09
8. 配置Prometheus
最后,你需要在Prometheus的配置文件中添加這個(gè)目標(biāo),以便Prometheus服務(wù)器可以定期抓取這些指標(biāo)。
在 prometheus.yml 中添加以下內(nèi)容:
scrape_configs: - job_name: 'my_golang_app' static_configs: - targets: ['localhost:8080']
然后重啟Prometheus服務(wù)器,它將會(huì)開始抓取你的Golang應(yīng)用程序暴露的指標(biāo)。
9. 總結(jié)
通過使用 prometheus/client_golang 庫,你可以輕松地在Golang中生成和暴露Prometheus指標(biāo)。這個(gè)示例展示了如何創(chuàng)建一個(gè)簡(jiǎn)單的Gauge指標(biāo),并通過HTTP端點(diǎn)暴露它。你可以根據(jù)需要擴(kuò)展這個(gè)示例,添加更多的指標(biāo)類型(如Counter、Histogram等)和更復(fù)雜的業(yè)務(wù)邏輯。
到此這篇關(guān)于使用golang生成prometheus格式數(shù)據(jù)的文章就介紹到這了,更多相關(guān)golang生成prometheus數(shù)據(jù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
淺析Golang中調(diào)度器的關(guān)鍵機(jī)制與性能
Golang的調(diào)度器是其并發(fā)模型的核心組件,負(fù)責(zé)管理Goroutine的調(diào)度和執(zhí)行,本文將從理論和代碼層面分析Golang調(diào)度器的關(guān)鍵機(jī)制,感興趣的可以了解下2025-03-03如何使用工具自動(dòng)監(jiān)測(cè)SSL證書有效期并發(fā)送提醒郵件
本文介紹了如何開發(fā)一個(gè)工具,用于每日檢測(cè)SSL證書剩余有效天數(shù)并通過郵件發(fā)送提醒,工具基于命令行,通過SMTP協(xié)議發(fā)送郵件,需配置SMTP連接信息,本文還提供了配置文件樣例及代碼實(shí)現(xiàn),幫助用戶輕松部署和使用該工具2024-10-10golang 定時(shí)任務(wù)方面time.Sleep和time.Tick的優(yōu)劣對(duì)比分析
這篇文章主要介紹了golang 定時(shí)任務(wù)方面time.Sleep和time.Tick的優(yōu)劣對(duì)比分析,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2021-05-05Golang基礎(chǔ)常識(shí)性面試中常見的六大陷阱及應(yīng)對(duì)技巧總結(jié)
Go是一門簡(jiǎn)單有趣的語言,但與其他語言類似,它會(huì)有一些技巧,這篇文章主要給大家介紹了關(guān)于Golang基礎(chǔ)常識(shí)性面試中常見的六大陷阱及應(yīng)對(duì)技巧的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2024-08-08Golang實(shí)現(xiàn)Redis事務(wù)深入探究
這篇文章主要介紹了Golang實(shí)現(xiàn)Redis事務(wù)深入探究,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2024-01-01