README.md

Loki Documentation

Like Prometheus, but for logs!

Grafana Loki is a set of components that can be composed into a fully featured logging stack.

Unlike other logging systems, Loki is built around the idea of only indexing metadata about your logs: labels (just like Prometheus labels). Log data itself is then compressed and stored in chunks in object stores such as S3 or GCS, or even locally on the filesystem. A small index and highly compressed chunks simplifies the operation and significantly lowers the cost of Loki.

Table of Contents

1. Overview
   1. Comparison to other Log Systems
2. Installation
   1. Installing with Tanka
   2. Installing with Helm
   3. Installing with Docker
   4. Installing locally
3. Getting Started
   1. Grafana
   2. LogCLI
   3. Labels
   4. Troubleshooting
4. Best Practices
   1. Current Best Practices
5. Configuration
   1. Examples
6. Clients
   1. Promtail
      1. Installation
      2. Configuration
      3. Scraping
      4. Pipelines
      5. Troubleshooting
   2. Docker Driver
      1. Configuration
   3. Fluent Bit
   4. Fluentd
7. LogQL
8. Operations
   1. Authentication
   2. Observability
   3. Scalability
   4. Storage
      1. Table Manager
      2. Retention
      3. BoltDB Shipper
   5. Multi-tenancy
   6. Loki Canary
9. HTTP API
10. Architecture
11. Community
    1. Governance
    2. Getting in Touch
    3. Contributing to Loki
12. Loki Maintainers Guide
    1. Releasing Loki

Updating docs

Building the docs locally

When you contribute to documentation, it is a good practice to build the docs on your local machine to make sure your changes appear as you expect. This README explains the process for doing that.

Requirements

Docker >= 2.1.0.3

Build the doc site

1. In the command line, make sure you are in the docs folder: cd docs.
2. Run make docs. This launches a preview of the docs website at http://localhost:3002/docs/loki/latest/ which will refresh automatically when changes to content in the sources directory are made.

---

Content guidelines

Edit content in the sources directory.

Edit the side menu

The side menu is built automatically from the folder structure. Ordering is done with the weight front matter param.

Add images

Images are sourced in this repo alonside content. They will sync to the website repo just like markdown files.

---

Deploy changes to grafana.com

When a PR is merged to master with changes in the docs/sources directory, those changes are automatically synched to the grafana/website repo and published to the staging site.

Generally, someone from marketing will publish to production each day, so as long as the sync is successful your docs edits will be published.