hekmon/vigixporter repository overview

⁠Vigixporter

"Vigicrues⁠" Victoria Metrics exporter/pusher. Data is probbed from hubeau⁠.

⁠How it works

To respect the timestamp of the original data source, vigixporter is not scrapable: it pushes the converted data with the original timestamp.

When a new station is added, the maximum backlog is fetched from the hubeau API (actually 30 days).

⁠State & Cache

The exporter maintains a state and caches that are dumped to disk in order to be restored at next start. The state file (vigixporter_state.json) is written on /var/lib/vigixporter; feel free to mount it wherever you like.

For each station the last data point timestamp is saved. On polling, vigixporter selects the oldest timestamp seen for all the tracked stations in order to request the minimum information from hubeau. Every point already known is skipped during processing to avoid duplicates. Once retreived, data is then converted and transmitted to the Victoria Metrics pusher component which maintains its own cache. If the victoria Metrics remote is offline, the converted datapoints are kept in cache until successfully pushed.

⁠Configuration

⁠environment variables

• VIGIXPORTER_STATIONS - The list of stations IDs to scrap from hubeau. An online tool⁠ can be used to find IDs. Ex: VIGIXPORTER_STATIONS=F700000103,F490000104,F664000404.
• VIGIXPORTER_VMURL - The URL of the victoria metrics import endpoint⁠.
• VIGIXPORTER_VMUSER & VIGIXPORTER_VMPASS - Optional, HTTP basic auth for Victoria Metrics. Recommended for public URL (with https !).

⁠Pushed metrics

2 metrics are created with the same tag set. Exemple:

• vigixporter_water_level{latitude="48.844690", longitude="2.365511", site_code="F7000001", station_code="F700000103"} value is in millimeters
• vigixporter_water_flow{latitude="48.844690", longitude="2.365511", site_code="F7000001", station_code="F700000103"} value is in liters per second (divide by 1000 to obtain m3/s)