mirror of https://github.com/YunoHost-Apps/loki_ynh.git synced 2024-09-03 19:36:16 +02:00

Grafana Loki is a set of components that can be composed into a fully featured logging stack.

Find a file

yunohost-bot 5a4538a29b Auto-update README		2023-05-04 06:13:47 +00:00
.github	[autopatch] Upgrade auto-updater	2023-02-24 18:19:23 +01:00
conf	Upgrade to v2.8.2	2023-05-04 06:13:42 +00:00
doc	Testing (#4 )	2022-12-31 11:31:16 +01:00
scripts	Testing (#4 )	2022-12-31 11:31:16 +01:00
sources	Testing (#4 )	2022-12-31 11:31:16 +01:00
.gitignore	Initial commit	2022-12-24 15:14:20 +01:00
check_process	First commit	2022-12-26 23:06:37 +01:00
LICENSE	Fill licence file: AGPL	2023-01-09 11:23:39 +01:00
manifest.json	Upgrade to v2.8.2	2023-05-04 06:13:42 +00:00
README.md	Auto-update README	2023-05-04 06:13:47 +00:00
README_fr.md	Auto-update README	2023-05-04 06:13:47 +00:00

README.md

Loki + Promtail for YunoHost

Lire ce readme en français.

This package allows you to install Loki + Promtail quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Loki is a horizontally-scalable, highly-available, multi-tenant log aggregation system inspired by Prometheus. It is designed to be very cost effective and easy to operate. It does not index the contents of the logs, but rather a set of labels for each log stream.

Compared to other log aggregation systems, Loki:

does not do full text indexing on logs. By storing compressed, unstructured logs and only indexing metadata, Loki is simpler to operate and cheaper to run.
indexes and groups log streams using the same labels you’re already using with Prometheus, enabling you to seamlessly switch between metrics and logs using the same labels that you’re already using with Prometheus.
is an especially good fit for storing Kubernetes Pod logs. Metadata such as Pod labels is automatically scraped and indexed.
has native support in Grafana (needs Grafana v6.0).

A Loki-based logging stack consists of 3 components:

Promtail (included in this package) is the agent, responsible for gathering logs and sending them to Loki.
Loki is the main server, responsible for storing logs and processing queries.
Grafana for querying and displaying the logs.

Shipped version: 2.8.2~ynh1

Disclaimers / important information

Loki is not exposed to the web;
If you want to add pieces of configuration or overwrite the configuration, add a new file in /etc/loki/loki.d/ for Loki or in /etc/loki/promtail.d/ for promtail

Documentation and resources

Official app website: https://grafana.com/docs/loki/latest/
Official admin documentation: https://grafana.com/docs/loki/latest/
Upstream app code repository: https://github.com/grafana/loki
YunoHost documentation for this app: https://yunohost.org/app_loki
Report a bug: https://github.com/YunoHost-Apps/loki_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/loki_ynh/tree/testing --debug
or
sudo yunohost app upgrade loki -u https://github.com/YunoHost-Apps/loki_ynh/tree/testing --debug