https://github.com/eliashaeussler/db-train-metrics

📈 Visualizes DB train data using Grafana, Prometheus and the DB Onboard API
https://github.com/eliashaeussler/db-train-metrics

db grafana prometheus python train wifi wifionice

Last synced: 4 months ago
JSON representation

📈 Visualizes DB train data using Grafana, Prometheus and the DB Onboard API

• Host: GitHub
• URL: https://github.com/eliashaeussler/db-train-metrics
• Owner: eliashaeussler
• Created: 2024-07-02T17:34:30.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-09-13T11:53:50.000Z (5 months ago)
• Last Synced: 2024-09-13T23:29:29.706Z (5 months ago)
• Topics: db, grafana, prometheus, python, train, wifi, wifionice
• Language: Python
• Homepage:
• Size: 1.42 MB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DB train metrics

This repository allows to visualize data of the current trip when

travelling on board of a DB train. It visualizes speed and delay

and displays information about the current train and next station.

![Screenshot](docs/screenshot.png)

## Requirements

> [!NOTE]

> You must be connected to a `WIFIonICE` network in order for this

> repository to work since it fetches all relevant information from

> DB Onboard APIs.

* [Docker](https://docs.docker.com/get-docker/)

* Connection to [`WIFIonICE` network](https://int.bahn.de/en/trains/wifi)

## Usage

> [!TIP]

> Since bandwidth on trains is limited, it is recommended to pull all

> necessary Docker images prior to boarding the train. Just clone the

> repository and run `docker compose build && docker compose pull`.

1. Clone the repository

2. Run `docker compose up -d`

3. Open Grafana at  in your browser

4. Login with default credentials (`admin`/`admin`)

5. Add a new [Prometheus data source](https://grafana.com/docs/grafana/latest/datasources/prometheus/configure-prometheus-data-source/)

    * Prometheus server URL: `http://prometheus:9090`

6. Add a new [dashboard](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/import-dashboards/)

    * Select _New_ > _Import_

    * Paste the contents from [grafana-dashboard.json](grafana-dashboard.json)

    * Select the Prometheus data source

## Troubleshooting

If your dashboard doesn't receive any data make sure that you are

really connected to the ICE Wifi and that you can access

[iceportal.de](https://iceportal.de) in  your browser.

You can also check for connection problems by running

`docker compose logs -f bridge`. The logs should show failed requests

to fetch JSON from https://iceportal.de/api1/rs/status

and https://iceportal.de/api1/rs/tripInfo/trip.

Unfortunately, the connection to the DB Onboard API is not very stable

and may not always work.

## Stack

* [Prometheus](https://prometheus.io/) as data source

* [Grafana](https://grafana.com/) for visualization

* [Python](https://www.python.org/) script as bridge between DB Onboard API and Prometheus

* [Docker](https://www.docker.com/) for containerization