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:
A Loki-based logging stack consists of 3 components:
promtail
is the agent, responsible for gathering logs and sending them to Loki.loki
is the main server, responsible for storing logs and processing queries.Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy
Loki is like Prometheus, but for logs: we prefer a multidimensional label-based approach to indexing, and want a single-binary, easy to operate system with no dependencies. Loki differs from Prometheus by focusing on logs instead of metrics, and delivering logs via push, instead of pull.
Commonly used sections:
If you have any questions or feedback regarding Loki:
Your feedback is always welcome.
Refer to CONTRIBUTING.md
Loki can be run in a single host, no-dependencies mode using the following commands.
You need go
, we recommend using the version found in our build Dockerfile
$ go get github.com/grafana/loki
$ cd $GOPATH/src/github.com/grafana/loki # GOPATH is $HOME/go by default.
$ go build ./cmd/loki
$ ./loki -config.file=./cmd/loki/loki-local-config.yaml
...
To build Promtail on non-Linux platforms, use the following command:
$ go build ./clients/cmd/promtail
On Linux, Promtail requires the systemd headers to be installed if
Journal support is enabled.
To enable Journal support the go build tag flag promtail_journal_enabled
should be passed
With Journal support on Ubuntu, run with the following commands:
$ sudo apt install -y libsystemd-dev
$ go build --tags=promtail_journal_enabled ./clients/cmd/promtail
With Journal support on CentOS, run with the following commands:
$ sudo yum install -y systemd-devel
$ go build --tags=promtail_journal_enabled ./clients/cmd/promtail
Otherwise, to build Promtail without Journal support, run go build
with CGO disabled:
$ CGO_ENABLED=0 go build ./clients/cmd/promtail
Please see ADOPTERS.md for some of the organizations using Loki today. If you would like to add your organization to the list, please open a PR to add it to the list.
Grafana Loki is distributed under AGPL-3.0-only. For Apache-2.0 exceptions, see LICENSING.md.