Add Prometheus support v2

.dockerignore

@@ -1,2 +1,3 @@
 .vscode
 dist/
+vendor/

.gitignore

@@ -1,4 +1,5 @@
 .vscode/
+.idea/
 *.json
 *.sh
 *.yaml
@@ -7,3 +8,4 @@ linux-*.Dockerfile
 mbmd
 !entrypoint.sh
 !mbmd.dist.yaml
+vendor/

Dockerfile

@@ -3,26 +3,25 @@
 ############################
 FROM golang:alpine as builder
 
+RUN --mount=type=tmpfs,target=/build
+WORKDIR /build
+
 # Install git + SSL ca certificates.
 # Git is required for fetching the dependencies.
 # Ca-certificates is required to call HTTPS endpoints.
 RUN apk update && apk add --no-cache git ca-certificates tzdata alpine-sdk && update-ca-certificates
 
-WORKDIR /build
-
-# cache modules
 COPY go.mod .
 COPY go.sum .
 RUN go mod download
 
 COPY . .
-RUN make install
 RUN make build
 
 #############################
 ## STEP 2 build a small image
 #############################
-FROM alpine
+FROM alpine:latest
 
 # Import from builder.
 COPY --from=builder /usr/share/zoneinfo /usr/share/zoneinfo

README.md

@@ -224,7 +224,15 @@ By default, readings are published at `/mbmd/<unique id>/<reading>`. Rate limiti
 
 ## InfluxDB support
 
-There is also the option to directly insert the data into an influxdb database by using the command-line options available. InfluxDB 1.8 and 2.0 are currently supported. to enable this, add the `--influx-database` and the `--influx-url` commandline parameter. More advanced configuration is available, to learn more checkout the [mbmd_run.md](docs/mbmd_run.md) documentation
+There is also the option to directly insert the data into an influxdb database
+by using the command-line options available. InfluxDB 1.8 and 2.0 are currently
+supported. to enable this, add the `--influx-database` and the `--influx-url`
+commandline parameter. More advanced configuration is available, to learn more
+checkout the [mbmd_run.md](docs/mbmd_run.md) documentation
+
+## Prometheus support
+
+There is also the option to pull prometheus data via the `/metrics` endpoint.
 
 # Supported Devices
 
@@ -297,7 +305,7 @@ Apart from meters, SunSpec-compatible grid inverters connected over TCP
 are supported, too. SunSpec defines a default register layout for accessing
 the devices.
 
-Supported inverters include popular devices from SolarEdge (SE3000, SE9000)
+Supported inverters include popular devices from SolarEdge (SE3000, SE9000, SE17K, SE10K-RWS)
 and SMA (Sunny Boy and Sunny TriPower).
 
 In case of TCP connection, the adapter parameter becomes the hostname and port:

assets/index.html

@@ -390,13 +390,17 @@ <h1>Status</h1>
 					<tr>
 						<th>Meter</th>
 						<th>Type</th>
+						<th>Model</th>
+						<th>Serial</th>
 						<th>Status</th>
 					</tr>
 				</thead>
 				<tbody>
 					<tr v-for="(m, idx) in sorted(meters)">
 						<td>${ idx }</td>
 						<td>${ m.Type }</td>
+						<td>${ m.Model }</td>
+						<td>${ m.Serial }</td>
 						<td>${ m.Status }</td>
 					</tr>
 				</tbody>
@@ -406,7 +410,8 @@ <h1>Status</h1>
 		<div id="about">
 			<h1>About MBMD</h1>
 			<p>MBMD collects measurements from modbus devices.
-				It works with meters like the Eastron SDM630 as well as grid inverters like SMA Sunny Boy.<br/>
+				It works with meters like the Eastron SDM630 as well as grid inverters like SMA Sunny Boy
+				and all other inverters implementing the SUNSPEC standard.<br/>
 				Please <a href="https://github.com/volkszaehler/mbmd">refer to the documentation
 				</a> for more information.</p>
 			<p>This installation runs MBMD version {{.SoftwareVersion}} (compiled with {{.GolangVersion}})</p>

