Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qaware/cloud-computing-th-rosenheim-observability
Observability Stack with Loki, Grafana, Mimir and Tempo
https://github.com/qaware/cloud-computing-th-rosenheim-observability
grafana loki mimir observability tempo
Last synced: about 10 hours ago
JSON representation
Observability Stack with Loki, Grafana, Mimir and Tempo
- Host: GitHub
- URL: https://github.com/qaware/cloud-computing-th-rosenheim-observability
- Owner: qaware
- License: mit
- Created: 2022-11-10T10:48:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-29T20:55:53.000Z (11 months ago)
- Last Synced: 2023-12-16T14:08:03.530Z (11 months ago)
- Topics: grafana, loki, mimir, observability, tempo
- Language: HTML
- Homepage:
- Size: 768 KB
- Stars: 1
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Observability (Cloud Computing @ TH Rosenheim)
This project is a showcase of the LGTM stack to demonstrate the topic Observability.
The tle-fetcher retrieves TLE (two-line element set) data for calculating satellites trajectories from a NASA related API.
You can learn more information on the TLE format [here](https://en.wikipedia.org/wiki/Two-line_element_set), on orbital
mechanics [here](https://en.wikipedia.org/wiki/Orbital_mechanics) and while playing some rounds of Kerbal Space Program.
The sky-map service retrieves the data from tle-fetcher and outputs it as JSON.
This project uses Quarkus. If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
## Prerequisites
To build and run this application, you will need the following dependencies on your system:
| Name | Version |
|----------------|---------|
| Docker | * |
| Docker-Compose | 1.13.0+ |
| Java | 17 |
## Java services
### Building the application
You can build the application using Gradle:
```shell
$ ./gradlew build
```
This will build the Java applications and two docker images. The docker image will be registered as `qaware/tle-fetcher:1.0.0` and `qaware/sky-map:1.0.0` within your Docker daemon:
```shell
$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
qaware/sky-map 1.0.0 5f4a5695cc8f 7 seconds ago 438MB
qaware/tle-fetcher 1.0.0 55bd6d637c77 7 seconds ago 438MB
```
### Configuration
All relevant configuration can be found in each service `src/main/resources/application.properties`.
## The Grafana stack
The Grafana stack is configured in the directories `grafana`, `loki`, `promtail`, `mimir`,`grafana-agent` and `tempo`.
**NOTE**: It is important to change the permissions on the configuration files for the Grafana stack. Run the following command:
```shell
$ chmod -R o+rX grafana loki mimir grafana-agent promtail tempo
```
### Grafana
Grafana is the visualization engine of the Grafana stack.
The main configuration is done in `grafana.ini`.
You can provision several other things automatically, like dashboards and datasources. All of this is stored in `grafana/provisioning` and deployed automatically on startup.
### Loki
Loki is the log storage engine of the Grafana stack. In this repository, there is only the `loki/loki.yaml` with basic storage configuration.
### Promtail
Promtail is the logshipper of the Grafana stack. It periodically scrapes logfiles and sends them to Loki.
The configuration `promtail/promtail.yaml` scrapes the application logs from the services and pre-parses their JSON.
### Mimir
Mimir is a time series storage that can be connected to Grafana.
### Grafana Agent
Grafana Agent periodically scrapes metrics from known endpoints and sends it to Grafana Mimir.
### Tempo
Tempo stores APM and tracing data from services. It can also be connected to Grafana.
## Running the services
Run the applications with `docker compose`:
```shell
$ docker compose up
```
## Related Guides
- SmallRye OpenTracing ([guide](https://quarkus.io/guides/opentracing)): Trace your services with SmallRye OpenTracing
- Micrometer Registry Prometheus ([guide](https://quarkus.io/guides/micrometer)): Enable Prometheus support for Micrometer
- REST Client Classic ([guide](https://quarkus.io/guides/rest-client)): Call REST services
- RESTEasy Classic JSON-B ([guide](https://quarkus.io/guides/rest-json)): JSON-B serialization support for RESTEasy Classic
- RESTEasy Classic ([guide](https://quarkus.io/guides/resteasy)): REST endpoint framework implementing JAX-RS and more
- Logging JSON ([guide](https://quarkus.io/guides/logging#json-logging)): Add JSON formatter for console logging
- SmallRye Health ([guide](https://quarkus.io/guides/microprofile-health)): Monitor service health
- Micrometer metrics ([guide](https://quarkus.io/guides/micrometer)): Instrument the runtime and your application with dimensional metrics using Micrometer.