Update descriptions (#11586)

**What this PR does / why we need it**:

Updates the `description` field in the metadata to support the Docs
Landing Page project

---------

Co-authored-by: Michel Hollands <42814411+MichelHollands@users.noreply.github.com>
pull/11177/merge
J Stickler 2 years ago committed by GitHub
parent e1a8141341
commit efdea22db4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      docs/sources/configure/bp-configure.md
  2. 2
      docs/sources/get-started/_index.md
  3. 2
      docs/sources/get-started/architecture.md
  4. 2
      docs/sources/get-started/components.md
  5. 2
      docs/sources/get-started/deployment-modes.md
  6. 2
      docs/sources/get-started/labels/bp-labels.md
  7. 4
      docs/sources/get-started/labels/structured-metadata.md
  8. 6
      docs/sources/get-started/quick-start.md
  9. 2
      docs/sources/operations/automatic-stream-sharding.md
  10. 2
      docs/sources/operations/autoscaling_queriers.md
  11. 12
      docs/sources/operations/blocking-queries.md
  12. 2
      docs/sources/operations/caching.md
  13. 2
      docs/sources/operations/loki-canary/_index.md
  14. 2
      docs/sources/operations/multi-tenancy.md
  15. 2
      docs/sources/operations/overrides-exporter.md
  16. 2
      docs/sources/operations/query-fairness/_index.md
  17. 2
      docs/sources/operations/shuffle-sharding/_index.md
  18. 2
      docs/sources/operations/storage/filesystem.md
  19. 2
      docs/sources/operations/storage/logs-deletion.md
  20. 2
      docs/sources/operations/storage/retention.md
  21. 4
      docs/sources/operations/storage/table-manager/_index.md
  22. 2
      docs/sources/operations/storage/tsdb.md
  23. 2
      docs/sources/operations/storage/wal.md
  24. 2
      docs/sources/operations/troubleshooting.md
  25. 2
      docs/sources/operations/zone-ingesters.md
  26. 2
      docs/sources/query/_index.md
  27. 2
      docs/sources/query/ip.md
  28. 2
      docs/sources/query/logcli.md
  29. 2
      docs/sources/query/metric_queries.md
  30. 2
      docs/sources/query/query_examples.md
  31. 2
      docs/sources/query/template_functions.md
  32. 2
      docs/sources/reference/_index.md
  33. 2
      docs/sources/reference/api.md
  34. 2
      docs/sources/send-data/docker-driver/_index.md
  35. 2
      docs/sources/send-data/docker-driver/configuration.md
  36. 2
      docs/sources/send-data/fluentbit/_index.md
  37. 2
      docs/sources/send-data/fluentd/_index.md
  38. 2
      docs/sources/send-data/k6/log-generation.md
  39. 2
      docs/sources/send-data/k6/query-scenario.md
  40. 2
      docs/sources/send-data/k6/write-scenario.md
  41. 2
      docs/sources/send-data/lambda-promtail/_index.md
  42. 2
      docs/sources/send-data/otel/_index.md
  43. 2
      docs/sources/send-data/promtail/logrotation/_index.md
  44. 2
      docs/sources/send-data/promtail/troubleshooting/_index.md
  45. 2
      docs/sources/setup/install/helm/_index.md
  46. 2
      docs/sources/setup/install/helm/configure-storage/_index.md
  47. 2
      docs/sources/setup/install/helm/install-monolithic/_index.md
  48. 2
      docs/sources/setup/install/helm/install-scalable/_index.md
  49. 2
      docs/sources/setup/install/helm/monitor-and-alert/_index.md
  50. 2
      docs/sources/setup/install/helm/monitor-and-alert/with-grafana-cloud.md
  51. 2
      docs/sources/setup/install/helm/monitor-and-alert/with-local-monitoring.md
  52. 4
      docs/sources/setup/install/istio.md
  53. 2
      docs/sources/setup/install/local.md
  54. 2
      docs/sources/setup/install/tanka.md
  55. 2
      docs/sources/setup/size/_index.md
  56. 2
      docs/sources/storage/_index.md

@ -1,7 +1,7 @@
---
title: Configuration best practices
menuTitle: Best practices
description: Grafana Loki configuration best practices
description: Describes configuration best practices for Grafana Loki.
weight: 100
---
# Configuration best practices

@ -2,7 +2,7 @@
title: Get started with Grafana Loki
menuTitle: Get started
weight: 200
description: Overview of the steps for getting started using Loki to collect logs.
description: Provides an overview of the steps for implementing Grafana Loki to collect and view logs.
---
# Get started with Grafana Loki

@ -1,7 +1,7 @@
---
title: Loki architecture
menutitle: Architecture
description: Grafana Loki's architecture.
description: Describes Grafana Loki's architecture.
weight: 300
aliases:
- ../architecture/

@ -1,7 +1,7 @@
---
title: Loki components
menutitle: Components
description: An overview about the various components that Loki consists of.
description: Describes the various components that make up Grafana Loki.
weight: 500
aliases:
- ../fundamentals/architecture/components

@ -1,7 +1,7 @@
---
menuTitle: Deployment modes
title: Loki deployment modes
description: Describes the different ways to deploy Loki.
description: Describes the three different Loki deployment models.
weight: 400
aliases:
- ../fundamentals/architecture/deployment-modes

@ -1,7 +1,7 @@
---
title: Label best practices
menuTitle: Label best practices
description: Grafana Loki label best practices
description: Describes best practices for using labels in Grafana Loki.
aliases:
- ../../best-practices/ # /docs/loki/<LOKI_VERSION>/best-practices/
weight: 700

@ -1,7 +1,7 @@
---
menuTitle: Structured metadata
title: What is structured metadata
description: Attaching metadata to logs.
description: Describes how to enable structure metadata for logs and how to query using structured metadata to filter log lines.
---
# What is structured metadata
@ -15,7 +15,7 @@ Structured metadata was added to chunk format V4 which is used if the schema ver
One of the powerful features of Loki is parsing logs at query time to extract metadata and build labels out of it.
However, the parsing of logs at query time comes with a cost which can be significantly high for, as an example,
large json blobs or a poorly written query using complex regex patterns.
large JSON blobs or a poorly written query using complex regex patterns.
In addition, the data extracted from logs at query time is usually high cardinality, which can’t be stored
in the index as it would increase the cardinality too much, and therefore reduce the performance of the index.

@ -7,7 +7,7 @@ description: How to create and use a simple local Loki cluster for testing and e
# Quick start to run Loki locally
If you want to experiment with Loki, you can run Loki locally using the Docker Compose file that ships with Loki. It runs Loki in a [scalable monolithic deployment](https://grafana.com/docs/loki/latest/get-started/deployment-modes/#monolithic-mode) mode and includes a sample application to generate logs.
If you want to experiment with Loki, you can run Loki locally using the Docker Compose file that ships with Loki. It runs Loki in a [monolithic deployment](https://grafana.com/docs/loki/latest/get-started/deployment-modes/#monolithic-mode) mode and includes a sample application to generate logs.
The Docker Compose configuration instantiates the following components, each in its own container:
@ -80,7 +80,7 @@ Once you have collected logs, you will want to view them. You can view your log
The test environment includes [Grafana](https://grafana.com/docs/grafana/latest/), which you can use to query and observe the sample logs generated by the flog application. You can access the Grafana cluster by navigating to [http://localhost:3000](http://localhost:3000). The Grafana instance provided with this demo has a Loki [datasource](https://grafana.com/docs/grafana/latest/datasources/loki/) already configured.
{{< figure src="/media/docs/loki/grafana-query-builder.png" caption="Query builder in Grafana Explore" alt="Grafana Explore">}}
{{< figure src="/media/docs/loki/grafana-query-builder.png" caption="Grafana Explore" alt="Grafana Explore">}}
1. From the Grafana main menu, click the **Explore** icon (1) to launch the Explore tab. To learn more about Explore, refer the [Explore](https://grafana.com/docs/grafana/latest/explore/) documentation.
@ -96,7 +96,7 @@ Once you have collected logs, you will want to view them. You can view your log
1. Click **Code** (3) to work in Code mode in the query editor.
Here are some basic sample queries to get you started using LogQL. Note that these queries assume that you followed the instructions to create a directory called `evaluate-loki`. If you installed in a different directory, you’ll need to modify these queries to match your installation directory. After copying any of these queries into the query editor, click **Run Query** to execute the query.
Here are some basic sample queries to get you started using LogQL. Note that these queries assume that you followed the instructions to create a directory called `evaluate-loki`. If you installed in a different directory, you’ll need to modify these queries to match your installation directory. After copying any of these queries into the query editor, click **Run Query** (6) to execute the query.
1. View all the log lines which have the container label "flog":
```bash

@ -1,7 +1,7 @@
---
title: Automatic stream sharding
menuTitle: Automatic stream sharding
description: Automatic stream sharding can control issues around the per-stream rate limit
description: Describes how to control issues around the per-stream rate limit using automatic stream sharding.
weight:
---

@ -1,7 +1,7 @@
---
title: Autoscaling Loki queriers
menuTitle: Autoscaling queriers
description: Kubernetes deployments of a microservices mode Loki cluster can use KEDA to autoscale the quantity of queriers.
description: Describes how to use KEDA to autoscale the quantity of queriers for a microsevices mode Kubernetes deployment.
weight:
---

@ -1,7 +1,7 @@
---
title: Blocking Queries
menuTitle:
description: Blocking Queries
description: Describes how to configure Loki to block expensive queries using per-tenant overrides.
weight:
---
# Blocking Queries
@ -35,8 +35,9 @@ overrides:
- hash: 2943214005 # hash of {stream="stdout",pod="loki-canary-9w49x"}
types: filter,limited
```
NOTE: changes to these configurations **do not require a restart**; they are defined in the [runtime configuration file]({{< relref "../configure#runtime-configuration-file" >}}).
{{% admonition type="note" %}}
Changes to these configurations **do not require a restart**; they are defined in the [runtime configuration file]({{< relref "../configure#runtime-configuration-file" >}}).
{{% /admonition %}}
The available query types are:
@ -52,8 +53,9 @@ is logged with every query request in the `query-frontend` and `querier` logs, f
level=info ts=2023-03-30T09:08:15.2614555Z caller=metrics.go:152 component=frontend org_id=29 latency=fast
query="{stream=\"stdout\",pod=\"loki-canary-9w49x\"}" query_hash=2943214005 query_type=limited range_type=range ...
```
**Note:** the order of patterns is preserved, so the first matching pattern will be used
{{% admonition type="note" %}}
The order of patterns is preserved, so the first matching pattern will be used.
{{% /admonition %}}
## Observing blocked queries

@ -1,7 +1,7 @@
---
title: Caching
menuTitle: Caching
description: Enable and configure memcached for caching.
description: Describes how to enable and configure memcached to speed query performance.
weight:
keywords:
- memcached

@ -1,7 +1,7 @@
---
title: Loki Canary
menuTitle:
description: Loki Canary audits the log-capturing performance of a Grafana Loki cluster to ensure Loki is ingesting logs without data loss.
description: Describes how to use Loki Canary to audit the log-capturing performance of a Grafana Loki cluster to ensure Loki is ingesting logs without data loss.
weight:
---
# Loki Canary

@ -1,7 +1,7 @@
---
title: Multi-tenancy
menuTitle:
description: Multi-tenancy
description: Describes how Loki implements multi-tenancy to isolate tenant data and queries.
weight:
---
# Multi-tenancy

@ -1,7 +1,7 @@
---
title: Overrides exporter
menuTitle:
description: Overrides Exporter
description: Describes how the Overrides Exporter module exposes tenant limits as Prometheus metrics.
weight:
---

@ -1,7 +1,7 @@
---
title: Query fairness within tenants
menuTitle: Query fairness
description: The scheduler can guarantee query fairness across multiple actors within a single tenant.
description: Describes methods for guaranteeing query fairness across multiple actors within a single tenant using the scheduler.
weight:
---

@ -1,7 +1,7 @@
---
title: Shuffle sharding
menuTitle: Shuffle sharding
description: Shuffle sharding can isolate a tenant workload from other tenant workloads, providing a better sharing of resources.
description: Describes how to isolate tenant workloads from other tenant workloads using shuffle sharding to provide a better sharing of resources.
weight:
---

@ -1,7 +1,7 @@
---
title: Filesystem object store
menuTitle: Filesystem object store
description: Describes the filesystem object store
description: Describes the features and limitations of using a filesystem object store with Loki.
weight: 300
---
# Filesystem object store

@ -1,7 +1,7 @@
---
title: Log entry deletion
menuTitle: Log entry deletion
description: Log entries from a specified stream may be deleted.
description: Describes how Loki implements log deletion and deletion configuration options.
weight: 700
---
# Log entry deletion

@ -1,7 +1,7 @@
---
title: Log retention
menuTitle: Log retention
description: Describes Grafana Loki Storage Retention
description: Describes how Loki implements storage retention and retention configuration options.
weight: 600
---
# Log retention

@ -1,13 +1,13 @@
---
title: Table manager
menuTitle:
description: Describes the Loki table manager component.
description: Describes how to use the Loki table manager component with multi-store backends.
weight:
---
# Table manager
{{% admonition type="note" %}}
Table manager is only needed if you are using a multi-store [backend]({{< relref "../../storage" >}}). If you are using either TSDB,(recommended) or BoltDB you do not need the Table Manager.
Table manager is only needed if you are using a multi-store [backend]({{< relref "../../storage" >}}). If you are using either TSDB (recommended), or BoltDB (deprecated) you do not need the Table Manager.
{{% /admonition %}}
Grafana Loki supports storing indexes and chunks in table-based data storages. When

@ -1,7 +1,7 @@
---
title: Single Store TSDB (tsdb)
menuTitle: TSDB
description: Describes the tsdb single store usage.
description: Describes the Loki time series database (TSDB) single store.
weight: 100
---
# Single Store TSDB (tsdb)

@ -1,7 +1,7 @@
---
title: Write Ahead Log
menuTitle:
description: Describes the Loki Write Ahead Log (WAL).
description: Describes how Loki maintains data during a process crash using a Write Ahead Log (WAL).
weight: 500
---

@ -1,7 +1,7 @@
---
title: Troubleshooting Loki
menuTitle: Troubleshooting
description: Troubleshooting Grafana Loki
description: Describes how to troubleshoot Grafana Loki.
weight:
aliases:
- /docs/loki/latest/getting-started/troubleshooting/

@ -1,7 +1,7 @@
---
title: Zone aware ingesters
menuTitle:
description: How to migrate from a single ingester statefulset to three zone aware ingester StatefulSets
description: Describes how to migrate from a single ingester StatefulSet to three zone aware ingester StatefulSets
weight:
---

@ -1,7 +1,7 @@
---
title: "LogQL: Log query language"
menuTItle: Query
description: LogQL, Loki's query language for logs.
description: Provides a reference topic for LogQL, Loki's query language for logs.
aliases:
- ./logql
weight: 600

@ -1,7 +1,7 @@
---
title: Matching IP addresses
menuTItle:
description: LogQL supports matching IP addresses.
description: Describes how LogQL supports matching IP addresses.
aliases:
- ../logql/ip/
weight: 40

@ -1,7 +1,7 @@
---
title: LogCLI
menuTItle:
description: LogCLI, Grafana Loki's command-line interface
description: Describes LogCLI, Grafana Loki's command-line interface.
aliases:
- ../getting-started/logcli/
- ../tools/logcli/

@ -1,7 +1,7 @@
---
title: Metric queries
menuTItle:
description: Metric queries extend log queries by applying a function to log query results. This powerful feature creates metrics from logs.
description: Provides an overview of how metric queries are constructed and parsed. Metric queries extend log queries by applying a function to log query results.
aliases:
- ../logql/metric_queries/
weight: 20

@ -1,7 +1,7 @@
---
title: Query examples
menuTitle: Query examples
description: LogQL query examples with explanations on what those queries accomplish.
description: Provides LogQL query examples with explanations on what those queries accomplish.
aliases:
- ../logql/query_examples/
weight: 50

@ -1,7 +1,7 @@
---
title: Template functions
menuTItle:
description: Describes functions that are supported by the text template.
description: Describes functions that are supported by the Go text template.
aliases:
- ../logql/template_functions/
weight: 30

@ -1,7 +1,7 @@
---
title: Loki reference topics
menuTitle: Reference
description: Reference topics for Loki.
description: Overview page for Loki reference topics.
weight: 1000
---

@ -1,7 +1,7 @@
---
title: Loki HTTP API
menuTitle: HTTP API
description: Loki exposes HTTP endpoints for data ingestion, data retrieval, as well for cluster management.
description: Provides a reference page for the Loki HTTP API endpoints for data ingestion, data retrieval, and cluster management.
aliases:
- ../api/
weight: 100

@ -1,7 +1,7 @@
---
title: Docker driver client
menuTItle: Docker driver
description: Instructions to install, upgrade, and remove the Docker driver client to send logs to Loki.
description: Provides instructions for how to install, upgrade, and remove the Docker driver client, used to send logs to Loki.
aliases:
- ../clients/docker-driver/
weight: 400

@ -1,7 +1,7 @@
---
title: Docker driver client configuration
menuTitle: Configure Docker driver
description: Configuring the Docker driver client
description: Configuring the Docker driver client to send logs to Loki.
aliases:
- ../../clients/docker-driver/configuration/
weight: 410

@ -1,7 +1,7 @@
---
title: Fluent Bit client
menuTitle: Fluent Bit
description: Instructions to install, configure, and use the Fluent Bit client to send logs to Loki.
description: Provides instructions for how to install, configure, and use the Fluent Bit client to send logs to Loki.
aliases:
- ../clients/fluentbit/
weight: 500

@ -1,7 +1,7 @@
---
title: Fluentd client
menuTitle: Fluentd
description: Instructions to install, configure, and use the Fluentd client to send logs to Loki.
description: Instructions for how to install, configure, and use the Fluentd client to send logs to Loki.
aliases:
- ../clients/fluentd/
weight: 600

@ -1,7 +1,7 @@
---
title: Generating log data for testing
menuTitle: Log generation
description: Using K6 to generate log data for load testing.
description: Using k6 to generate log data for load testing.
aliases:
- ../../clients/k6/log-generation/
weight: 910

@ -1,7 +1,7 @@
---
title: Use k6 to load test log queries
menuTitle: Query testing
description: Using K6 to load test the read path (queries).
description: Using k6 to load test the read path (queries).
aliases:
- ../../clients/k6/query-scenario/
weight: 930

@ -1,7 +1,7 @@
---
title: Use k6 to load test the write path
menuTitle: Write path testing
description: Using K6 to load test the write path (ingest).
description: Using k6 to load test the write path (ingest).
aliases:
- ../../clients/k6/write-scenario/
weight: 920

@ -1,7 +1,7 @@
---
title: Lambda Promtail client
menuTitle: Lambda Promtail
description: How to configure the Lambda Promtail client workflow.
description: Configuring the Lambda Promtail client to send logs to Loki.
aliases:
- ../clients/lambda-promtail/
weight: 700

@ -1,7 +1,7 @@
---
title: Ingesting logs to Loki using OpenTelemetry Collector
menuTitle: Ingesting OpenTelemetry logs to Loki
description: Ingesting logs to Loki using OpenTelemetry Collector
description: Configuring the OpenTelemetry Collector to send logs to Loki.
aliases:
- ../clients/k6/
weight: 250

@ -1,7 +1,7 @@
---
title: Promtail and Log Rotation
menuTitle: Configure log rotation
description: Promtail and Log Rotation
description: Configuring Promtail log rotation.
aliases:
- ../../clients/promtail/logrotation/
weight: 500

@ -1,7 +1,7 @@
---
title: Troubleshooting Promtail
menuTitle: Troubleshooting
description: Troubleshooting the Promtail agent
description: Troubleshooting the Promtail agent.
aliases:
- ../../clients/promtail/troubleshooting/
weight: 800

@ -1,7 +1,7 @@
---
title: Install Grafana Loki with Helm
menuTitle: Install using Helm
description: Learn how to install Grafana Loki on Kubernetes with Helm.
description: Overview of topics for how to install Grafana Loki on Kubernetes with Helm.
aliases:
- ../../installation/helm/
weight: 200

@ -1,7 +1,7 @@
---
title: Configure storage
menuTitle: Configure storage
description: Configure Loki storage
description: Configuring Loki storage with the Helm Chart.
aliases:
- ../../../installation/helm/configure-storage/
- ../../../installation/helm/storage

@ -1,7 +1,7 @@
---
title: Install the monolithic Helm chart
menuTitle: Install monolithic Loki
description: Install Loki in monolithic, single binary mode.
description: Installing Loki in monolithic, single binary mode using the Helm chart.
aliases:
- ../../../installation/helm/monolithic
- ../../../installation/helm/install-monolithic/

@ -1,7 +1,7 @@
---
title: Install the simple scalable Helm chart
menuTitle: Install scalable Loki
description: Install Loki in scalable mode.
description: Installing Loki in simple scalable mode using the Helm chart.
aliases:
- ../../../installation/helm/scalable/
- ../../../installation/helm/install-scalable/

@ -1,6 +1,6 @@
---
title: Monitoring
description: monitoring
description: Provides links to the two common ways to monitor Loki.
weight: 500
aliases:
- ../../../installation/helm/monitor-and-alert/

@ -1,7 +1,7 @@
---
title: Configure monitoring and alerting of Loki using Grafana Cloud
menuTitle: Monitor Loki with Grafana Cloud
description: setup monitoring and alerts for Loki using Grafana Cloud
description: Configuring monitoring and alerts for Loki using Grafana Cloud.
aliases:
- ../../../../installation/helm/monitor-and-alert/with-grafana-cloud
weight: 200

@ -1,7 +1,7 @@
---
title: Configure monitoring and alerting
menuTitle: Configure monitoring and alerting
description: setup monitoring and alerts for the Helm chart
description: Configuring monitoring and alerts using the Helm chart.
aliases:
- ../../../../installation/helm/monitor-and-alert/with-local-monitoring/
weight: 100

@ -1,7 +1,7 @@
---
title: Install on Istio
menuTitle:
description: Installation instructions for Istio service mesh
description: Describes additional steps for installing Loki with Istio service mesh.
aliases:
- ../../installation/istio/
weight: 600
@ -17,7 +17,7 @@ loki level=debug ts=2021-11-24T11:33:37.352544925Z caller=broadcast.go:48 msg="I
This means that the pod is failing to join the ring.
If you try to add `loki` to `Grafana` data sources, you will see logs like (`empty ring`)
If you try to add `loki` to `Grafana` data sources, you will see logs like (`empty ring`):
```
loki level=warn ts=2021-11-24T08:02:42.08262122Z caller=logging.go:72 traceID=3fc821042d8ada1a orgID=fake msg="GET /loki/api/v1/labels?end=1637740962079859431&start=1637740361925000000 (500) 97.4µs Response: \"empty ring\\n\" ws: false; X-Scope-Orgid: fake; uber-trace-id: 3fc821042d8ada1a:1feed8872deea75c:1180f95a8235bb6c:0; "

@ -1,7 +1,7 @@
---
title: Local
menuTitle: Install locally
description: Install and run Grafana Loki locally
description: Describes how to install and run Grafana Loki locally.
aliases:
- ../../installation/local/
weight: 500

@ -1,7 +1,7 @@
---
title: Tanka
menuTitle: Install using Tanka
description: Install Loki using Tanka
description: Describes how to install Loki using Tanka.
aliases:
- ../../installation/tanka/
weight: 300

@ -1,7 +1,7 @@
---
title: Size the cluster
menuTitle: Size the cluster
description: Tool that generates a Helm Chart values.yaml file based on expected ingestion, retention rate, and node type, to help size your Grafana deployment.
description: Provides a tool that generates a Helm Chart values.yaml file based on expected ingestion, retention rate, and node type, to help size your Grafana deployment.
aliases:
- ../installation/sizing/
- ../installation/helm/generate

@ -1,6 +1,6 @@
---
title: Storage
description: Storage
description: Describes Loki storage.
weight: 475
---
# Storage

Loading…
Cancel
Save