From 8a0c456fecb59f5b8c9a8e97ba7a84e929ac9e8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Sch=C3=A4fer?= Date: Mon, 16 Jun 2025 10:00:08 +0200 Subject: [PATCH 1/6] feat: add metrics endpoint --- go.mod | 4 ++ go.sum | 8 +++ server/handler/metrics.go | 106 ++++++++++++++++++++++++++++++++++++++ server/server.go | 1 + 4 files changed, 119 insertions(+) create mode 100644 server/handler/metrics.go diff --git a/go.mod b/go.mod index abfc197..67f7bd8 100644 --- a/go.mod +++ b/go.mod @@ -5,9 +5,13 @@ go 1.24.2 require ( github.com/gorilla/mux v1.8.1 github.com/spf13/cobra v1.9.1 + github.com/VictoriaMetrics/metrics v1.38.0 ) require ( github.com/inconshreveable/mousetrap v1.1.0 // indirect github.com/spf13/pflag v1.0.6 // indirect + github.com/valyala/fastrand v1.1.0 // indirect + github.com/valyala/histogram v1.2.0 // indirect + golang.org/x/sys v0.15.0 // indirect ) diff --git a/go.sum b/go.sum index 831747c..9dcc3d5 100644 --- a/go.sum +++ b/go.sum @@ -1,3 +1,5 @@ +github.com/VictoriaMetrics/metrics v1.38.0 h1:1d0dRgVH8Nnu8dKMfisKefPC3q7gqf3/odyO0quAvyA= +github.com/VictoriaMetrics/metrics v1.38.0/go.mod h1:r7hveu6xMdUACXvB8TYdAj8WEsKzWB0EkpJN+RDtOf8= github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g= github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY= github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ= @@ -8,5 +10,11 @@ github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo= github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0= github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o= github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/valyala/fastrand v1.1.0 h1:f+5HkLW4rsgzdNoleUOB69hyT9IlD2ZQh9GyDMfb5G8= +github.com/valyala/fastrand v1.1.0/go.mod h1:HWqCzkrkg6QXT8V2EXWvXCoow7vLwOFN002oeRzjapQ= +github.com/valyala/histogram v1.2.0 h1:wyYGAZZt3CpwUiIb9AU/Zbllg1llXyrtApRS815OLoQ= +github.com/valyala/histogram v1.2.0/go.mod h1:Hb4kBwb4UxsaNbbbh+RRz8ZR6pdodR57tzWUS3BUzXY= +golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc= +golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/server/handler/metrics.go b/server/handler/metrics.go new file mode 100644 index 0000000..55d5f70 --- /dev/null +++ b/server/handler/metrics.go @@ -0,0 +1,106 @@ +/* +Copyright (c) 2025 Tobias Schäfer. All rights reserved. +Licensed under the MIT license, see LICENSE in the project root for details. +*/ + +package handler + +import ( + "bytes" + "fmt" + "iter" + "maps" + "net/http" + "os" + "strconv" + + "github.com/VictoriaMetrics/metrics" + "github.com/tschaefer/rpinfo/vcgencmd" +) + +var ( + rpi = metrics.NewSet() +) + +func Metrics(w http.ResponseWriter, r *http.Request) { + hostname, _ := os.Hostname() + + clocks := []string{ + "arm", "core", "dpi", "emmc", "h264", + "hdmi", "isp", "pixel", "pwm", "uart", "v3d", "vec", + } + for _, c := range clocks { + name := fmt.Sprintf(`rpi_clock_%s{node="%s"}`, c, hostname) + rpi.GetOrCreateGauge(name, func() float64 { return clock(c) }) + } + + name := fmt.Sprintf(`rpi_temperature{node="%s"}`, hostname) + rpi.GetOrCreateGauge(name, temperature) + + voltages := []string{ + "core", "sdram_c", "sdram_i", "sdram_p", + } + for _, v := range voltages { + name := fmt.Sprintf(`rpi_voltage_%s{node="%s"}`, v, hostname) + rpi.GetOrCreateGauge(name, func() float64 { return voltage(v) }) + } + + var buffer bytes.Buffer + rpi.WritePrometheus(&buffer) + if _, err := w.Write(buffer.Bytes()); err != nil { + http.Error(w, "Failed to write metrics", http.StatusInternalServerError) + return + } +} + +func clock(kind string) float64 { + raw := exec("measure_clock", kind) + if raw == nil { + return 0.0 + } + + value := func() string { + next, stop := iter.Pull(maps.Values(raw)) + defer stop() + + v, _ := next() + return v + } + frequency, err := strconv.ParseFloat(value(), 64) + if err != nil { + return 0.0 + } + + return frequency +} + +func temperature() float64 { + raw := exec("measure_temp") + if raw == nil { + return 0.0 + } + value := raw["temp"] + temp, err := strconv.ParseFloat(value[:len(value)-2], 64) + if err != nil { + return 0.0 + } + return temp +} + +func voltage(kind string) float64 { + raw := exec("measure_volts", kind) + if raw == nil { + return 0.0 + } + value := raw["volt"] + volt, err := strconv.ParseFloat(value[:len(value)-1], 64) + if err != nil { + return 0.0 + } + return volt +} + +func exec(args ...string) map[string]string { + h := Handle{Cmd: vcgencmd.Cmd{}} + return h.Cmd.Run(args...) +} diff --git a/server/server.go b/server/server.go index 349d88c..51a11d4 100644 --- a/server/server.go +++ b/server/server.go @@ -28,6 +28,7 @@ func Run(port string, host string, auth bool, token string) { router.Handle("/throttled", middleware.ApplyAll(auth, token, Handler.Throttled)).Methods(http.MethodGet) router.Handle("/clock", middleware.ApplyAll(auth, token, Handler.Clock)).Methods(http.MethodGet) router.PathPrefix("/redoc").Handler(http.StripPrefix("/redoc", http.FileServer(http.FS(assets.StaticContent)))) + router.HandleFunc("/metrics", middleware.Authorization(auth, token, handler.Metrics)).Methods(http.MethodGet) router.NotFoundHandler = http.HandlerFunc(handler.NotFoundHandler) router.MethodNotAllowedHandler = http.HandlerFunc(handler.MethodNotAllowedHandler) From d8c842bad65879495f2b180719aab82da62ad02e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Sch=C3=A4fer?= Date: Mon, 16 Jun 2025 19:55:58 +0200 Subject: [PATCH 2/6] feat(metrics): remove node label --- server/handler/metrics.go | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/server/handler/metrics.go b/server/handler/metrics.go index 55d5f70..249c6f8 100644 --- a/server/handler/metrics.go +++ b/server/handler/metrics.go @@ -11,7 +11,6 @@ import ( "iter" "maps" "net/http" - "os" "strconv" "github.com/VictoriaMetrics/metrics" @@ -23,25 +22,22 @@ var ( ) func Metrics(w http.ResponseWriter, r *http.Request) { - hostname, _ := os.Hostname() - clocks := []string{ "arm", "core", "dpi", "emmc", "h264", "hdmi", "isp", "pixel", "pwm", "uart", "v3d", "vec", } for _, c := range clocks { - name := fmt.Sprintf(`rpi_clock_%s{node="%s"}`, c, hostname) + name := fmt.Sprintf(`rpi_clock_%s`, c) rpi.GetOrCreateGauge(name, func() float64 { return clock(c) }) } - name := fmt.Sprintf(`rpi_temperature{node="%s"}`, hostname) - rpi.GetOrCreateGauge(name, temperature) + rpi.GetOrCreateGauge(`rpi_temperature`, func() float64 { return temperature() }) voltages := []string{ "core", "sdram_c", "sdram_i", "sdram_p", } for _, v := range voltages { - name := fmt.Sprintf(`rpi_voltage_%s{node="%s"}`, v, hostname) + name := fmt.Sprintf(`rpi_voltage_%s`, v) rpi.GetOrCreateGauge(name, func() float64 { return voltage(v) }) } From 4c776b5b3a78d465f8e4d7e0a80e337f0f9b85f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Sch=C3=A4fer?= Date: Tue, 17 Jun 2025 15:37:21 +0200 Subject: [PATCH 3/6] feat(metrics): add test --- server/handler/handler_test.go | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/server/handler/handler_test.go b/server/handler/handler_test.go index f04f4e6..b2225a8 100644 --- a/server/handler/handler_test.go +++ b/server/handler/handler_test.go @@ -272,3 +272,30 @@ func Test_MeasureClockReturnsServerErrorIfCommandFails(t *testing.T) { status, http.StatusInternalServerError) } } + +func Test_MetricsReturnsPrometheusText(t *testing.T) { + req := httptest.NewRequest("GET", "/metrics", nil) + rr := httptest.NewRecorder() + + handler := http.HandlerFunc(Metrics) + handler.ServeHTTP(rr, req) + + if status := rr.Code; status != http.StatusOK { + t.Errorf("handler returned wrong status code: got %v want %v", + status, http.StatusOK) + } + + expected := "rpi_clock_arm 0\nrpi_clock_core 0\nrpi_clock_dpi 0\n" + + "rpi_clock_emmc 0\nrpi_clock_h264 0\nrpi_clock_hdmi 0\n" + + "rpi_clock_isp 0\nrpi_clock_pixel 0\nrpi_clock_pwm 0\n" + + "rpi_clock_uart 0\nrpi_clock_v3d 0\nrpi_clock_vec 0\n" + + "rpi_temperature 0\nrpi_voltage_core 0\nrpi_voltage_sdram_c 0\n" + + "rpi_voltage_sdram_i 0\nrpi_voltage_sdram_p 0" + + got := rr.Body.String() + got = strings.TrimSpace(got) + if got != expected { + t.Errorf("handler returned unexpected body: got %v want %v", + rr.Body.String(), expected) + } +} From 61d2d6866e92ca885f43b18813700ac26fd50d82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Sch=C3=A4fer?= Date: Tue, 17 Jun 2025 15:37:47 +0200 Subject: [PATCH 4/6] feat(metrics): add Grafana dashboard --- contrib/grafana.json | 656 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 656 insertions(+) create mode 100644 contrib/grafana.json diff --git a/contrib/grafana.json b/contrib/grafana.json new file mode 100644 index 0000000..314d37a --- /dev/null +++ b/contrib/grafana.json @@ -0,0 +1,656 @@ +{ + "__inputs": [ + { + "name": "DS_PROMETHEUS", + "label": "Prometheus", + "description": "", + "type": "datasource", + "pluginId": "prometheus", + "pluginName": "Prometheus" + } + ], + "__elements": {}, + "__requires": [ + { + "type": "grafana", + "id": "grafana", + "name": "Grafana", + "version": "12.0.0+security-01" + }, + { + "type": "datasource", + "id": "prometheus", + "name": "Prometheus", + "version": "1.0.0" + }, + { + "type": "panel", + "id": "timeseries", + "name": "Time series", + "version": "" + } + ], + "annotations": { + "list": [ + { + "builtIn": 1, + "datasource": { + "type": "grafana", + "uid": "-- Grafana --" + }, + "enable": true, + "hide": true, + "iconColor": "rgba(0, 211, 255, 1)", + "name": "Annotations & Alerts", + "type": "dashboard" + } + ] + }, + "editable": true, + "fiscalYearStartMonth": 0, + "graphTooltip": 0, + "id": null, + "links": [], + "panels": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisBorderShow": false, + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "barWidthFactor": 0.6, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "insertNulls": false, + "lineInterpolation": "smooth", + "lineStyle": { + "fill": "solid" + }, + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "linearThreshold": 1, + "log": 2, + "type": "log" + }, + "showPoints": "never", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green" + }, + { + "color": "red", + "value": 80 + } + ] + }, + "unit": "volt" + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 0 + }, + "id": 2, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "hideZeros": false, + "mode": "single", + "sort": "none" + } + }, + "pluginVersion": "12.0.0+security-01", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_voltage_core{instance=\"$instance\"}", + "fullMetaSearch": false, + "includeNullMetadata": true, + "legendFormat": "VC4 core", + "range": true, + "refId": "A", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_voltage_sdram_c{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "SDRAM Core", + "range": true, + "refId": "B", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_voltage_sdram_i{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "SDRAM I/O", + "range": true, + "refId": "C", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_voltage_sdram_p{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "SDRAM Phy", + "range": true, + "refId": "D", + "useBackend": false + } + ], + "title": "Voltages", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisBorderShow": false, + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "barWidthFactor": 0.6, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "insertNulls": false, + "lineInterpolation": "smooth", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "log": 10, + "type": "log" + }, + "showPoints": "never", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green" + }, + { + "color": "red", + "value": 80 + } + ] + }, + "unit": "hertz" + }, + "overrides": [] + }, + "gridPos": { + "h": 16, + "w": 12, + "x": 12, + "y": 0 + }, + "id": 3, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "hideZeros": false, + "mode": "single", + "sort": "none" + } + }, + "pluginVersion": "12.0.0+security-01", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_arm{instance=\"$instance\"}", + "fullMetaSearch": false, + "includeNullMetadata": true, + "legendFormat": "ARM core(s)", + "range": true, + "refId": "A", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_core{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "GPU core", + "range": true, + "refId": "B", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_h264{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "H.264 block", + "range": true, + "refId": "C", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_isp{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "Image Sensor Pipeline", + "range": true, + "refId": "D", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_v3d{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "3D block", + "range": true, + "refId": "E", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_uart{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "UART", + "range": true, + "refId": "F", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_pwm{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "PWM block", + "range": true, + "refId": "G", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_emmc{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "SD card interface", + "range": true, + "refId": "H", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_pixel{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "Pixel valves", + "range": true, + "refId": "I", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_vec{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "Analogue video encoder", + "range": true, + "refId": "J", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_hdmi{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "HDMI", + "range": true, + "refId": "K", + "useBackend": false + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_clock_dpi{instance=\"$instance\"}", + "fullMetaSearch": false, + "hide": false, + "includeNullMetadata": true, + "instant": false, + "legendFormat": "Display Parallel Interface", + "range": true, + "refId": "L", + "useBackend": false + } + ], + "title": "Clocks", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisBorderShow": false, + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "barWidthFactor": 0.6, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "insertNulls": false, + "lineInterpolation": "smooth", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "log": 10, + "type": "log" + }, + "showPoints": "never", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "area" + } + }, + "fieldMinMax": false, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "super-light-green" + }, + { + "color": "super-light-orange", + "value": 60 + }, + { + "color": "super-light-red", + "value": 70 + } + ] + }, + "unit": "celsius" + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 8 + }, + "id": 1, + "options": { + "legend": { + "calcs": [ + "min", + "max", + "mean" + ], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "hideZeros": false, + "mode": "single", + "sort": "none" + } + }, + "pluginVersion": "12.0.0+security-01", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "disableTextWrap": false, + "editorMode": "builder", + "expr": "rpi_temperature{instance=\"$instance\"}", + "fullMetaSearch": false, + "includeNullMetadata": true, + "legendFormat": "Core", + "range": true, + "refId": "A", + "useBackend": false + } + ], + "title": "Temperature", + "type": "timeseries" + } + ], + "refresh": "30s", + "schemaVersion": 41, + "tags": [], + "templating": { + "list": [ + { + "current": {}, + "label": "Data source", + "name": "datasource", + "options": [], + "query": "prometheus", + "refresh": 1, + "regex": "", + "type": "datasource" + }, + { + "allowCustomValue": false, + "current": {}, + "definition": "label_values(rpi_temperature,instance)", + "label": "Instance", + "name": "instance", + "options": [], + "query": { + "qryType": 1, + "query": "label_values(rpi_temperature,instance)", + "refId": "PrometheusVariableQueryEditor-VariableQuery" + }, + "refresh": 1, + "regex": "", + "type": "query" + } + ] + }, + "time": { + "from": "now-1h", + "to": "now" + }, + "timepicker": {}, + "timezone": "browser", + "title": "Raspberry / Hardware", + "uid": "f1120e2b-5a7d-4b44-bb3f-5999df9aeca9", + "version": 13, + "weekStart": "" +} From bbf1ea1b0963d5f2f75ebf621cac22e53b6deeec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Sch=C3=A4fer?= Date: Tue, 17 Jun 2025 17:33:52 +0200 Subject: [PATCH 5/6] feat(metrics): make optional --- cmd/server.go | 4 +++- server/server.go | 9 ++++++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/cmd/server.go b/cmd/server.go index 97612b2..ca37aa7 100644 --- a/cmd/server.go +++ b/cmd/server.go @@ -21,6 +21,7 @@ func init() { serverCmd.Flags().StringP("host", "H", "localhost", "Host to run the server on") serverCmd.Flags().BoolP("auth", "a", false, "Enable authentication") serverCmd.Flags().StringP("token", "t", "", "Bearer Token for authentication") + serverCmd.Flags().BoolP("metrics", "m", false, "Enable metrics endpoint") rootCmd.AddCommand(serverCmd) } @@ -30,8 +31,9 @@ func RunServerCmd(cmd *cobra.Command, args []string) error { host, _ := cmd.Flags().GetString("host") auth, _ := cmd.Flags().GetBool("auth") token, _ := cmd.Flags().GetString("token") + metrics, _ := cmd.Flags().GetBool("metrics") - server.Run(port, host, auth, token) + server.Run(port, host, auth, token, metrics) return nil } diff --git a/server/server.go b/server/server.go index 51a11d4..e0fcdbe 100644 --- a/server/server.go +++ b/server/server.go @@ -18,7 +18,7 @@ import ( "github.com/tschaefer/rpinfo/version" ) -func Run(port string, host string, auth bool, token string) { +func Run(port string, host string, auth bool, token string, metrics bool) { Handler := handler.Handle{Cmd: vcgencmd.Cmd{}} router := mux.NewRouter() @@ -28,7 +28,10 @@ func Run(port string, host string, auth bool, token string) { router.Handle("/throttled", middleware.ApplyAll(auth, token, Handler.Throttled)).Methods(http.MethodGet) router.Handle("/clock", middleware.ApplyAll(auth, token, Handler.Clock)).Methods(http.MethodGet) router.PathPrefix("/redoc").Handler(http.StripPrefix("/redoc", http.FileServer(http.FS(assets.StaticContent)))) - router.HandleFunc("/metrics", middleware.Authorization(auth, token, handler.Metrics)).Methods(http.MethodGet) + + if metrics { + router.HandleFunc("/metrics", middleware.Authorization(auth, token, handler.Metrics)).Methods(http.MethodGet) + } router.NotFoundHandler = http.HandlerFunc(handler.NotFoundHandler) router.MethodNotAllowedHandler = http.HandlerFunc(handler.MethodNotAllowedHandler) @@ -42,6 +45,6 @@ func Run(port string, host string, auth bool, token string) { } log.Printf("Starting rpinfo server. Version: %s - %s", version.Release(), version.Commit()) - log.Printf("Listening on %s:%s, auth: %t", host, port, auth) + log.Printf("Listening on %s:%s, auth: %t, metrics: %t", host, port, auth, metrics) log.Fatal(server.ListenAndServe()) } From 55f89215691c58989b9ff175fc62aad39bc574bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Sch=C3=A4fer?= Date: Tue, 17 Jun 2025 22:39:47 +0200 Subject: [PATCH 6/6] feat(metrics): add documentation --- README.md | 18 +++++++++++------- cmd/server.go | 2 +- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b120281..119e1b6 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,14 @@ Start the server on `localhost:8080` by default. ``` For further configuration, see the command-line options below. -| Flag | Description | Default | -|-----------------|--------------------------------------|-------------| -| `-H`, `--host` | Host to bind the server to | `localhost` | -| `-p`, `--port` | Port to run the server on | `8080` | -| `-a`, `--auth` | Enable bearer token authentication | `false` | -| `-t`, `--token` | Bearer token used for authentication | | -| `-h`, `--help` | Show help for the server command | | +| Flag | Description | Default | +|-------------------|--------------------------------------|-------------| +| `-H`, `--host` | Host to bind the server to | `localhost` | +| `-p`, `--port` | Port to run the server on | `8080` | +| `-a`, `--auth` | Enable bearer token authentication | `false` | +| `-t`, `--token` | Bearer token used for authentication | | +| `-m`, `--metrics` | Enable Prometheus metrics endpoint | `false` | +| `-h`, `--help` | Show help for the server command | | Additional a systemd service file and environment file are provided in the [contrib directory](https://github.com/tschaefer/rpinfo/tree/main/contrib) for automatic startup on boot and management of the @@ -57,6 +58,9 @@ All endpoints return JSON-formatted data. The complete API specification is available at `/redoc`. +Additionally, the server supports an optional `/metrics` endpoint for +Prometheus exposing clock, temperature, and voltage gauges. + ## Security Notes - If authentication is enabled, all API calls must include the `Authorization` diff --git a/cmd/server.go b/cmd/server.go index ca37aa7..24b72d4 100644 --- a/cmd/server.go +++ b/cmd/server.go @@ -21,7 +21,7 @@ func init() { serverCmd.Flags().StringP("host", "H", "localhost", "Host to run the server on") serverCmd.Flags().BoolP("auth", "a", false, "Enable authentication") serverCmd.Flags().StringP("token", "t", "", "Bearer Token for authentication") - serverCmd.Flags().BoolP("metrics", "m", false, "Enable metrics endpoint") + serverCmd.Flags().BoolP("metrics", "m", false, "Enable Prometheus metrics endpoint") rootCmd.AddCommand(serverCmd) }