https://github.com/lukasmalkmus/tankerkoenig_exporter
A prometheus exporter for the Tankerkoenig API (gas prices).
https://github.com/lukasmalkmus/tankerkoenig_exporter
gasprices metrics prometheus prometheus-exporter tankerkoenig tankerkoenig-api
Last synced: about 2 months ago
JSON representation
A prometheus exporter for the Tankerkoenig API (gas prices).
- Host: GitHub
- URL: https://github.com/lukasmalkmus/tankerkoenig_exporter
- Owner: lukasmalkmus
- License: apache-2.0
- Created: 2017-05-02T21:23:08.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-20T09:51:18.000Z (about 1 year ago)
- Last Synced: 2024-05-02T06:05:13.460Z (about 1 year ago)
- Topics: gasprices, metrics, prometheus, prometheus-exporter, tankerkoenig, tankerkoenig-api
- Language: Go
- Homepage:
- Size: 8.54 MB
- Stars: 19
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tankerkoenig API Exporter for Prometheus
[![Workflow][workflow_badge]][workflow]
[![Latest Release][release_badge]][release]
[![License][license_badge]][license]
---
## Introduction
The _Tankerkoenig API Exporter_ is a simple server that scrapes the
[Tankerkoenig API] for gas station prices and exports them via HTTP for
Prometheus consumption.
## Usage
The first step is to grab an API key from the [Tankerkoenig site].
The exporter supports two different modes of operation:
1. **Geo-Mode**: The exporter will scrape all stations in a given radius around
a given location.
2. **Station-Mode**: The exporter will scrape only the stations given by their
IDs. To get station IDs, either use the API yourself or checkout the
[Tankstellen Finder].
**Important:** Be advised to set a high scrape interval (e.g. 5 minutes). Each
scrape performs an API call and to frequent requests can lead to the
**deauthorization** of your API key!
**Note:** Since _tankerkoenig_ isn't a very handy word, the metric namespace is
`tk`.
### Installation
The easiest way to run the exporter is by grabbing the latest binary from the
[release page][release].
### Using the application
Run the application with the `--help` flag to see all available options with
their descriptions and default values (if any).
#### Geo-Mode
```bash
export TANKERKOENIG_API_KEY="YOUR_API_KEY"
./tankerkoenig --tankerkoenig.location=u0yjje785f4 --tankerkoenig.radius=5
```
**Note:** The `--tankerkoenig.product` flag is currently not implemented.
#### Station-Mode
```bash
export TANKERKOENIG_API_KEY="YOUR_API_KEY"
./tankerkoenig --tankerkoenig.stations="51d4b55e-a095-1aa0-e100-80009459e03a"
```
**Note**: The `--tankerkoenig.stations` flag can be used multiple times to add multiple
stations to scrape.
### Using docker
Docker images are available on the [GitHub Package Registry].
```bash
# .env file contains TANKERKOENIG_API_KEY="YOUR_API_KEY"
docker run -p9386:9386/tcp --env-file=.env ghcr.io/lukasmalkmus/tankerkoenig-exporter:0.10.0 --tankerkoenig.stations="51d4b55e-a095-1aa0-e100-80009459e03a"
```
## Querying
The exporter exposes the following Tankerkoenig API related metrics (there are
a handful of exporter related metrics as well, like `up`, etc.):
- `tk_station_price_euro{id, product}`: The fuel price in euro per liter.
- `tk_station_open{id}`: Whether the station is open (`1`) or not (`0`).
- `tk_station_details{id, name, address, city, geohash, brand}`: Details of the station.
If you want to add station details when querying the price metric, you can join
the two metrics like this:
```promql
tk_station_price_euro * on (id) group_left(brand, address) tk_station_details
```
## Contributing
Feel free to submit PRs or to fill Issues. Every kind of help is appreciated.
## License
© Lukas Malkmus, 2023
Distributed under Apache License (`Apache License, Version 2.0`).
See [LICENSE](LICENSE) for more information.
[tankerkoenig api]: https://creativecommons.tankerkoenig.de/home
[tankerkoenig site]: https://creativecommons.tankerkoenig.de/api-key
[tankstellen finder]: https://creativecommons.tankerkoenig.de/TankstellenFinder/index.html
[github package registry]: https://github.com/lukasmalkmus/tankerkoenig_exporter/pkgs/container/tankerkoenig_exporter
[workflow]: https://github.com/lukasmalkmus/tankerkoenig_exporter/actions/workflows/ci.yaml
[workflow_badge]: https://img.shields.io/github/actions/workflow/status/lukasmalkmus/tankerkoenig_exporter/ci.yaml?branch=main
[release]: https://github.com/lukasmalkmus/tankerkoenig_exporter/releases
[release_badge]: https://img.shields.io/github/release/lukasmalkmus/tankerkoenig_exporter.svg
[license]: https://opensource.org/licenses/Apache-2.0
[license_badge]: https://img.shields.io/badge/license-Apache-blue.svg