README
¶
Loki: like Prometheus, but for logs.
Fork of Loki 2.2.1 (apache2 licensed)
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:
promtailis the agent, responsible for gathering logs and sending them to Loki.lokiis the main server, responsible for storing logs and processing queries.- Grafana for querying and displaying the logs.
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.
Getting started
Upgrading
Documentation
Building from source
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/metrico/loki-apache
$ cd $GOPATH/src/github.com/metrico/loki-apache # 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 ./cmd/promtail
On Linux, Promtail requires the systemd headers to be installed for Journal support.
With Journal support on Ubuntu, run with the following commands:
$ sudo apt install -y libsystemd-dev
$ go build ./cmd/promtail
With Journal support on CentOS, run with the following commands:
$ sudo yum install -y systemd-devel
$ go build ./cmd/promtail
Otherwise, to build Promtail without Journal support, run go build
with CGO disabled:
$ CGO_ENABLED=0 go build ./cmd/promtail
License
Apache License 2.0, see LICENSE.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
chunks-inspect
Module
|
|
|
pkg
|
|
|
logql/log/logfmt
Adapted from https://github.com/go-logfmt/logfmt/ but []byte as parameter instead Original license is MIT.
|
Adapted from https://github.com/go-logfmt/logfmt/ but []byte as parameter instead Original license is MIT. |
|
logql/marshal
Package marshal converts internal objects to loghttp model objects.
|
Package marshal converts internal objects to loghttp model objects. |
|
logql/marshal/legacy
Package marshal converts internal objects to loghttp model objects.
|
Package marshal converts internal objects to loghttp model objects. |
|
logql/stats
Package stats provides primitives for recording metrics across the query path.
|
Package stats provides primitives for recording metrics across the query path. |
|
promtail/server/ui
Package ui provides the assets via a virtual filesystem.
|
Package ui provides the assets via a virtual filesystem. |
|
promtail/targets/windows/win_eventlog
Package win_eventlog Input plugin to collect Windows Event Log messages
|
Package win_eventlog Input plugin to collect Windows Event Log messages |
|
tools
|
|