README
¶
youless-observer
Service youless-observer is a real-time utility usage observer for the YouLess energy meter device. It collects
metrics data and can send it to any OTEL compatible backend, notify MQTT broker(s), or stream it via gRPC.
Key features are:
- export metrics via OTLP
- scrape metrics via Prometheus
- send metrics via MQTT (work in progress)
- stream metrics via gRPC (work in progress)
Need to store the metrics data for a longer period of time? Have a look at youless-logger.
Installation
The recommended way to run youless-observer is by using the
available Docker image.
A Helm chart is also available to easily deploy the service inside a Kubernetes
cluster.
Documentation
Additional detailed documentation is available at pkg.go.dev
Created with
License
Copyright © 2024 Roel Schut. All rights reserved.
This project is governed by a BSD-style license that can be found in the LICENSE file.
Documentation
¶
Index ¶
Constants ¶
const ( ErrAlreadyStarted errors.Msg = "observer is already started" ErrUnstartedStop errors.Msg = "cannot stop observer that is not started" )
const MeterReadingObserverName = "youless.observer.meter"
const PhaseReadingObserverName = "youless.observer.phase"
const Version = "0.1.0-rc2"
Version of the package and its app.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MeterReadingRegisterer ¶
type MeterReadingRegisterer struct {
ExcludePower bool
ExcludeS0 bool
ExcludeGas bool
ExcludeWater bool
// contains filtered or unexported fields
}
func NewMeterReadingRegisterer ¶
func NewMeterReadingRegisterer(client *youlessclient.Client) *MeterReadingRegisterer
func (*MeterReadingRegisterer) Register ¶
func (reg *MeterReadingRegisterer) Register(meter metric.Meter) (Registration, error)
Register registers metrics gauges to the provided meter and starts observing them by getting meter readings from the client.
func (*MeterReadingRegisterer) WithClient ¶
func (reg *MeterReadingRegisterer) WithClient(client *youlessclient.Client) *MeterReadingRegisterer
type Observer ¶
type Observer struct {
// contains filtered or unexported fields
}
func NewObserver ¶
func NewObserver(prov metric.MeterProvider, opts ...Option) (*Observer, error)
type Option ¶
func WithLogger ¶
func WithMeterReading ¶
func WithMeterReading(reg MeterReadingRegisterer, client *youlessclient.Client) Option
func WithPhaseReading ¶
func WithPhaseReading(reg PhaseReadingRegisterer, client *youlessclient.Client) Option
func WithRegisterer ¶
func WithRegisterer(name string, reg Registerer) Option
type PhaseReadingRegisterer ¶
type PhaseReadingRegisterer struct {
ExcludePower bool
SinglePhase bool
// contains filtered or unexported fields
}
func NewPhaseReadingRegisterer ¶
func NewPhaseReadingRegisterer(client *youlessclient.Client) *PhaseReadingRegisterer
func (*PhaseReadingRegisterer) Register ¶
func (reg *PhaseReadingRegisterer) Register(meter metric.Meter) (Registration, error)
Register registers metrics gauges to the provided meter and starts observing them by getting phase readings from the client.
func (*PhaseReadingRegisterer) WithClient ¶
func (reg *PhaseReadingRegisterer) WithClient(client *youlessclient.Client) *PhaseReadingRegisterer
type Registerer ¶
type Registerer interface {
Register(meter metric.Meter) (Registration, error)
}
type Registration ¶
type Registration interface {
Unregister() error
}
Source Files
Directories