Doc updates: (#3823)

- Revise section titles
- Add weight metadata to specify ordering of subsections
- Remove TOC info from content prose, as it is already in the right side navigation panel
- Remove a redundant section about upgrading.
pull/3828/head
Karen Miller 4 years ago committed by GitHub
parent 82cd54722a
commit 0d27c21dd4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 52
      docs/sources/api/_index.md
  2. 44
      docs/sources/clients/promtail/configuration.md
  3. 2
      docs/sources/installation/_index.md
  4. 11
      docs/sources/operations/_index.md
  5. 1
      docs/sources/operations/authentication.md
  6. 1
      docs/sources/operations/loki-canary.md
  7. 1
      docs/sources/operations/multi-tenancy.md
  8. 1
      docs/sources/operations/observability.md
  9. 1
      docs/sources/operations/scalability.md
  10. 1
      docs/sources/operations/storage/_index.md
  11. 21
      docs/sources/operations/upgrade.md

@ -3,62 +3,12 @@ title: HTTP API
weight: 900
---
# Loki's HTTP API
# Loki HTTP API
Loki exposes an HTTP API for pushing, querying, and tailing log data.
Note that [authenticating](../operations/authentication/) against the API is
out of scope for Loki.
The HTTP API includes the following endpoints:
- [Loki's HTTP API](#lokis-http-api)
- [Microservices Mode](#microservices-mode)
- [Matrix, Vector, And Streams](#matrix-vector-and-streams)
- [`GET /loki/api/v1/query`](#get-lokiapiv1query)
- [Examples](#examples)
- [`GET /loki/api/v1/query_range`](#get-lokiapiv1query_range)
- [Step vs Interval](#step-vs-interval)
- [Examples](#examples-1)
- [`GET /loki/api/v1/labels`](#get-lokiapiv1labels)
- [Examples](#examples-2)
- [`GET /loki/api/v1/label/<name>/values`](#get-lokiapiv1labelnamevalues)
- [Examples](#examples-3)
- [`GET /loki/api/v1/tail`](#get-lokiapiv1tail)
- [`POST /loki/api/v1/push`](#post-lokiapiv1push)
- [Examples](#examples-4)
- [`GET /api/prom/tail`](#get-apipromtail)
- [`GET /api/prom/query`](#get-apipromquery)
- [Examples](#examples-5)
- [`GET /api/prom/label`](#get-apipromlabel)
- [Examples](#examples-6)
- [`GET /api/prom/label/<name>/values`](#get-apipromlabelnamevalues)
- [Examples](#examples-7)
- [`POST /api/prom/push`](#post-apiprompush)
- [Examples](#examples-8)
- [`GET /ready`](#get-ready)
- [`POST /flush`](#post-flush)
- [`POST /ingester/flush_shutdown`](#post-ingesterflush_shutdown)
- [`GET /metrics`](#get-metrics)
- [`GET /config`](#get-config)
- [Series](#series)
- [Examples](#examples-9)
- [Statistics](#statistics)
- [`GET /ruler/ring`](#ruler-ring-status)
- [`GET /loki/api/v1/rules`](#list-rule-groups)
- [`GET /loki/api/v1/rules/{namespace}`](#get-rule-groups-by-namespace)
- [`GET /loki/api/v1/rules/{namespace}/{groupName}`](#get-rule-group)
- [`POST /loki/api/v1/rules/{namespace}`](#set-rule-group)
- [`DELETE /loki/api/v1/rules/{namespace}/{groupName}`](#delete-rule-group)
- [`DELETE /loki/api/v1/rules/{namespace}`](#delete-namespace)
- [`GET /api/prom/rules`](#list-rule-groups)
- [`GET /api/prom/rules/{namespace}`](#get-rule-groups-by-namespace)
- [`GET /api/prom/rules/{namespace}/{groupName}`](#get-rule-group)
- [`POST /api/prom/rules/{namespace}`](#set-rule-group)
- [`DELETE /api/prom/rules/{namespace}/{groupName}`](#delete-rule-group)
- [`DELETE /api/prom/rules/{namespace}`](#delete-namespace)
- [`GET /prometheus/api/v1/rules`](#list-rules)
- [`GET /prometheus/api/v1/alerts`](#list-alerts)
## Microservices mode
When deploying Loki in microservices mode, the set of endpoints exposed by each

@ -7,50 +7,6 @@ Promtail is configured in a YAML file (usually referred to as `config.yaml`)
which contains information on the Promtail server, where positions are stored,
and how to scrape logs from files.
- [Configuring Promtail](#configuring-promtail)
- [Printing Promtail Config At Runtime](#printing-promtail-config-at-runtime)
- [Configuration File Reference](#configuration-file-reference)
- [server](#server)
- [clients](#clients)
- [positions](#positions)
- [scrape_configs](#scrape_configs)
- [pipeline_stages](#pipeline_stages)
- [docker](#docker)
- [cri](#cri)
- [regex](#regex)
- [json](#json)
- [template](#template)
- [match](#match)
- [timestamp](#timestamp)
- [output](#output)
- [labels](#labels)
- [metrics](#metrics)
- [counter](#counter)
- [gauge](#gauge)
- [histogram](#histogram)
- [tenant](#tenant)
- [journal](#journal)
- [syslog](#syslog)
- [Available Labels](#available-labels)
- [loki_push_api](#loki_push_api)
- [windows_events](#windows_events)
- [relabel_configs](#relabel_configs)
- [static_configs](#static_configs)
- [file_sd_config](#file_sd_config)
- [kubernetes_sd_config](#kubernetes_sd_config)
- [`node`](#node)
- [`service`](#service)
- [`pod`](#pod)
- [`endpoints`](#endpoints)
- [`ingress`](#ingress)
- [target_config](#target_config)
- [Example Docker Config](#example-docker-config)
- [Example Static Config](#example-static-config)
- [Example Static Config without targets](#example-static-config-without-targets)
- [Example Journal Config](#example-journal-config)
- [Example Syslog Config](#example-syslog-config)
- [Example Push Config](#example-push-config)
## Printing Promtail Config At Runtime
If you pass Promtail the flag `-print-config-stderr` or `-log-config-reverse-order`, (or `-print-config-stderr=true`)

@ -2,7 +2,7 @@
title: Installation
weight: 200
---
# Install Loki
# Installation
## Installation methods

@ -2,14 +2,5 @@
title: Operations
weight: 800
---
# Operating Loki
1. [Upgrading](upgrade/)
1. [Authentication](authentication/)
1. [Observability](observability/)
1. [Scalability](scalability/)
1. [Storage](storage/)
1. [Table Manager](storage/table-manager/)
1. [Retention](storage/retention/)
1. [Multi-tenancy](multi-tenancy/)
1. [Loki Canary](loki-canary/)
# Operations

@ -1,5 +1,6 @@
---
title: Authentication
weight: 10
---
# Authentication with Loki

@ -1,5 +1,6 @@
---
title: Loki Canary
weight: 60
---
# Loki Canary

@ -1,5 +1,6 @@
---
title: Multi-tenancy
weight: 50
---
# Loki Multi-Tenancy

@ -1,5 +1,6 @@
---
title: Observability
weight: 20
---
# Observing Loki

@ -1,5 +1,6 @@
---
title: Scalability
weight: 30
---
# Scaling with Loki

@ -1,5 +1,6 @@
---
title: Storage
weight: 40
---
# Loki Storage

@ -1,21 +0,0 @@
---
title: Upgrade
---
**THIS PAGE HAS MOVED**
This page was moved to a top level [Upgrading Guide]({{< relref "../upgrading/_index.md" >}})
The headers on this page are being kept for existing links.
## 1.6.0
[1.6.0 Upgrade Notes]({{< relref "../upgrading/_index.md#160" >}})
## 1.5.0
[1.5.0 Upgrade Notes]({{< relref "../upgrading/_index.md#150" >}})
## 1.4.0
[1.4.0 Upgrade Notes]({{< relref "../upgrading/_index.md#140" >}})
Loading…
Cancel
Save