Github url

loki

by grafana

grafana /loki

Like Prometheus, but for logs.

10.1K Stars 1.0K Forks Last release: about 2 months ago (v1.5.0) Apache License 2.0 1.6K Commits 13 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Loki Logo

Drone CICircleCIGo Report CardSlack

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. 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
    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.

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

Commonly used sections (from the latest release v1.5.0):

  • API documentation for alternative ways of getting logs into Loki.
  • Labels
  • Operations for important aspects of running Loki.
  • Promtail is an agent which can tail your log files and push them to Loki.
  • Pipelines for detailed log processing pipeline documentation
  • Docker Logging Driver is a docker plugin to send logs directly to Loki from Docker containers.
  • LogCLI on how to query your logs without Grafana.
  • Loki Canary for monitoring your Loki installation for missing logs.
  • Troubleshooting for help around frequent error messages.
  • Loki in Grafana for how to set up a Loki datasource in Grafana and query your logs.

Getting Help

If you have any questions or feedback regarding Loki:

Your feedback is always welcome.

Further Reading

Contributing

Refer to CONTRIBUTING.md

Building from source

Loki can be run in a single host, no-dependencies mode using the following commands.

You need

go

v1.10+ installed locally.

$ 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 ./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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.