Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.58 KB

README.adoc

File metadata and controls

47 lines (32 loc) · 1.58 KB
Raw

prometheus-natureremo-exporter(1) Manual Page

Name

prometheus-natureremo-exporter - Prometheus exporter for Nature Remo

Synopsis

prometheus-natureremo-exporter OPTION…​

Description

prometheus-natureremo-exporter is a Prometheus exporter for Nature Remo, which exposes telemetry from integrated sensors in Nature Remo series and smart meters linked to Nature Remo E series.

Options

--help, -h

Prints command usage.

--web.listen-address=ADDR

Listens ADDR for telemetry. Default: ":9539"

--web.telemetry-path=PATH

Exposes metrics under PATH. Deafult: "/metrics"

--natureremo.access-token=file:PATH|env:VAR

(Required) Tells the exporter to obtain API access token from the specified source.

file:PATH

Read the token from the file at PATH.

env:VAR

Obtain the token from the environment variable VAR.

--natureremo.endpoint=URI

Tells the exporter to use the URI as the API endpoint. Default: "https://api.nature.global"

API Usage

prometheus-natureremo-exporter makes two API calls per scrape. It is recommended to either 1) set scrape_interval to 1m, or 2) set up a caching proxy and specify --natureremo.endpoint=https://caching-proxy while keeping scrape_interval to a smaller value.

License

This software is licensed under The MIT License. See the LICENSE file for terms.