Skip to content
Like Prometheus, but for logs.
Go Jsonnet Shell Ruby Makefile Python Other
Branch: master
Clone or download
Latest commit 7072ed7 Oct 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci bump up golangci to 1.20 (#1133) Oct 15, 2019
.drone bump up golangci to 1.20 (#1133) Oct 15, 2019
.github docs: fix Promtail / Loki capitalization (#1130) Oct 8, 2019
build dep => go mod (#1062) Sep 30, 2019
cmd bump up golangci to 1.20 (#1133) Oct 15, 2019
debug docs: fix Promtail / Loki capitalization (#1130) Oct 8, 2019
docs typo fix Oct 23, 2019
fluentd/fluent-plugin-grafana-loki Update `/loki/api/v1/push` to use the v1 json format (#1145) Oct 15, 2019
loki-build-image bump up golangci to 1.20 (#1133) Oct 15, 2019
pkg promtail: fix handling of JMESPath expression returning nil while par… Oct 21, 2019
production Adding Operational dashboards (#1188) Oct 22, 2019
tools list backups just before starting deletion of wanted backups Oct 9, 2019
vendor Updated cortex to latest master. (#1088) Oct 9, 2019
.gitignore dep => go mod (#1062) Sep 30, 2019
.golangci.yml Update golint (#1157) Oct 16, 2019
CHANGELOG.md Updating changelog for v0.3.0 (#906) Aug 18, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#516) May 15, 2019
CONTRIBUTING.md Go 1.13 (#1089) Oct 1, 2019
LICENSE Add logo to readme. (#59) Dec 11, 2018
Makefile Update golint (#1157) Oct 16, 2019
README.md Update README.md (#1132) Oct 9, 2019
go.mod promtail: added action_on_failure support to timestamp stage (#1123) Oct 10, 2019
go.sum Updated cortex to latest master. (#1088) Oct 9, 2019
mkdocs.yml docs: general documentation rework Sep 6, 2019

README.md

Loki Logo

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

Getting started

The Installation docs have instructions on how to install Loki via Docker images, Helm charts, Jsonnet, or from source.

You may also be interested in installing Promtail to send logs to Loki.

Once you have Promtail, Loki, and Grafana running, continue with our Getting Started Guide to get up and running with querying logs.

Documentation

The documentation with a Table of Contents can be found in docs/.

Some key documents to read:

  • API documentation for alternative ways of getting logs into Loki.
  • 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

License

Apache License 2.0, see LICENSE.

You can’t perform that action at this time.