为 golang prometheus 收集器添加标签

Question

我正在尝试弄清楚如何向普罗米修斯收集器添加标签。任何想法我在这里缺少什么？我有两个文件：main.go 和 collector.go

我使用以下 link 作为指南。 https://rsmitty.github.io/Prometheus-Exporters/

我模拟了这个例子，所以我可以 post 在这里。我最终不会为命令拉 "date +%s"。只是不知道在哪里添加标签。

我正在尝试为标签添加主机名，因此得到的结果如下：

# HELP cmd_result Shows the cmd result
# TYPE cmd_result gauge
cmd_result{host="my_device_hostname"} 1.919256141363144e-76

我也是 golang 的新手，所以很有可能我做错了！我最终试图让普罗米修斯在每次刮擦时拉出 cmd 结果。

main.go

package main

import (
    "net/http"

    log "github.com/Sirupsen/logrus"
    "github.com/prometheus/client_golang/prometheus"
    "github.com/prometheus/client_golang/prometheus/promhttp"
)

func main() {

    //Create a new instance of the collector and
    //register it with the prometheus client.
    cmd := newCollector()
    prometheus.MustRegister(cmd)

    //This section will start the HTTP server and expose
    //any metrics on the /metrics endpoint.
    http.Handle("/metrics", promhttp.Handler())
    log.Info("Beginning to serve on port :8080")
    log.Fatal(http.ListenAndServe(":8080", nil))
}

collector.go

package main

import (
    "encoding/binary"
    "fmt"
    "math"
    "os/exec"
    "strings"

    "github.com/prometheus/client_golang/prometheus"
)

type cmdCollector struct {
    cmdMetric *prometheus.Desc
}

func newCollector() *cmdCollector {
    return &cmdCollector{
        cmdMetric: prometheus.NewDesc("cmd_result",
            "Shows the cmd result",
            nil, nil,
        ),
    }
}

func (collector *cmdCollector) Describe(ch chan<- *prometheus.Desc) {
    ch <- collector.cmdMetric
}

func (collector *cmdCollector) Collect(ch chan<- prometheus.Metric) {

    var metricValue float64
    command := string("date +%s")
    cmdResult := exeCmd(command)
    metricValue = cmdResult

    ch <- prometheus.MustNewConstMetric(collector.cmdMetric, prometheus.GaugeValue, metricValue)

}

func exeCmd(cmd string) float64 {
    parts := strings.Fields(cmd)
    out, err := exec.Command(parts[0], parts[1]).Output()
    if err != nil {
        fmt.Println("error occured")
        fmt.Printf("%s", err)
    }
    cmdProcessResult := Float64frombytes(out)
    return cmdProcessResult
}

func Float64frombytes(bytes []byte) float64 {
    bits := binary.LittleEndian.Uint64(bytes)
    float := math.Float64frombits(bits)
    return float
}

Answer 1

我明白了。我必须在调用 NewDesc 方法的地方声明标签，然后在 MustNewConstMetric 方法中传递值

这是带有 "hostname" 标签的新 "newCollector"。

func newCollector() *cmdCollector {
    return &cmdCollector{
        cmdMetric: prometheus.NewDesc("cmd_result",
            "Shows the cmd result",
            []string{"hostname"}, nil,
        ),
    }
}

值得注意的是，我只是在这里添加 "variable labels"。最后一个 'nil' 用于常量标签。

您可以像这样添加任意数量的项目...

[]string{"hostname", "another_label", "and_another_label"}

此处介绍： https://godoc.org/github.com/prometheus/client_golang/prometheus#NewDesc

接下来我可以在调用 "MustNewConstMetric" 方法时添加这些值。

ch <- prometheus.MustNewConstMetric(collector.cmdMetric, prometheus.GaugeValue, metricValue, hostname)

整个街区...

func (collector *cmdCollector) Collect(ch chan<- prometheus.Metric) {

    var metricValue float64
    command := string("date +%s")
    cmdResult := exeCmd(command)
    metricValue = cmdResult

    ch <- prometheus.MustNewConstMetric(collector.cmdMetric, prometheus.GaugeValue, metricValue, hostname)

}

如果我传入多个标签；比如我上面的例子，它看起来更像这样...

ch <- prometheus.MustNewConstMetric(collector.cmdMetric, prometheus.GaugeValue, metricValue, hostname, anotherLabel", "andAnotherLabel)

此处介绍： https://godoc.org/github.com/prometheus/client_golang/prometheus#MustNewConstMetric

Answer 2

github.com/prometheus/client_golang library is non-trivial to use. I'd suggest taking a look at much simpler Go library for exporting metrics in Prometheus format - github.com/VictoriaMetrics/metrics。您可以通过标准 Go 库中的 fmt.Sprintf() 函数轻松指定任意数量的动态标签：

import (
  "github.com/VictoriaMetrics/metrics"
)

func exportCMDResultValue(hostname string, metricValue float64) {
  metricName := fmt.Sprintf("cmd_result{host=%q}", hostname)
  metrics.GetOrCreateFloatCounter(metricName).Set(metricValue)
}

然后每次调用exportCMDResultValue()函数时，都会在/metrics页面导出对应的cmd_result{host="<hostname>"} <metricValue>指标。 /metrics 页面处理程序可以使用以下代码实现：

http.HandleFunc("/metrics", func(w http.ResponseWriter, req *http.Request) {
    metrics.WritePrometheus(w, false)
})

有关详细信息，请参阅 WritePromtheus 函数文档。

为 golang prometheus 收集器添加标签

Adding label to golang prometheus collector

go

prometheus