stiebeleltron-exporter

ifndef::env-github[:icons: font]
ifdef::env-github[]
:status:
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
:ext-relative: {outfilesuffix}
endif::[]

= Stiebel-Eltron Exporter

ifdef::status[]
image:https://img.shields.io/github/workflow/status/ccremer/stiebeleltron-exporter/Build/master[Build,link=https://github.com/ccremer/stiebeleltron-exporter/actions?query=workflow%3ABuild]
image:https://img.shields.io/codeclimate/maintainability/ccremer/stiebeleltron-exporter[Maintainability,link=https://codeclimate.com/github/ccremer/stiebeleltron-exporter]
image:https://img.shields.io/codeclimate/coverage/ccremer/stiebeleltron-exporter[Tests,link=https://codeclimate.com/github/ccremer/stiebeleltron-exporter]
image:https://img.shields.io/github/v/release/ccremer/stiebeleltron-exporter[Releases,link=https://github.com/ccremer/stiebeleltron-exporter/releases]
image:https://img.shields.io/github/license/ccremer/stiebeleltron-exporter[License,link=https://github.com/ccremer/stiebeleltron-exporter/blob/master/LICENSE]
endif::[]

== About

Scrapes a Stiebel-Eltron ISG installation and converts sensor data to Prometheus metrics.
It has been tested with ISG 10.2.0.

== Installing


=== Binary

. Download latest binary from the https://github.com/ccremer/stiebeleltron-exporter/releases[Releases page]
. `chmod +x stiebeleltron-exporter && mv stiebeleltron-exporter /usr/local/bin/`

=== Package

Comes with systemd unit file.

. Download latest package from the https://github.com/ccremer/stiebeleltron-exporter/releases[Releases page]
. `dpkg -i stiebeleltron-exporter_linux_amd64.deb` (Debian/Ubuntu)
. `rpm -i stiebeleltron-exporter_linux_amd64.rpm` (CentOS)
. `sudo systemctl daemon-reload`
. Edit the settings in `/etc/default/stiebeleltron-exporter`
. `sudo systemctl enable stiebeleltron-exporter`
. `sudo systemctl restart stiebeleltron-exporter`

=== Docker

. `docker run -d --name stiebeleltron-exporter -p "8080:8080" ghcr.io/ccremer/stiebeleltron-exporter`

=== Helm Chart

With https://ccremer.github.io/charts/stiebeleltron-exporter[stiebeleltron-exporter]

. `helm repo add ccremer https://ccremer.github.io/charts`
. `helm install stiebeleltron ccremer/stiebeleltron-exporter`

== Usage

[source,console]
----
stiebeleltron-exporter --isg.url http://isg.ip.or.hostname
----

Upon each call to `/metrics`, the exporter will do GET requests on the given URL, and translate the HTML responses to Prometheus metrics format.

== Configuration

`stiebeleltron-exporter` can be configured with CLI flags. Call the binary with `--help` to get a list of options.

[TIP]
All flags are also configurable with Environment variables.
Replace the `.` char with `_` and uppercase the names in order for them to be recognized, e.g. `--log.level debug` becomes `LOG_LEVEL=debug`.
CLI flags take precedence though.

== Developing

Requirements:

* Go

`make help` shows a list of possible tasks.