Skip to content

Commit

Permalink
Add architecture diagram explaination
Browse files Browse the repository at this point in the history
  • Loading branch information
QuentinBisson committed Mar 21, 2024
1 parent f10fd28 commit a0bedd3
Showing 1 changed file with 12 additions and 2 deletions.
Expand Up @@ -24,13 +24,23 @@ Logging is an important pillar of observability and it is thus only natural that

This documentation will give you an overview of how logging is managed by Giant Swarm : which logs are stored, which tools we use to ship and store them as well as why we chose those tools in the first place.

## Overview of the logging pipeline
## Overview of the logging platform

Here is an architecture diagram of our current logging platform.
Here is an architecture diagram of our current logging platform:

![Logging pipeline architecture overview](logging-architecture.png)
<!-- Source: https://drive.google.com/file/d/1Gzl0mTdJcaui_zIC9QuHcgMX3QJygALo -->

In this diagram, you can see that we run the following tools in each management cluster as part of our logging platform:

- `Grafana Loki` that is accessible through our managed Grafana instance.
- `multi-tenant-proxy`, a proxy component used to handle multi-tenancy for Loki.
- A couple of loggings agents (`Grafana Promtail` and `Grafana Agent`) that run on the management cluster and your workload clusters alike. We currently need two different tools for different purposes:
- Promtail is used to retrieve the container and kubernetes audit logs

Check failure on line 39 in src/content/vintage/getting-started/observability/logging/architecture/index.md

View workflow job for this annotation

GitHub Actions / markdownlint problems

markdownlint problem

MD007/ul-indent Unordered list indentation [Expected: 4; Actual: 2]
- Grafana Agent to retrieve the kubernetes events.

Check failure on line 40 in src/content/vintage/getting-started/observability/logging/architecture/index.md

View workflow job for this annotation

GitHub Actions / markdownlint problems

markdownlint problem

MD007/ul-indent Unordered list indentation [Expected: 4; Actual: 2]

If you want to play with Loki, you should definitely check out our guides explaining [how to access Grafana]({{< relref "/vintage/getting-started/observability/visualization/access" >}}) and how to [explore logs with LogQL]({{< relref "/vintage/getting-started/observability/visualization/log-exploration" >}})

## Logs stored by Giant Swarm

Kubernetes clusters produces a vast amount of logs, whether they come from machines or containers.
Expand Down

0 comments on commit a0bedd3

Please sign in to comment.