Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: updates #3823

Merged
merged 1 commit into from
Jun 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 1 addition & 51 deletions docs/sources/api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
44 changes: 0 additions & 44 deletions docs/sources/clients/promtail/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/installation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Installation
weight: 200
---
# Install Loki
# Installation

## Installation methods

Expand Down
11 changes: 1 addition & 10 deletions docs/sources/operations/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 change: 1 addition & 0 deletions docs/sources/operations/authentication.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Authentication
weight: 10
---
# Authentication with Loki

Expand Down
1 change: 1 addition & 0 deletions docs/sources/operations/loki-canary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Loki Canary
weight: 60
---
# Loki Canary

Expand Down
1 change: 1 addition & 0 deletions docs/sources/operations/multi-tenancy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Multi-tenancy
weight: 50
---
# Loki Multi-Tenancy

Expand Down
1 change: 1 addition & 0 deletions docs/sources/operations/observability.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Observability
weight: 20
---
# Observing Loki

Expand Down
1 change: 1 addition & 0 deletions docs/sources/operations/scalability.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Scalability
weight: 30
---
# Scaling with Loki

Expand Down
1 change: 1 addition & 0 deletions docs/sources/operations/storage/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Storage
weight: 40
---
# Loki Storage

Expand Down
21 changes: 0 additions & 21 deletions docs/sources/operations/upgrade.md

This file was deleted.