aquasecurity / aquasecurity/tracee

Replace deprecated Promtail with Grafana Alloy

Open
#5,219 0 comments 0 reactions 0 assignees View on GitHub
kind/documentation
Dominant language
Go
Stars
4.6k
Forks
507
Avg merge
2d 8h
Merged PRs (30d)
9

Description

This issue is in relation to the *Using Promtail, Loki and Grafana to access Tracee Logs* tutorial, located in the documentation at [https://aquasecurity.github.io/tracee/latest/tutorials/promtail/](https://aquasecurity.github.io/tracee/latest/tutorials/promtail/).

The tutorial uses *Promtail* which is now deprecated. (See [https://grafana.com/docs/loki/latest/send-data/promtail/installation/#install-promtail](https://grafana.com/docs/loki/latest/send-data/promtail/installation/#install-promtail).

Also the *grafana/loki-distributed* helm chart used in the tutorial is also deprecated. (See [[grafana/loki-distributed](https://grafana.com/docs/loki/latest/setup/migrate/migrate-from-distributed)](https://grafana.com/docs/loki/latest/setup/migrate/migrate-from-distributed/)).

The Grafana documentation recommends the following migrations:

| Deprecated | New | Source |
| ----------- | ----------- | ----------- |
| Promtail | Grafana Alloy | [Migrate from Promtail to Grafana Alloy](https://grafana.com/docs/alloy/latest/set-up/migrate/from-promtail/) |
| loki-distributed Helm chart | loki Helm Chart, v3.0 or higher| [Migrate from loki-distributed Helm chart](https://grafana.com/docs/loki/latest/setup/migrate/migrate-from-distributed/#migrate-from-loki-distributed-helm-chart) |

I propose updating the [tutorial](https://aquasecurity.github.io/tracee/latest/tutorials/promtail/) as below:

- Migrate from `Promtail` to `Grafana Alloy`
- Migrate from `loki-distributed` Helm chart to `loki` Helm Chart, v3.0 or higher

And also clarifying ways to access to Grafana Dashboard running in remote servers, using e.g. ssh tunneling to local machine.

Contributor guide

Open the contributing guide

Research direction

Start with the Promtail tutorial at https://aquasecurity.github.io/tracee/latest/tutorials/promtail/ and compare its setup with Grafana's migration guidance for Alloy and the loki Helm chart. Done means the tutorial no longer uses Promtail or loki-distributed, uses loki chart v3 or higher, and explains remote Grafana access such as SSH tunneling.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
documentation, observability-sre
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.