diff --git a/docs/sources/api/_index.md b/docs/sources/api/_index.md index 762fd17949..b6c27b3572 100644 --- a/docs/sources/api/_index.md +++ b/docs/sources/api/_index.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//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//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 diff --git a/docs/sources/clients/promtail/configuration.md b/docs/sources/clients/promtail/configuration.md index c1c7cd7fc4..cf15ef3592 100644 --- a/docs/sources/clients/promtail/configuration.md +++ b/docs/sources/clients/promtail/configuration.md @@ -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`) diff --git a/docs/sources/installation/_index.md b/docs/sources/installation/_index.md index 68f5e3042a..e0558b5290 100644 --- a/docs/sources/installation/_index.md +++ b/docs/sources/installation/_index.md @@ -2,7 +2,7 @@ title: Installation weight: 200 --- -# Install Loki +# Installation ## Installation methods diff --git a/docs/sources/operations/_index.md b/docs/sources/operations/_index.md index 6c888812aa..87e397cde9 100644 --- a/docs/sources/operations/_index.md +++ b/docs/sources/operations/_index.md @@ -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 diff --git a/docs/sources/operations/authentication.md b/docs/sources/operations/authentication.md index a15a2a37ac..5d5f6228df 100644 --- a/docs/sources/operations/authentication.md +++ b/docs/sources/operations/authentication.md @@ -1,5 +1,6 @@ --- title: Authentication +weight: 10 --- # Authentication with Loki diff --git a/docs/sources/operations/loki-canary.md b/docs/sources/operations/loki-canary.md index bca1c4b19f..269fcebf73 100644 --- a/docs/sources/operations/loki-canary.md +++ b/docs/sources/operations/loki-canary.md @@ -1,5 +1,6 @@ --- title: Loki Canary +weight: 60 --- # Loki Canary diff --git a/docs/sources/operations/multi-tenancy.md b/docs/sources/operations/multi-tenancy.md index e7a76486d2..87d4947380 100644 --- a/docs/sources/operations/multi-tenancy.md +++ b/docs/sources/operations/multi-tenancy.md @@ -1,5 +1,6 @@ --- title: Multi-tenancy +weight: 50 --- # Loki Multi-Tenancy diff --git a/docs/sources/operations/observability.md b/docs/sources/operations/observability.md index b2fc800e32..4d4b63379e 100644 --- a/docs/sources/operations/observability.md +++ b/docs/sources/operations/observability.md @@ -1,5 +1,6 @@ --- title: Observability +weight: 20 --- # Observing Loki diff --git a/docs/sources/operations/scalability.md b/docs/sources/operations/scalability.md index 8aef176973..5f454dd39a 100644 --- a/docs/sources/operations/scalability.md +++ b/docs/sources/operations/scalability.md @@ -1,5 +1,6 @@ --- title: Scalability +weight: 30 --- # Scaling with Loki diff --git a/docs/sources/operations/storage/_index.md b/docs/sources/operations/storage/_index.md index ebdaf3163c..254fcdafe2 100644 --- a/docs/sources/operations/storage/_index.md +++ b/docs/sources/operations/storage/_index.md @@ -1,5 +1,6 @@ --- title: Storage +weight: 40 --- # Loki Storage diff --git a/docs/sources/operations/upgrade.md b/docs/sources/operations/upgrade.md deleted file mode 100644 index 5eb05c19c1..0000000000 --- a/docs/sources/operations/upgrade.md +++ /dev/null @@ -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" >}}) \ No newline at end of file