Skip to content

Commit

Permalink
Documentation Rewrite (#982)
Browse files Browse the repository at this point in the history
* docs: create structure of docs overhaul

This commit removes all old docs and lays out the table of contents and
framework for how the new documentation will be intended to be read.

* docs: add design docs back in

* docs: add community documentation

* docs: add LogQL docs

* docs: port existing operations documentation

* docs: add new placeholder file for promtail configuration docs

* docs: add TOC for operations/storage

* docs: add Loki API documentation

* docs: port troubleshooting document

* docs: add docker-driver documentation

* docs: link to configuration from main docker-driver document

* docs: update API for new paths

* docs: fix broken links in api.md and remove json marker from examples

* docs: incorporate api changes from #1009

* docs: port promtail documentation

* docs: add TOC to promtail configuration reference

* docs: fix promtail spelling errors

* docs: add loki configuration reference

* docs: add TOC to configuration

* docs: add loki configuration example

* docs: add Loki overview with brief explanation about each component

* docs: add comparisons document

* docs: add info on table manager and update storage/README.md

* docs: add getting started

* docs: incorporate config yaml changes from #755

* docs: fix typo in releases url for promtail

* docs: add installation instructions

* docs: add more configuration examples

* docs: add information on fluentd client

fluent-bit has been temporarily removed until the PR for it is merged.

* docs: PR review feedback

* docs: add architecture document

* docs: add missing information from old docs

* `localy` typo

Co-Authored-By: Ed Welch <ed@oqqer.com>

* docs: s/ran/run/g

* Typo

* Typo

* Tyop

* Typo

* docs: fixed typo

* docs: PR feedback

* docs: @cyriltovena PR feedback

* docs: add more details to promtail url config option

* docs: expand promtail's pipelines document with extra detail

* docs: remove reference to Stage interface in pipelines.md

* docs: fixed some spelling

* docs: clarify promtail configuration and scraping

* docs: attempt #2 at explaining promtail's usage of machine hostname

* docs: spelling fixes

* docs: add reference to promtail custom metrics and fix silly typo

* docs: cognizant -> aware

* docs: typo

* docs: typos

* docs: add which components expose which API endpoints in microservices mode

* docs: change ksonnet installation to tanka

* docs: address most @pracucci feedback

* docs: fix all spelling errors so reviewers don't have to keep finding them :)

* docs: incorporate changes to API endpoints made in #1022

* docs: add missing loki metrics

* docs: add missing promtail metrics

* docs: @pstribrany feedback

* docs: more @pracucci feedback

* docs: move metrics into a table

* docs: update push path references to /loki/api/v1/push

* docs: add detail to further explain limitations of monolithic mode

* docs: add alternative names to modes_of_operation diagram

* docs: add log ordering requirement

* docs: add procedure for updating docs with latest version

* docs: separate out stages documentation into one document per stage

* docs: list supported stores in storage documentation

* docs: add info on duplicate log lines in pipelines

* docs: add line_format as key feature to fluentd

* docs: hopefully final commit :)
  • Loading branch information
rfratto authored and cyriltovena committed Sep 25, 2019
1 parent f755c59 commit 65ba42a
Show file tree
Hide file tree
Showing 73 changed files with 5,989 additions and 2,859 deletions.
84 changes: 49 additions & 35 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,56 @@
# Loki Documentation

<p align="center"> <img src="logo_and_name.png" alt="Loki Logo"> <br>
<small>Like Prometheus, but for logs!</small> </p>

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

It builds around the idea of treating a single log line as-is. This means that
instead of full-text indexing them, related logs are grouped using the same
labels as in Prometheus. This is much more efficient and scales better.

## Components
- **[Loki](loki/README.md)**: The main server component is called Loki. It is
responsible for permanently storing the logs it is being shipped and it
executes the LogQL
queries from clients.
Loki shares its high-level architecture with Cortex, a highly scalable
Prometheus backend.
- **[Promtail](promtail/README.md)**: To ship logs to a central place, an
agent is required. Promtail
is deployed to every node that should be monitored and sends the logs to Loki.
It also does important task of pre-processing the log lines, including
attaching labels to them for easier querying.
- *Grafana*: The *Explore* feature of Grafana 6.0+ is the primary place of
contact between a human and Loki. It is used for discovering and analyzing
logs.
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.

Alongside these main components, there are some other ones as well:
## Table of Contents

- **[LogCLI](logcli.md)**: A command line interface to query logs and labels
from Loki
- **[Canary](canary/README.md)**: An audit utility to analyze the log-capturing
performance of Loki. Ingests data into Loki and immediately reads it back to
check for latency and loss.
- **[Docker
Driver](https://github.com/grafana/loki/tree/master/cmd/docker-driver)**: A
Docker [log
driver](https://docs.docker.com/config/containers/logging/configure/) to ship
logs captured by Docker directly to Loki, without the need of an agent.
- **[Fluentd
Plugin](https://github.com/grafana/loki/tree/master/fluentd/fluent-plugin-grafana-loki)**:
An Fluentd [output plugin](https://docs.fluentd.org/output), to use Fluentd
for shipping logs into Loki
1. [Overview](overview/README.md)
1. [Comparison to other Log Systems](overview/comparisons.md)
2. [Installation](installation/README.md)
1. [Installing with Tanka](installation/tanka.md)
2. [Installing with Helm](installation/helm.md)
3. [Installing Locally](installation/local.md)
3. [Getting Started](getting-started/README.md)
1. [Grafana](getting-started/grafana.md)
2. [LogCLI](getting-started/logcli.md)
4. [Troubleshooting](getting-started/troubleshooting.md)
4. [Configuration](configuration/README.md)
1. [Examples](configuration/examples.md)
5. [Clients](clients/README.md)
1. [Promtail](clients/promtail/README.md)
1. [Installation](clients/promtail/installation.md)
2. [Configuration](clients/promtail/configuration.md)
3. [Scraping](clients/promtail/scraping.md)
4. [Pipelines](clients/promtail/pipelines.md)
5. [Troubleshooting](clients/promtail/troubleshooting.md)
2. [Docker Driver](clients/docker-driver/README.md)
1. [Configuration](clients/docker-driver/configuration.md)
3. [Fluentd](clients/fluentd.md)
6. [LogQL](logql.md)
7. [Operations](operations/README.md)
1. [Authentication](operations/authentication.md)
2. [Observability](operations/observability.md)
3. [Scalability](operations/scalability.md)
4. [Storage](operations/storage/README.md)
1. [Table Manager](operations/storage/table-manager.md)
2. [Retention](operations/storage/retention.md)
5. [Multi-tenancy](operations/multi-tenancy.md)
6. [Loki Canary](operations/loki-canary.md)
8. [HTTP API](api.md)
9. [Architecture](architecture.md)
10. [Community](community/README.md)
1. [Governance](community/governance.md)
2. [Getting in Touch](community/getting-in-touch.md)
3. [Contributing to Loki](community/contributing.md)
11. [Loki Maintainers Guide](./maintaining/README.md)
1. [Releasing Loki](./maintaining/release.md)
Loading

0 comments on commit 65ba42a

Please sign in to comment.