From a273dc3d1e961918976d4a0979b78a997e205057 Mon Sep 17 00:00:00 2001 From: Julie Stickler Date: Thu, 21 Dec 2023 11:47:03 -0500 Subject: [PATCH] Update descriptions --- docs/sources/configure/bp-configure.md | 2 +- docs/sources/get-started/_index.md | 2 +- docs/sources/get-started/architecture.md | 2 +- docs/sources/get-started/components.md | 2 +- docs/sources/get-started/deployment-modes.md | 2 +- docs/sources/get-started/labels/bp-labels.md | 2 +- .../get-started/labels/structured-metadata.md | 4 ++-- docs/sources/get-started/quick-start.md | 6 +++--- docs/sources/operations/automatic-stream-sharding.md | 2 +- docs/sources/operations/autoscaling_queriers.md | 2 +- docs/sources/operations/blocking-queries.md | 12 +++++++----- docs/sources/operations/caching.md | 2 +- docs/sources/operations/loki-canary/_index.md | 2 +- docs/sources/operations/multi-tenancy.md | 2 +- docs/sources/operations/overrides-exporter.md | 2 +- docs/sources/operations/query-fairness/_index.md | 2 +- docs/sources/operations/shuffle-sharding/_index.md | 2 +- docs/sources/operations/storage/filesystem.md | 2 +- docs/sources/operations/storage/logs-deletion.md | 2 +- docs/sources/operations/storage/retention.md | 2 +- .../operations/storage/table-manager/_index.md | 4 ++-- docs/sources/operations/storage/tsdb.md | 2 +- docs/sources/operations/storage/wal.md | 2 +- docs/sources/operations/troubleshooting.md | 2 +- docs/sources/operations/zone-ingesters.md | 2 +- docs/sources/query/_index.md | 2 +- docs/sources/query/ip.md | 2 +- docs/sources/query/logcli.md | 2 +- docs/sources/query/metric_queries.md | 2 +- docs/sources/query/query_examples.md | 2 +- docs/sources/query/template_functions.md | 2 +- docs/sources/reference/_index.md | 2 +- docs/sources/reference/api.md | 2 +- docs/sources/send-data/docker-driver/_index.md | 2 +- .../sources/send-data/docker-driver/configuration.md | 2 +- docs/sources/send-data/fluentbit/_index.md | 2 +- docs/sources/send-data/fluentd/_index.md | 2 +- docs/sources/send-data/k6/log-generation.md | 2 +- docs/sources/send-data/k6/query-scenario.md | 2 +- docs/sources/send-data/k6/write-scenario.md | 2 +- docs/sources/send-data/lambda-promtail/_index.md | 2 +- docs/sources/send-data/otel/_index.md | 2 +- .../sources/send-data/promtail/logrotation/_index.md | 2 +- .../send-data/promtail/troubleshooting/_index.md | 2 +- docs/sources/setup/install/helm/_index.md | 2 +- .../setup/install/helm/configure-storage/_index.md | 2 +- .../setup/install/helm/install-monolithic/_index.md | 2 +- .../setup/install/helm/install-scalable/_index.md | 2 +- .../setup/install/helm/monitor-and-alert/_index.md | 2 +- .../helm/monitor-and-alert/with-grafana-cloud.md | 2 +- .../helm/monitor-and-alert/with-local-monitoring.md | 2 +- docs/sources/setup/install/istio.md | 4 ++-- docs/sources/setup/install/local.md | 2 +- docs/sources/setup/install/tanka.md | 2 +- docs/sources/setup/size/_index.md | 2 +- docs/sources/storage/_index.md | 2 +- 56 files changed, 67 insertions(+), 65 deletions(-) diff --git a/docs/sources/configure/bp-configure.md b/docs/sources/configure/bp-configure.md index ab633c24ff822..23175d7c1b1a5 100644 --- a/docs/sources/configure/bp-configure.md +++ b/docs/sources/configure/bp-configure.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 diff --git a/docs/sources/get-started/_index.md b/docs/sources/get-started/_index.md index b433b62f8f73c..274a3ea81068a 100644 --- a/docs/sources/get-started/_index.md +++ b/docs/sources/get-started/_index.md @@ -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: Overview of the steps for implementing Grafana Loki to collect and view logs. --- # Get started with Grafana Loki diff --git a/docs/sources/get-started/architecture.md b/docs/sources/get-started/architecture.md index d5a02cd1198d0..93ef93b3a52f4 100644 --- a/docs/sources/get-started/architecture.md +++ b/docs/sources/get-started/architecture.md @@ -1,7 +1,7 @@ --- title: Loki architecture menutitle: Architecture -description: Grafana Loki's architecture. +description: Describes Grafana Loki's architecture. weight: 300 aliases: - ../architecture/ diff --git a/docs/sources/get-started/components.md b/docs/sources/get-started/components.md index 9378bcf90c2ff..12c2ea2810653 100644 --- a/docs/sources/get-started/components.md +++ b/docs/sources/get-started/components.md @@ -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 diff --git a/docs/sources/get-started/deployment-modes.md b/docs/sources/get-started/deployment-modes.md index 67e9c46294a74..d0b590086cfee 100644 --- a/docs/sources/get-started/deployment-modes.md +++ b/docs/sources/get-started/deployment-modes.md @@ -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 diff --git a/docs/sources/get-started/labels/bp-labels.md b/docs/sources/get-started/labels/bp-labels.md index b6b365e3c7c90..c2bc2e925c23b 100644 --- a/docs/sources/get-started/labels/bp-labels.md +++ b/docs/sources/get-started/labels/bp-labels.md @@ -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//best-practices/ weight: 700 diff --git a/docs/sources/get-started/labels/structured-metadata.md b/docs/sources/get-started/labels/structured-metadata.md index 9e3ff7e9e4e1f..db335e7712316 100644 --- a/docs/sources/get-started/labels/structured-metadata.md +++ b/docs/sources/get-started/labels/structured-metadata.md @@ -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. diff --git a/docs/sources/get-started/quick-start.md b/docs/sources/get-started/quick-start.md index 3fd404d18dbf2..cdca6858f271c 100644 --- a/docs/sources/get-started/quick-start.md +++ b/docs/sources/get-started/quick-start.md @@ -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 diff --git a/docs/sources/operations/automatic-stream-sharding.md b/docs/sources/operations/automatic-stream-sharding.md index a973135fc75c4..1d2d36393c369 100644 --- a/docs/sources/operations/automatic-stream-sharding.md +++ b/docs/sources/operations/automatic-stream-sharding.md @@ -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: --- diff --git a/docs/sources/operations/autoscaling_queriers.md b/docs/sources/operations/autoscaling_queriers.md index 52bcc60e00a0f..4d4a4facfaa37 100644 --- a/docs/sources/operations/autoscaling_queriers.md +++ b/docs/sources/operations/autoscaling_queriers.md @@ -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 midrosevices mode Kubernetes deployment. weight: --- diff --git a/docs/sources/operations/blocking-queries.md b/docs/sources/operations/blocking-queries.md index 6d499ef0f75b6..3c3468215d96e 100644 --- a/docs/sources/operations/blocking-queries.md +++ b/docs/sources/operations/blocking-queries.md @@ -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 diff --git a/docs/sources/operations/caching.md b/docs/sources/operations/caching.md index 0a20cc3d6e1ff..53a132db58352 100644 --- a/docs/sources/operations/caching.md +++ b/docs/sources/operations/caching.md @@ -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 diff --git a/docs/sources/operations/loki-canary/_index.md b/docs/sources/operations/loki-canary/_index.md index a5f04c09a1e0b..d1b68726ee336 100644 --- a/docs/sources/operations/loki-canary/_index.md +++ b/docs/sources/operations/loki-canary/_index.md @@ -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 diff --git a/docs/sources/operations/multi-tenancy.md b/docs/sources/operations/multi-tenancy.md index dc7d830924b9d..bcd61ded9237c 100644 --- a/docs/sources/operations/multi-tenancy.md +++ b/docs/sources/operations/multi-tenancy.md @@ -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 diff --git a/docs/sources/operations/overrides-exporter.md b/docs/sources/operations/overrides-exporter.md index e66c408e17b34..d170576999d28 100644 --- a/docs/sources/operations/overrides-exporter.md +++ b/docs/sources/operations/overrides-exporter.md @@ -1,7 +1,7 @@ --- title: Overrides exporter menuTitle: -description: Overrides Exporter +description: Describes how the Overrides Exporter module exposes tenant limits as Promtheus metrics. weight: --- diff --git a/docs/sources/operations/query-fairness/_index.md b/docs/sources/operations/query-fairness/_index.md index 205080c19b7cb..39f9ede21fbab 100644 --- a/docs/sources/operations/query-fairness/_index.md +++ b/docs/sources/operations/query-fairness/_index.md @@ -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: --- diff --git a/docs/sources/operations/shuffle-sharding/_index.md b/docs/sources/operations/shuffle-sharding/_index.md index 3002b774ee542..166fd1992d583 100644 --- a/docs/sources/operations/shuffle-sharding/_index.md +++ b/docs/sources/operations/shuffle-sharding/_index.md @@ -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: --- diff --git a/docs/sources/operations/storage/filesystem.md b/docs/sources/operations/storage/filesystem.md index e282e2e6e4c3f..d97a80e7823d6 100644 --- a/docs/sources/operations/storage/filesystem.md +++ b/docs/sources/operations/storage/filesystem.md @@ -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 diff --git a/docs/sources/operations/storage/logs-deletion.md b/docs/sources/operations/storage/logs-deletion.md index f5885ed66177e..cb0337c7bc904 100644 --- a/docs/sources/operations/storage/logs-deletion.md +++ b/docs/sources/operations/storage/logs-deletion.md @@ -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 diff --git a/docs/sources/operations/storage/retention.md b/docs/sources/operations/storage/retention.md index 7ccda10e0984a..96880a43374e6 100644 --- a/docs/sources/operations/storage/retention.md +++ b/docs/sources/operations/storage/retention.md @@ -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 diff --git a/docs/sources/operations/storage/table-manager/_index.md b/docs/sources/operations/storage/table-manager/_index.md index c1c480ab5776e..81b835a11382a 100644 --- a/docs/sources/operations/storage/table-manager/_index.md +++ b/docs/sources/operations/storage/table-manager/_index.md @@ -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 diff --git a/docs/sources/operations/storage/tsdb.md b/docs/sources/operations/storage/tsdb.md index 7b0b51a3ba790..82e3a6dbf33db 100644 --- a/docs/sources/operations/storage/tsdb.md +++ b/docs/sources/operations/storage/tsdb.md @@ -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) diff --git a/docs/sources/operations/storage/wal.md b/docs/sources/operations/storage/wal.md index d07a16daecf6f..45f8c396cccac 100644 --- a/docs/sources/operations/storage/wal.md +++ b/docs/sources/operations/storage/wal.md @@ -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 --- diff --git a/docs/sources/operations/troubleshooting.md b/docs/sources/operations/troubleshooting.md index 9fd4e4b8dcf38..914a432f30686 100644 --- a/docs/sources/operations/troubleshooting.md +++ b/docs/sources/operations/troubleshooting.md @@ -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/ diff --git a/docs/sources/operations/zone-ingesters.md b/docs/sources/operations/zone-ingesters.md index b1fb5030efc29..63c6c843fde8f 100644 --- a/docs/sources/operations/zone-ingesters.md +++ b/docs/sources/operations/zone-ingesters.md @@ -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: --- diff --git a/docs/sources/query/_index.md b/docs/sources/query/_index.md index 2811c63cc14e5..24640faa85dce 100644 --- a/docs/sources/query/_index.md +++ b/docs/sources/query/_index.md @@ -1,7 +1,7 @@ --- title: "LogQL: Log query language" menuTItle: Query -description: LogQL, Loki's query language for logs. +description: Reference topic for LogQL, Loki's query language for logs. aliases: - ./logql weight: 600 diff --git a/docs/sources/query/ip.md b/docs/sources/query/ip.md index 1454a3863977e..6456030ce5d4a 100644 --- a/docs/sources/query/ip.md +++ b/docs/sources/query/ip.md @@ -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 diff --git a/docs/sources/query/logcli.md b/docs/sources/query/logcli.md index 25f5f26062a7e..0d870c44150d0 100644 --- a/docs/sources/query/logcli.md +++ b/docs/sources/query/logcli.md @@ -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/ diff --git a/docs/sources/query/metric_queries.md b/docs/sources/query/metric_queries.md index ca4fe38b09cae..220ef42613994 100644 --- a/docs/sources/query/metric_queries.md +++ b/docs/sources/query/metric_queries.md @@ -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: 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 diff --git a/docs/sources/query/query_examples.md b/docs/sources/query/query_examples.md index 1e939ea6aa192..7eb4145acf745 100644 --- a/docs/sources/query/query_examples.md +++ b/docs/sources/query/query_examples.md @@ -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 diff --git a/docs/sources/query/template_functions.md b/docs/sources/query/template_functions.md index 784a396d19539..0d2097a0fc231 100644 --- a/docs/sources/query/template_functions.md +++ b/docs/sources/query/template_functions.md @@ -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 diff --git a/docs/sources/reference/_index.md b/docs/sources/reference/_index.md index 3050a4d3f4ec2..89e8e38f7172a 100644 --- a/docs/sources/reference/_index.md +++ b/docs/sources/reference/_index.md @@ -1,7 +1,7 @@ --- title: Loki reference topics menuTitle: Reference -description: Reference topics for Loki. +description: Overview page for Loki reference topics. weight: 1000 --- diff --git a/docs/sources/reference/api.md b/docs/sources/reference/api.md index 666cc43f91c2b..312caa026e9d3 100644 --- a/docs/sources/reference/api.md +++ b/docs/sources/reference/api.md @@ -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: Reference page for the Loki HTTP API endpoints for data ingestion, data retrieval, and cluster management. aliases: - ../api/ weight: 100 diff --git a/docs/sources/send-data/docker-driver/_index.md b/docs/sources/send-data/docker-driver/_index.md index 04b35d6a80f75..b620be17dec0f 100644 --- a/docs/sources/send-data/docker-driver/_index.md +++ b/docs/sources/send-data/docker-driver/_index.md @@ -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: Instructions for how to install, upgrade, and remove the Docker driver client, used to send logs to Loki. aliases: - ../clients/docker-driver/ weight: 400 diff --git a/docs/sources/send-data/docker-driver/configuration.md b/docs/sources/send-data/docker-driver/configuration.md index 38d3962f8a0a2..64195544b014d 100644 --- a/docs/sources/send-data/docker-driver/configuration.md +++ b/docs/sources/send-data/docker-driver/configuration.md @@ -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 diff --git a/docs/sources/send-data/fluentbit/_index.md b/docs/sources/send-data/fluentbit/_index.md index d85729bda3e9e..d55d1216e052f 100644 --- a/docs/sources/send-data/fluentbit/_index.md +++ b/docs/sources/send-data/fluentbit/_index.md @@ -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: Instructions for how to install, configure, and use the Fluent Bit client to send logs to Loki. aliases: - ../clients/fluentbit/ weight: 500 diff --git a/docs/sources/send-data/fluentd/_index.md b/docs/sources/send-data/fluentd/_index.md index e28ec048de068..a2dffcac2dc39 100644 --- a/docs/sources/send-data/fluentd/_index.md +++ b/docs/sources/send-data/fluentd/_index.md @@ -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 diff --git a/docs/sources/send-data/k6/log-generation.md b/docs/sources/send-data/k6/log-generation.md index 53cd0b50bf0d8..635f042f90b87 100644 --- a/docs/sources/send-data/k6/log-generation.md +++ b/docs/sources/send-data/k6/log-generation.md @@ -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 diff --git a/docs/sources/send-data/k6/query-scenario.md b/docs/sources/send-data/k6/query-scenario.md index 6a27c7a0dcdbb..40a914079ae45 100644 --- a/docs/sources/send-data/k6/query-scenario.md +++ b/docs/sources/send-data/k6/query-scenario.md @@ -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 diff --git a/docs/sources/send-data/k6/write-scenario.md b/docs/sources/send-data/k6/write-scenario.md index 66b05b75739dd..49425594e2c50 100644 --- a/docs/sources/send-data/k6/write-scenario.md +++ b/docs/sources/send-data/k6/write-scenario.md @@ -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 diff --git a/docs/sources/send-data/lambda-promtail/_index.md b/docs/sources/send-data/lambda-promtail/_index.md index 7306d76f02a46..9296f97859436 100644 --- a/docs/sources/send-data/lambda-promtail/_index.md +++ b/docs/sources/send-data/lambda-promtail/_index.md @@ -1,7 +1,7 @@ --- title: Lambda Promtail client menuTitle: Lambda Promtail -description: How to configure the Lambda Promtail client workflow. +description: How to configure the Lambda Promtail client to send logs to Loki. aliases: - ../clients/lambda-promtail/ weight: 700 diff --git a/docs/sources/send-data/otel/_index.md b/docs/sources/send-data/otel/_index.md index 8b6729850fb2a..e16c738a9e0ae 100644 --- a/docs/sources/send-data/otel/_index.md +++ b/docs/sources/send-data/otel/_index.md @@ -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: How to configure the OpenTelemetry Collector to send logs to Loki. aliases: - ../clients/k6/ weight: 250 diff --git a/docs/sources/send-data/promtail/logrotation/_index.md b/docs/sources/send-data/promtail/logrotation/_index.md index f90941780a47d..ed317f4c8d1ac 100644 --- a/docs/sources/send-data/promtail/logrotation/_index.md +++ b/docs/sources/send-data/promtail/logrotation/_index.md @@ -1,7 +1,7 @@ --- title: Promtail and Log Rotation menuTitle: Configure log rotation -description: Promtail and Log Rotation +description: Overview and how to configure Promtail log rotation. aliases: - ../../clients/promtail/logrotation/ weight: 500 diff --git a/docs/sources/send-data/promtail/troubleshooting/_index.md b/docs/sources/send-data/promtail/troubleshooting/_index.md index 16812228ef7e3..250819f8b5e98 100644 --- a/docs/sources/send-data/promtail/troubleshooting/_index.md +++ b/docs/sources/send-data/promtail/troubleshooting/_index.md @@ -1,7 +1,7 @@ --- title: Troubleshooting Promtail menuTitle: Troubleshooting -description: Troubleshooting the Promtail agent +description: Provides information about how to troubleshoot the Promtail agent. aliases: - ../../clients/promtail/troubleshooting/ weight: 800 diff --git a/docs/sources/setup/install/helm/_index.md b/docs/sources/setup/install/helm/_index.md index d920dace8f2bc..449fcc5031d45 100644 --- a/docs/sources/setup/install/helm/_index.md +++ b/docs/sources/setup/install/helm/_index.md @@ -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 diff --git a/docs/sources/setup/install/helm/configure-storage/_index.md b/docs/sources/setup/install/helm/configure-storage/_index.md index 2feafaafeeb8c..ded9c300b3ffc 100644 --- a/docs/sources/setup/install/helm/configure-storage/_index.md +++ b/docs/sources/setup/install/helm/configure-storage/_index.md @@ -1,7 +1,7 @@ --- title: Configure storage menuTitle: Configure storage -description: Configure Loki storage +description: Describes how to use the Helm Chart to configure Loki storage. aliases: - ../../../installation/helm/configure-storage/ - ../../../installation/helm/storage diff --git a/docs/sources/setup/install/helm/install-monolithic/_index.md b/docs/sources/setup/install/helm/install-monolithic/_index.md index 128e91102ef53..7d1bf3a8b3f20 100644 --- a/docs/sources/setup/install/helm/install-monolithic/_index.md +++ b/docs/sources/setup/install/helm/install-monolithic/_index.md @@ -1,7 +1,7 @@ --- title: Install the monolithic Helm chart menuTitle: Install monolithic Loki -description: Install Loki in monolithic, single binary mode. +description: Describes how to install Loki in monolithic, single binary mode using the Helm chart. aliases: - ../../../installation/helm/monolithic - ../../../installation/helm/install-monolithic/ diff --git a/docs/sources/setup/install/helm/install-scalable/_index.md b/docs/sources/setup/install/helm/install-scalable/_index.md index b0dbec64bf618..78b25324caced 100644 --- a/docs/sources/setup/install/helm/install-scalable/_index.md +++ b/docs/sources/setup/install/helm/install-scalable/_index.md @@ -1,7 +1,7 @@ --- title: Install the simple scalable Helm chart menuTitle: Install scalable Loki -description: Install Loki in scalable mode. +description: Describes how to install Loki in simple scalable mode using the Helm chart. aliases: - ../../../installation/helm/scalable/ - ../../../installation/helm/install-scalable/ diff --git a/docs/sources/setup/install/helm/monitor-and-alert/_index.md b/docs/sources/setup/install/helm/monitor-and-alert/_index.md index db9b2d24e5e49..1a2f34f3c5d9f 100644 --- a/docs/sources/setup/install/helm/monitor-and-alert/_index.md +++ b/docs/sources/setup/install/helm/monitor-and-alert/_index.md @@ -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/ diff --git a/docs/sources/setup/install/helm/monitor-and-alert/with-grafana-cloud.md b/docs/sources/setup/install/helm/monitor-and-alert/with-grafana-cloud.md index 418bfac0f6951..b48ae3b0d2587 100644 --- a/docs/sources/setup/install/helm/monitor-and-alert/with-grafana-cloud.md +++ b/docs/sources/setup/install/helm/monitor-and-alert/with-grafana-cloud.md @@ -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: How to setup monitoring and alerts for Loki using Grafana Cloud. aliases: - ../../../../installation/helm/monitor-and-alert/with-grafana-cloud weight: 200 diff --git a/docs/sources/setup/install/helm/monitor-and-alert/with-local-monitoring.md b/docs/sources/setup/install/helm/monitor-and-alert/with-local-monitoring.md index eadd153ccfa43..f294f8d6374c1 100644 --- a/docs/sources/setup/install/helm/monitor-and-alert/with-local-monitoring.md +++ b/docs/sources/setup/install/helm/monitor-and-alert/with-local-monitoring.md @@ -1,7 +1,7 @@ --- title: Configure monitoring and alerting menuTitle: Configure monitoring and alerting -description: setup monitoring and alerts for the Helm chart +description: How to setup monitoring and alerts using the Helm chart. aliases: - ../../../../installation/helm/monitor-and-alert/with-local-monitoring/ weight: 100 diff --git a/docs/sources/setup/install/istio.md b/docs/sources/setup/install/istio.md index ee96f4166d82c..74febca169460 100644 --- a/docs/sources/setup/install/istio.md +++ b/docs/sources/setup/install/istio.md @@ -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; " diff --git a/docs/sources/setup/install/local.md b/docs/sources/setup/install/local.md index 2e636d01f2523..91d972b6368e7 100644 --- a/docs/sources/setup/install/local.md +++ b/docs/sources/setup/install/local.md @@ -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 diff --git a/docs/sources/setup/install/tanka.md b/docs/sources/setup/install/tanka.md index 6a9812251f303..a17ad9618d327 100644 --- a/docs/sources/setup/install/tanka.md +++ b/docs/sources/setup/install/tanka.md @@ -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 diff --git a/docs/sources/setup/size/_index.md b/docs/sources/setup/size/_index.md index 7198db4e2eb4a..e2215c7e80f72 100644 --- a/docs/sources/setup/size/_index.md +++ b/docs/sources/setup/size/_index.md @@ -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 diff --git a/docs/sources/storage/_index.md b/docs/sources/storage/_index.md index a3a4e2913ed88..81a767e1add31 100644 --- a/docs/sources/storage/_index.md +++ b/docs/sources/storage/_index.md @@ -1,6 +1,6 @@ --- title: Storage -description: Storage +description: Describes Loki storage. weight: 475 --- # Storage