https://github.com/jguer/itgmania-collector
Simple LGTM + Alloy OTEL collector for itgmania
https://github.com/jguer/itgmania-collector
Last synced: 5 months ago
JSON representation
Simple LGTM + Alloy OTEL collector for itgmania
- Host: GitHub
- URL: https://github.com/jguer/itgmania-collector
- Owner: Jguer
- Created: 2025-04-30T16:30:59.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-05-02T09:27:18.000Z (5 months ago)
- Last Synced: 2025-05-08T07:14:00.288Z (5 months ago)
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ITG Mania Collector
This collector group was created for [my fork of itgmania](https://github.com/jguer/itgmania) with the purpose of collecting data from the game using [OpenTelemetry](https://opentelemetry.io/) and sending it to a LGTM (Loki, Grafana, Tempo, Mimir) observability stack.
# Why
As a big fan of rhythm games, I wanted to explore the real-time applications of modern observability tools. What better way to learn the intricacies of OpenTelemetry and the LGTM stack (Loki, Grafana, Tempo, Mimir) than by applying them to the fast-paced data stream of a game like ITGMania? This project serves as both a learning exercise and a practical demonstration of instrumenting a C++ application for detailed telemetry.
# Docker Compose
This directory contains a Docker Compose environment that can be used to test instrumented ITGMania.
## Services
* Grafana: for visualizing telemetry (`localhost:3000`)
* Grafana Mimir: for storing metrics (`localhost:9009`)
* Grafana Loki: for storing logs (`localhost:3100`)
* Grafana Tempo: for storing traces (`localhost:3200`)
* Grafana Pyroscope: for storing profiles (`localhost:4040`)
* Grafana Alloy: Acts as an OpenTelemetry collector and sends self-monitoring data to the stack (`localhost:4317` for grpc, `localhost:4318` for http OTEL collector)
Grafana is automatically provisioned with the appropriate datasources.
To start the environment, run:
```bash
docker compose up -d
```
To stop the environment, run:
```bash
docker compose down
```
## Visualizing
To visualize ITG Mania data in Grafana, open in a web
browser and look at the 'MMR' dashboard.
> **NOTE**: It can take up to a minute for ITG Mania metrics and profiles to start
> appearing.