Add Prometheus support v2 #342

If you open this project in GoLand, it will create a .idea/ directory which could have been tracked by Git.

Some metrics are implemented in handler.go and scan.go. Each metrics is accessible via global variable. Helper method UpdateMeasurementMetric adds flexibility to updating specific measurement without hardcoding Prometheus Metric in certain places.

…reated

When using newGaugeOpts/newCounterOpts, all objects will share the same namespace "mbmd"

…auges of measurements Instead of creating a new counter/gauges for a measurement by hand, we simply just add a newly added measurement to the appropriate counterVeh/gaugesVeh map. This also means that everytime a new measurement in meters.Measurement is introduced, the maps in prometheus.go need to be updated as well.

…Name

Instead of actively managing and storing each measurement in gauges and counters map respectively, in measurements.go, each entry in `iec` is assigned a PrometheusMetricType. When prometheus_metrics.Init is called, the appropriate prometheus.Metric will be initialized and will still be stored in gauges/counters map, but its content now dynamically changes based on meters.Measurements actually enum entries, making meters.Measurements the single instance of responsibility for handling metric types.

…us info

Instead of creating only one instance of each Prometheus metric measurement, each metric will now differ in each device's manufacturer

Each static metrics is now categorized by interface `collectable`. `collectable.Collect()` will be called when all static metrics are registered to the default Prometheus registry.

When using `prometheus.MustRegister(...)`, the app will panic if a slice entry is nil. Meanwhile fail fast isn't bad, the stack trace doesn't provide enough/precise information about the panic. `prometheus.Register(prometheus.Collector)` however returns an error object which makes it much easier to troubleshoot metric registrations.

Affects SunSpec

Previously, log.Fatalf was used for logging if a metric registration to default Prometheus registry fails. However, I don't think there's a need to panic - logging should be enough

Measurement labels are stripped to just serial_numbers as they can be accessed via Join with mbmd_device_info

If no device description is available, we cannot distinguish between all device structs which it makes also difficult to distinguish between metrics. Therefore I add the device name that the config specifies in order to make them "comparable"

As these metrics are SunSpec specific, we integrate them into Prometheus metrics name

Full names now use the plural form.

Add conversion funcs in order to display measurement values in units specifically set for Prometheus. Starting with this commit, Kilowatt-hours are converted to Joules.

This is purely a change of expressions

This can be quite useful in case the serial number of the smart meter is missing

…eus names This also renames measurementOptions functions: - withPrometheusDescription -> withPrometheusHelpText - withGenericPrometheusDescription -> withGenericPrometheusHelpText - generatePrometheusDescription -> generatePrometheusHelpText

Prometheus metrics are now automatically converted to a measurement's elementary unit.

…riptions Unit stuff is now in a separate package called `units`. units.go has been completely refactored to use the functional options pattern as well.

…measurement Prometheus (partial) names: string_n_energy_generated

Bus scan metrics are pointless as they're used for diagnosis purposes. As they're not registered and no REST is available, we can remove these metrics.

…metheus Also removes debug message of printing all measurement names.

This allows us to pass a measurement's timestamp and using setters on gauges.

# Conflicts: # go.mod # go.sum

remove collectors for device, handlers, publishers and sockets as they are superfluous and uninteresting.

reduces the name FQ name of measurement und moves the unit with its abbreviation into the label/value section.

because contains code gen programs

it does not make sense and make grafana implementation more difficult. Ot it's me ;-)

use direct map access instead of iterating over it.

than previous value, if set. if the current value is lower than we skip that value

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Prometheus support v2 #342

Add Prometheus support v2 #342

Commits on Aug 3, 2024

Add Prometheus support v2 #342

Are you sure you want to change the base?

Add Prometheus support v2 #342

Commits on Aug 3, 2024