assets/js/app.js

@@ -130,9 +130,13 @@ function processMessage(data) {
 
 function connectSocket() {
 	var ws, loc = window.location;
-	var protocol = loc.protocol == "https:" ? "wss:" : "ws:"
+	var protocol = loc.protocol === "https:" ? "wss:" : "ws:"
+	var path = loc.pathname.replace(/\/$/, "")
+	if (path === "") {
+		path = "/"
+	}
 
-	ws = new WebSocket(protocol + "//" + loc.hostname + (loc.port ? ":" + loc.port : "") + loc.pathname.replace(/\/$/, "") + "/ws");
+	ws = new WebSocket(protocol + "//" + loc.hostname + (loc.port ? ":" + loc.port : "") + path + "ws");
 
 	ws.onerror = function(evt) {
 		ws.close();

cmd/confighandler.go

@@ -3,7 +3,6 @@ package cmd
 import (
 	"os"
 	"regexp"
-	"sort"
 	"strconv"
 	"strings"
 	"time"
@@ -15,13 +14,20 @@ import (
 
 // Config describes the entire configuration
 type Config struct {
-	API      string
-	Rate     time.Duration
-	Mqtt     MqttConfig
-	Influx   InfluxConfig
-	Adapters []AdapterConfig
-	Devices  []DeviceConfig
-	Other    map[string]interface{} `mapstructure:",remain"`
+	API        string
+	Rate       time.Duration
+	Mqtt       MqttConfig
+	Influx     InfluxConfig
+	Adapters   []AdapterConfig
+	Devices    []DeviceConfig
+	Prometheus PrometheusConfig
+	Other      map[string]interface{} `mapstructure:",remain"`
+}
+
+type PrometheusConfig struct {
+	Enable                 bool // defaults to yes
+	EnableProcessCollector bool
+	EnableGoCollector      bool
 }
 
 // MqttConfig describes the mqtt broker configuration
@@ -117,35 +123,38 @@ func (conf *DeviceConfigHandler) ConnectionManager(connSpec string, rtu bool, ba
 	return manager
 }
 
+var sunspecTypes = map[string]bool{
+	"FRONIUS":   true,
+	"KACO":      true,
+	"KOSTAL":    true,
+	"SE":        true,
+	"SMA":       true,
+	"SOLAREDGE": true,
+	"STECA":     true,
+	"SUNS":      true,
+	"SUNSPEC":   true,
+}
+
 func (conf *DeviceConfigHandler) createDeviceForManager(
 	manager *meters.Manager,
+	name string,
 	meterType string,
 	subdevice int,
 ) meters.Device {
 	var meter meters.Device
 	meterType = strings.ToUpper(meterType)
 
-	var isSunspec bool
-	sunspecTypes := []string{"FRONIUS", "KOSTAL", "KACO", "SE", "SMA", "SOLAREDGE", "STECA", "SUNS", "SUNSPEC"}
-	for _, t := range sunspecTypes {
-		if t == meterType {
-			isSunspec = true
-			break
-		}
-	}
-
-	sort.SearchStrings(sunspecTypes, meterType)
-	if isSunspec {
-		meter = sunspec.NewDevice(meterType, subdevice)
+	if sunspecTypes[meterType] {
+		meter = sunspec.NewDevice(name, meterType, subdevice)
 	} else {
 		if subdevice > 0 {
-			log.Fatalf("Invalid subdevice number for device %s: %d", meterType, subdevice)
+			log.Fatalf("Invalid subdevice number for device '%s' (%s): %d", name, meterType, subdevice)
 		}
 
 		var err error
-		meter, err = rs485.NewDevice(meterType)
+		meter, err = rs485.NewDevice(name, meterType)
 		if err != nil {
-			log.Fatalf("Error creating device %s: %v.", meterType, err)
+			log.Fatalf("Error creating device '%s' (%s): %v.", name, meterType, err)
 		}
 	}
 
@@ -170,7 +179,7 @@ func (conf *DeviceConfigHandler) CreateDevice(devConf DeviceConfig) {
 	if !ok {
 		log.Fatalf("Missing adapter configuration for device %v", devConf)
 	}
-	meter := conf.createDeviceForManager(manager, devConf.Type, devConf.SubDevice)
+	meter := conf.createDeviceForManager(manager, devConf.Name, devConf.Type, devConf.SubDevice)
 
 	if err := manager.Add(devConf.ID, meter); err != nil {
 		log.Fatalf("Error adding device %v: %v.", devConf, err)
@@ -226,7 +235,7 @@ func (conf *DeviceConfigHandler) CreateDeviceFromSpec(deviceDef string, timeout
 	// have been created of the --rtu flag was specified. We'll not re-check this here.
 	manager := conf.ConnectionManager(connSpec, false, 0, "", timeout)
 
-	meter := conf.createDeviceForManager(manager, meterType, subdevice)
+	meter := conf.createDeviceForManager(manager, "", meterType, subdevice)
 	if err := manager.Add(uint8(id), meter); err != nil {
 		log.Fatalf("Error adding device %s: %v. See -h for help.", meterDef, err)
 	}

cmd/root_test.go

@@ -0,0 +1,4 @@
+package cmd
+
+// Yeah, it compiles
+var _ = Execute

cmd/run.go

@@ -13,7 +13,7 @@ import (
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 	latest "github.com/tcnksm/go-latest"
-
+	"github.com/volkszaehler/mbmd/prometheus"
 	"github.com/volkszaehler/mbmd/server"
 )
 
@@ -223,6 +223,7 @@ func run(cmd *cobra.Command, args []string) {
 		}
 	}
 
+	promCfg := PrometheusConfig{Enable: true}
 	if cfgFile != "" {
 		// config file found
 		log.Printf("config: using %s", viper.ConfigFileUsed())
@@ -247,7 +248,14 @@ func run(cmd *cobra.Command, args []string) {
 				confHandler.CreateDevice(dev)
 			}
 		}
+		promCfg = conf.Prometheus
 	}
+	// Prometheus manager - Register all static metrics to default registry
+	prometheus.RegisterAllMetrics(prometheus.Config{
+		Enable:                 promCfg.Enable,
+		EnableProcessCollector: promCfg.EnableProcessCollector,
+		EnableGoCollector:      promCfg.EnableGoCollector,
+	})
 
 	if countDevices(confHandler.Managers) == 0 {
 		log.Fatal("config: no devices found - terminating")

cmd/scan.go

@@ -79,11 +79,11 @@ func scan(cmd *cobra.Command, args []string) {
 	// create devices
 	devices := make([]meters.Device, 0)
 	if _, ok := conn.(*meters.TCP); ok {
-		suns := sunspec.NewDevice("SUNS")
+		suns := sunspec.NewDevice("", "SUNS")
 		devices = append(devices, suns)
 	} else {
 		for t := range rs485.Producers {
-			dev, err := rs485.NewDevice(t)
+			dev, err := rs485.NewDevice("", t)
 			if err != nil {
 				log.Fatal(err)
 			}
@@ -109,14 +109,16 @@ SCAN:
 				if !errors.Is(err, meters.ErrPartiallyOpened) {
 					continue // devices
 				}
+
 				log.Println(err) // log error but continue
 			}
 
 			mr, err := dev.Probe(client)
 			if err == nil && v.check(mr.Value) {
+				deviceDescriptor := dev.Descriptor()
 				log.Printf("device %d: %s type device found, %s: %.2f\r\n",
 					deviceID,
-					dev.Descriptor().Manufacturer,
+					deviceDescriptor.Manufacturer,
 					mr.Measurement,
 					mr.Value,
 				)

go.mod

@@ -1,62 +1,67 @@
 module github.com/volkszaehler/mbmd
 
-go 1.21
-
-toolchain go1.21.5
+go 1.23
 
 require (
-	github.com/andig/gosunspec v0.0.0-20231205122018-1daccfa17912
-	github.com/dmarkham/enumer v1.5.9
-	github.com/eclipse/paho.mqtt.golang v1.4.3
+	github.com/andig/gosunspec v0.0.0-20240918203654-860ce51d602b
+	github.com/dmarkham/enumer v1.5.10
+	github.com/eclipse/paho.mqtt.golang v1.5.0
 	github.com/gorilla/handlers v1.5.2
 	github.com/gorilla/mux v1.8.1
-	github.com/gorilla/websocket v1.5.1
-	github.com/grid-x/modbus v0.0.0-20240429072715-02314cc902aa
-	github.com/influxdata/influxdb-client-go/v2 v2.13.0
-	github.com/spf13/cobra v1.8.0
+	github.com/gorilla/websocket v1.5.3
+	github.com/grid-x/modbus v0.0.0-20241004123532-f6c6fb5201b3
+	github.com/influxdata/influxdb-client-go/v2 v2.14.0
+	github.com/prometheus/client_golang v1.20.5
+	github.com/spf13/cobra v1.8.1
 	github.com/spf13/pflag v1.0.5
-	github.com/spf13/viper v1.18.2
+	github.com/spf13/viper v1.19.0
 	github.com/stretchr/testify v1.9.0
 	github.com/tcnksm/go-latest v0.0.0-20170313132115-e3007ae9052e
-	golang.org/x/exp v0.0.0-20240416160154-fe59bbe5cc7f
+	golang.org/x/exp v0.0.0-20241108190413-2d47ceb2692f
 )
 
 require (
 	github.com/apapsch/go-jsonmerge/v2 v2.0.0 // indirect
-	github.com/cpuguy83/go-md2man/v2 v2.0.4 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.5 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
-	github.com/fsnotify/fsnotify v1.7.0 // indirect
+	github.com/fsnotify/fsnotify v1.8.0 // indirect
 	github.com/google/go-github v17.0.0+incompatible // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/grid-x/serial v0.0.0-20211107191517-583c7356b3aa // indirect
-	github.com/hashicorp/go-version v1.6.0 // indirect
+	github.com/hashicorp/go-version v1.7.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/influxdata/line-protocol v0.0.0-20210922203350-b1ad95c89adf // indirect
+	github.com/klauspost/compress v1.17.11 // indirect
 	github.com/magiconair/properties v1.8.7 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
-	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/oapi-codegen/runtime v1.1.1 // indirect
 	github.com/pascaldekloe/name v1.0.1 // indirect
-	github.com/pelletier/go-toml/v2 v2.2.1 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.3 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
+	github.com/prometheus/client_model v0.6.1 // indirect
+	github.com/prometheus/common v0.60.1 // indirect
+	github.com/prometheus/procfs v0.15.1 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
-	github.com/sagikazarmark/locafero v0.4.0 // indirect
+	github.com/sagikazarmark/locafero v0.6.0 // indirect
 	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
 	github.com/sourcegraph/conc v0.3.0 // indirect
 	github.com/spf13/afero v1.11.0 // indirect
-	github.com/spf13/cast v1.6.0 // indirect
+	github.com/spf13/cast v1.7.0 // indirect
 	github.com/subosito/gotenv v1.6.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
-	golang.org/x/mod v0.17.0 // indirect
-	golang.org/x/net v0.24.0 // indirect
-	golang.org/x/sync v0.7.0 // indirect
-	golang.org/x/sys v0.19.0 // indirect
-	golang.org/x/text v0.14.0 // indirect
-	golang.org/x/tools v0.20.0 // indirect
-	gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b // indirect
+	golang.org/x/mod v0.22.0 // indirect
+	golang.org/x/net v0.31.0 // indirect
+	golang.org/x/sync v0.9.0 // indirect
+	golang.org/x/sys v0.27.0 // indirect
+	golang.org/x/text v0.20.0 // indirect
+	golang.org/x/tools v0.27.0 // indirect
+	google.golang.org/protobuf v1.35.2 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )