diff --git a/README.md b/README.md index fbd7a39..8464fd9 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,9 @@ The exporter accepts the following command-line options: The exporter reads the following environment variables: -| Name | Description | Default value | -| --------------- | --------------------------------------------------------------------------------------------------------- | -------------------- | -| ADMIN_PASSWORD | Password of the Livebox "admin" user. The exporter will exit if this environment variable is not defined. | | -| LIVEBOX_ADDRESS | Address of the Livebox. | `http://192.168.1.1` | -| LIVEBOX_CACERT | Optional path to a PEM-encoded CA certificate file on the local disk. | | +| Name | Description | Default value | +| -------------- | --------------------------------------------------------------------------------------------------------- | ------------- | +| ADMIN_PASSWORD | Password of the Livebox "admin" user. The exporter will exit if this environment variable is not defined. | | ### Docker diff --git a/charts/livebox-exporter/Chart.yaml b/charts/livebox-exporter/Chart.yaml index fe972e1..171c10a 100644 --- a/charts/livebox-exporter/Chart.yaml +++ b/charts/livebox-exporter/Chart.yaml @@ -2,5 +2,5 @@ apiVersion: v2 name: livebox-exporter description: A prometheus exporter for Livebox type: application -version: 0.3.0 -appVersion: "v0.3.0" +version: 0.2.0 +appVersion: "v0.2.0" diff --git a/charts/livebox-exporter/templates/configmap.yaml b/charts/livebox-exporter/templates/configmap.yaml deleted file mode 100644 index aefe3a2..0000000 --- a/charts/livebox-exporter/templates/configmap.yaml +++ /dev/null @@ -1,10 +0,0 @@ -{{- if .Values.livebox.caCert }} -apiVersion: v1 -kind: ConfigMap -metadata: - name: {{ include "livebox-exporter.fullname" . }} - labels: - {{- include "livebox-exporter.labels" . | nindent 4 }} -data: - ca.crt: {{ toYaml .Values.livebox.caCert | indent 2 }} -{{- end }} \ No newline at end of file diff --git a/charts/livebox-exporter/templates/deployment.yaml b/charts/livebox-exporter/templates/deployment.yaml index e7cb588..be2aa8d 100644 --- a/charts/livebox-exporter/templates/deployment.yaml +++ b/charts/livebox-exporter/templates/deployment.yaml @@ -41,26 +41,13 @@ spec: - name: ADMIN_PASSWORD valueFrom: secretKeyRef: - {{- if .Values.livebox.adminPassword.secretKeyRef }} - name: {{ .Values.livebox.adminPassword.secretKeyRef.name}} - key: {{ .Values.livebox.adminPassword.secretKeyRef.key }} + {{- if .Values.adminPassword.secretKeyRef }} + name: {{ .Values.adminPassword.secretKeyRef.name}} + key: {{ .Values.adminPassword.secretKeyRef.key }} {{- else }} name: {{ include "livebox-exporter.fullname" . }}-admin key: password {{- end }} - {{- with .Values.livebox.address }} - - name: LIVEBOX_ADDRESS - value: {{ . }} - {{- end }} - {{- if .Values.livebox.caCert }} - - name: LIVEBOX_CACERT - value: /etc/livebox/certs/ca.crt - {{- end }} - {{- if .Values.livebox.caCert }} - volumeMounts: - - name: livebox-crt - mountPath: /etc/livebox/certs - {{- end }} {{- with .Values.nodeSelector }} nodeSelector: {{- toYaml . | nindent 8 }} @@ -73,9 +60,3 @@ spec: tolerations: {{- toYaml . | nindent 8 }} {{- end }} - {{- if .Values.livebox.caCert }} - volumes: - - name: livebox-crt - configMap: - name: {{ include "livebox-exporter.fullname" . }} - {{- end }} \ No newline at end of file diff --git a/charts/livebox-exporter/templates/secret.yaml b/charts/livebox-exporter/templates/secret.yaml index 18a30f7..f2f0c3b 100644 --- a/charts/livebox-exporter/templates/secret.yaml +++ b/charts/livebox-exporter/templates/secret.yaml @@ -1,4 +1,4 @@ -{{- if not .Values.livebox.adminPassword.secretKeyRef }} +{{- if not .Values.adminPassword.secretKeyRef }} apiVersion: v1 kind: Secret metadata: @@ -7,5 +7,5 @@ metadata: {{- include "livebox-exporter.labels" . | nindent 4 }} type: Opaque data: - password: {{ .Values.livebox.adminPassword.value | b64enc }} + password: {{ .Values.adminPassword.value | b64enc }} {{- end }} \ No newline at end of file diff --git a/charts/livebox-exporter/values.yaml b/charts/livebox-exporter/values.yaml index e2a2cee..98120a7 100644 --- a/charts/livebox-exporter/values.yaml +++ b/charts/livebox-exporter/values.yaml @@ -1,3 +1,7 @@ +# Default values for livebox-exporter. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + replicaCount: 1 image: @@ -6,19 +10,12 @@ image: # Overrides the image tag whose default is the chart appVersion. tag: "" -livebox: - adminPassword: - secretKeyRef: {} - # name: "" - # key: "" +adminPassword: + secretKeyRef: {} + # name: "" + # key: "" - value: "changeme" - - # Address of the Livebox. If empty the exporter will use its own default value. - address: "" - - # CA cert of the Livebox. - caCert: "" + value: "changeme" imagePullSecrets: [] nameOverride: "" diff --git a/go.mod b/go.mod index 1929fff..f497aca 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/Tomy2e/livebox-exporter go 1.18 require ( - github.com/Tomy2e/livebox-api-client v0.0.0-20230524112450-31caca47cbd8 + github.com/Tomy2e/livebox-api-client v0.0.0-20230304114924-a629a6a185e7 github.com/prometheus/client_golang v1.14.0 golang.org/x/exp v0.0.0-20230315142452-642cacee5cc0 golang.org/x/sync v0.1.0 diff --git a/go.sum b/go.sum index ada3d6e..acacb92 100644 --- a/go.sum +++ b/go.sum @@ -33,8 +33,8 @@ cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9 dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= -github.com/Tomy2e/livebox-api-client v0.0.0-20230524112450-31caca47cbd8 h1:rVK1emWX3JW3nNhLdl76M4RJgmMj/hcgQVOJmrh2r9Y= -github.com/Tomy2e/livebox-api-client v0.0.0-20230524112450-31caca47cbd8/go.mod h1:3uvJQHRP5V3BKPTzWCOmUMxZrPbJNl45Wu7ueX9L8QM= +github.com/Tomy2e/livebox-api-client v0.0.0-20230304114924-a629a6a185e7 h1:aX04myQJxWqjP1I1S8jiE8fKyXSu4CHKMBOCUMTwlCI= +github.com/Tomy2e/livebox-api-client v0.0.0-20230304114924-a629a6a185e7/go.mod h1:3uvJQHRP5V3BKPTzWCOmUMxZrPbJNl45Wu7ueX9L8QM= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= diff --git a/internal/collector/deviceinfo.go b/internal/collector/deviceinfo.go index 37827d8..e317cfc 100644 --- a/internal/collector/deviceinfo.go +++ b/internal/collector/deviceinfo.go @@ -14,7 +14,7 @@ var _ prometheus.Collector = &DeviceInfo{} // DeviceInfo implements a prometheus Collector that returns Livebox specific metrics. type DeviceInfo struct { - client *livebox.Client + client livebox.Client numberOfRebootsMetric *prometheus.Desc uptimeMetric *prometheus.Desc memoryTotalMetric *prometheus.Desc @@ -22,7 +22,7 @@ type DeviceInfo struct { } // NewDeviceInfo returns a new DeviceInfo collector using the specified client. -func NewDeviceInfo(client *livebox.Client) *DeviceInfo { +func NewDeviceInfo(client livebox.Client) *DeviceInfo { return &DeviceInfo{ client: client, numberOfRebootsMetric: prometheus.NewDesc( diff --git a/internal/poller/devices.go b/internal/poller/devices.go index 5794118..a244969 100644 --- a/internal/poller/devices.go +++ b/internal/poller/devices.go @@ -13,12 +13,12 @@ var _ Poller = &DevicesTotal{} // DevicesTotal allows to poll the total number of active devices. type DevicesTotal struct { - client *livebox.Client + client livebox.Client devicesTotal *prometheus.GaugeVec } // NewDevicesTotal returns a new DevicesTotal poller. -func NewDevicesTotal(client *livebox.Client) *DevicesTotal { +func NewDevicesTotal(client livebox.Client) *DevicesTotal { return &DevicesTotal{ client: client, devicesTotal: prometheus.NewGaugeVec(prometheus.GaugeOpts{ diff --git a/internal/poller/interface.go b/internal/poller/interface.go index 824587a..03c152e 100644 --- a/internal/poller/interface.go +++ b/internal/poller/interface.go @@ -15,12 +15,12 @@ var _ Poller = &InterfaceMbits{} // InterfaceMbits allows to poll the current bandwidth usage on the Livebox // interfaces. type InterfaceMbits struct { - client *livebox.Client + client livebox.Client txMbits, rxMbits *prometheus.GaugeVec } // NewInterfaceMbits returns a new InterfaceMbits poller. -func NewInterfaceMbits(client *livebox.Client) *InterfaceMbits { +func NewInterfaceMbits(client livebox.Client) *InterfaceMbits { return &InterfaceMbits{ client: client, txMbits: prometheus.NewGaugeVec(prometheus.GaugeOpts{ diff --git a/internal/poller/interface_homelan.go b/internal/poller/interface_homelan.go index 368efd9..02e882b 100644 --- a/internal/poller/interface_homelan.go +++ b/internal/poller/interface_homelan.go @@ -22,14 +22,14 @@ var _ Poller = &InterfaceHomeLanMbits{} // InterfaceHomeLanMbits is an experimental poller to get the current bandwidth // usage on the Livebox interfaces. type InterfaceHomeLanMbits struct { - client *livebox.Client + client livebox.Client interfaces []*exporterLivebox.Interface bitrate *bitrate.Bitrate txMbits, rxMbits *prometheus.GaugeVec } // NewInterfaceHomeLanMbits returns a new InterfaceMbits poller. -func NewInterfaceHomeLanMbits(client *livebox.Client, interfaces []*exporterLivebox.Interface) *InterfaceHomeLanMbits { +func NewInterfaceHomeLanMbits(client livebox.Client, interfaces []*exporterLivebox.Interface) *InterfaceHomeLanMbits { return &InterfaceHomeLanMbits{ client: client, interfaces: interfaces, diff --git a/internal/poller/interface_netdev.go b/internal/poller/interface_netdev.go index 94966e3..306e91f 100644 --- a/internal/poller/interface_netdev.go +++ b/internal/poller/interface_netdev.go @@ -16,14 +16,14 @@ var _ Poller = &InterfaceNetDevMbits{} // InterfaceNetDevMbits is an experimental poller to get the current bandwidth // usage on the Livebox interfaces. type InterfaceNetDevMbits struct { - client *livebox.Client + client livebox.Client interfaces []*exporterLivebox.Interface bitrate *bitrate.Bitrate txMbits, rxMbits *prometheus.GaugeVec } // NewInterfaceNetDevMbits returns a new InterfaceNetDevMbits poller. -func NewInterfaceNetDevMbits(client *livebox.Client, interfaces []*exporterLivebox.Interface) *InterfaceNetDevMbits { +func NewInterfaceNetDevMbits(client livebox.Client, interfaces []*exporterLivebox.Interface) *InterfaceNetDevMbits { return &InterfaceNetDevMbits{ client: client, interfaces: interfaces, diff --git a/internal/poller/wan.go b/internal/poller/wan.go index 058fdc6..90089f0 100644 --- a/internal/poller/wan.go +++ b/internal/poller/wan.go @@ -14,13 +14,13 @@ var _ Poller = &WANMbits{} // WANMbits is an experimental poller to get the current bandwidth usage on the // WAN interface of the Livebox. type WANMbits struct { - client *livebox.Client + client livebox.Client bitrate *bitrate.Bitrate txMbits, rxMbits prometheus.Gauge } // NewWANMbits returns a new WANMbits poller. -func NewWANMbits(client *livebox.Client) *WANMbits { +func NewWANMbits(client livebox.Client) *WANMbits { return &WANMbits{ client: client, bitrate: bitrate.New(InterfaceHomeLanMbitsMinDelay), diff --git a/main.go b/main.go index 98b7aca..fd4b671 100644 --- a/main.go +++ b/main.go @@ -2,12 +2,9 @@ package main import ( "context" - "crypto/tls" - "crypto/x509" "errors" "flag" "fmt" - "io/ioutil" "log" "net/http" "os" @@ -40,14 +37,10 @@ var experimentalMetrics = []string{ func parseExperimentalFlag( ctx context.Context, - client *livebox.Client, + client livebox.Client, experimental string, pollingFrequency *uint, ) (pollers []poller.Poller) { - if experimental == "" { - return nil - } - var ( interfaces []*exporterLivebox.Interface err error @@ -103,50 +96,6 @@ func parseExperimentalFlag( return } -func getHTTPClient() (*http.Client, error) { - liveboxCACertPath := os.Getenv("LIVEBOX_CACERT") - - if liveboxCACertPath == "" { - return http.DefaultClient, nil - } - - // Get the SystemCertPool, continue with an empty pool on error. - rootCAs, _ := x509.SystemCertPool() - if rootCAs == nil { - rootCAs = x509.NewCertPool() - } - - certs, err := ioutil.ReadFile(liveboxCACertPath) - if err != nil { - return nil, fmt.Errorf("failed to read livebox CA cert: %w", err) - } - - if ok := rootCAs.AppendCertsFromPEM(certs); !ok { - return nil, errors.New("no livebox CA cert was successfully added") - } - - return &http.Client{ - Transport: &http.Transport{ - TLSClientConfig: &tls.Config{ - RootCAs: rootCAs, - }, - }, - }, nil -} - -func isFatalError(err error) bool { - if errors.Is(err, livebox.ErrInvalidPassword) { - return true - } - - var certError *tls.CertificateVerificationError - if errors.As(err, &certError) { - return true - } - - return false -} - func main() { pollingFrequency := flag.Uint("polling-frequency", defaultPollingFrequency, "Polling frequency") listen := flag.String("listen", ":8080", "Listening address") @@ -161,28 +110,10 @@ func main() { log.Fatal("ADMIN_PASSWORD environment variable must be set") } - liveboxAddress := os.Getenv("LIVEBOX_ADDRESS") - if liveboxAddress == "" { - liveboxAddress = livebox.DefaultAddress - } - - httpClient, err := getHTTPClient() - if err != nil { - log.Fatal(err) - } - - client, err := livebox.NewClient( - adminPassword, - livebox.WithAddress(liveboxAddress), - livebox.WithHTTPClient(httpClient), - ) - if err != nil { - log.Fatalf("Failed to create Livebox client: %v", err) - } - var ( ctx = context.Background() registry = prometheus.NewRegistry() + client = livebox.NewClient(adminPassword) pollers = poller.Pollers{ poller.NewDevicesTotal(client), poller.NewInterfaceMbits(client), @@ -205,7 +136,7 @@ func main() { go func() { for { if err := pollers.Poll(ctx); err != nil { - if isFatalError(err) { + if errors.Is(err, livebox.ErrInvalidPassword) { log.Fatal(err) } diff --git a/pkg/livebox/discovery.go b/pkg/livebox/discovery.go index 0433a92..6e496f7 100644 --- a/pkg/livebox/discovery.go +++ b/pkg/livebox/discovery.go @@ -27,7 +27,7 @@ func (i *Interface) IsWLAN() bool { } // DiscoverInterfaces discovers network interfaces on the Livebox. -func DiscoverInterfaces(ctx context.Context, client *livebox.Client) ([]*Interface, error) { +func DiscoverInterfaces(ctx context.Context, client livebox.Client) ([]*Interface, error) { var mibs struct { Status struct { Base map[string]struct {