mirror of
https://github.com/YunoHost-Apps/loki_ynh.git
synced 2024-09-03 19:36:16 +02:00
61 lines
3.1 KiB
Markdown
61 lines
3.1 KiB
Markdown
<!--
|
||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||
It shall NOT be edited by hand.
|
||
-->
|
||
|
||
# Loki + Promtail for YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/loki)  
|
||
|
||
[](https://install-app.yunohost.org/?app=loki)
|
||
|
||
*[Lire ce readme en français.](./README_fr.md)*
|
||
|
||
> *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](https://yunohost.org/#/install) 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](https://github.com/Yunohost-Apps/grafana_ynh) 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](https://github.com/YunoHost-Apps/loki_ynh/tree/testing).
|
||
|
||
To try the testing branch, please proceed like that.
|
||
|
||
``` bash
|
||
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
|
||
```
|
||
|
||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|