INSTRUMENTING A GO APPLICATION FOR PROMETHEUS

Prometheus有一个官方Go客户端库，您可以使用它来检测Go应用程序。 在本指南中，我们将创建一个简单的Go应用程序，通过HTTP公开Prometheus指标。

安装

您可以使用go get安装指南所需的prometheus，promauto和promhttp库：

  1. go get github.com/prometheus/client_golang/prometheus
  2. go get github.com/prometheus/client_golang/prometheus/promauto
  3. go get github.com/prometheus/client_golang/prometheus/promhttp

Go exposition如何运作

要在Go应用程序中公开Prometheus指标，您需要提供/metrics HTTP端点。 您可以使用prometheus/promhttp库的HTTPHandler作为处理函数。

例如，这个最小的应用程序将通过http://localhost:2112/metrics公开Go应用程序的默认指标：

  1. package main
  3. import (
  4.         "net/http"
  6.         "github.com/prometheus/client_golang/prometheus/promhttp"
  7. )
  9. func main() {
  10.         http.Handle("/metrics", promhttp.Handler())
  11.         http.ListenAndServe(":2112", nil)
  12. }

启动这个应用：

  1. go run main.go

获取metrics：

  1. curl http://localhost:2112/metrics

添加你自己的指标

上面的应用程序仅公开默认的Go指标。 您还可以注册自己的自定义应用程序特定度量标准。 此示例应用程序公开myapp_processed_ops_total计数器，该计数器计算到目前为止已处理的操作数。 每2秒钟，计数器加1。

  1. package main
  3. import (
  4.         "net/http"
  5.         "time"
  7.         "github.com/prometheus/client_golang/prometheus"
  8.         "github.com/prometheus/client_golang/prometheus/promauto"
  9.         "github.com/prometheus/client_golang/prometheus/promhttp"
  10. )
  12. func recordMetrics() {
  13.         go func() {
  14.                 for {
  15.                         opsProcessed.Inc()
  16.                         time.Sleep(2 * time.Second)
  17.                 }
  18.         }()
  19. }
  21. var (
  22.         opsProcessed = promauto.NewCounter(prometheus.CounterOpts{
  23.                 Name: "myapp_processed_ops_total",
  24.                 Help: "The total number of processed events",
  25.         })
  26. )
  28. func main() {
  29.         recordMetrics()
  31.         http.Handle("/metrics", promhttp.Handler())
  32.         http.ListenAndServe(":2112", nil)
  33. }

启动这个应用：

  1. go run main.go

获取metrics：

  1. curl http://localhost:2112/metrics

在metrics输出中，您将看到myapp_processed_ops_total计数器的帮助文本，类型信息和当前值：

  1. # HELP myapp_processed_ops_total The total number of processed events
  2. # TYPE myapp_processed_ops_total counter
  3. myapp_processed_ops_total 5

您可以配置本地运行的Prometheus实例以从应用程序中删除指标。 这是prometheus.yml配置示例：

  1. scrape_configs:
  2. - job_name: myapp
  3.   scrape_interval: 10s
  4.   static_configs:
  5.   - targets:
  6.     - localhost:2112

其他Go客户端特征

在本指南中，我们仅介绍了Prometheus Go客户端库中的一小部分功能。 您还可以公开其他度量标准类型，例如gauges和直方图，非全局注册表，将指标推送到Prometheus PushGateways的功能，桥接Prometheus和Graphite等等。

总结

在本指南中，您创建了两个示例Go应用程序，这些应用程序向Prometheus公开指标 - 一个仅公开默认Go指标，另一个公开自定义Prometheus计数器 - 并配置Prometheus实例以从这些应用程序中提取指标。