Like Prometheus, but for logs.
Clone or download
woodsaj Merge pull request #229 from grafana/issue190
add container_name label to logs
Latest commit a13dec4 Jan 19, 2019

README.md

Loki Logo

CircleCI Go Report Card Slack

Loki: like Prometheus, but for logs.

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, as 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 (already in the nightly builds, will be included in Grafana 6.0).

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.
  • Grafana for the UI.

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 focussing on logs instead of metrics, and delivering logs via push, instead of pull.

Getting started

For instructions on getting started with Loki, see our getting started docs.

For the beginnings of documentation on how to use Loki, see our usage docs. API documentation is also available.

Getting Help

If you have any questions or feedback regarding Loki:

Your feedback is always welcome.

Further Reading

Contributing

For now, you need to add your fork as a remote on the original $GOPATH/src/github.com/grafana/loki clone, so:

$ go get github.com/grafana/loki
$ cd $GOPATH/src/github.com/grafana/loki # GOPATH is $HOME/go by default.

$ git remote add <FORK_NAME> <FORK_URL>

Notice: go get return package github.com/grafana/loki: no Go files in /go/src/github.com/grafana/loki is normal.