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

Update descriptions #11586

Merged
merged 3 commits into from
Jan 5, 2024
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
2 changes: 1 addition & 1 deletion docs/sources/configure/bp-configure.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/get-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/get-started/architecture.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Loki architecture
menutitle: Architecture
description: Grafana Loki's architecture.
description: Describes Grafana Loki's architecture.
weight: 300
aliases:
- ../architecture/
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/get-started/components.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/get-started/deployment-modes.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/get-started/labels/bp-labels.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/get-started/labels/structured-metadata.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/sources/get-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/automatic-stream-sharding.md
Original file line number Diff line number Diff line change
@@ -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:
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/autoscaling_queriers.md
Original file line number Diff line number Diff line change
@@ -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:
---

Expand Down
12 changes: 7 additions & 5 deletions docs/sources/operations/blocking-queries.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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:

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/caching.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/loki-canary/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/multi-tenancy.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/overrides-exporter.md
Original file line number Diff line number Diff line change
@@ -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:
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/query-fairness/_index.md
Original file line number Diff line number Diff line change
@@ -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:
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/shuffle-sharding/_index.md
Original file line number Diff line number Diff line change
@@ -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:
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/storage/filesystem.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/storage/logs-deletion.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/storage/retention.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/operations/storage/table-manager/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/storage/tsdb.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/storage/wal.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/operations/zone-ingesters.md
Original file line number Diff line number Diff line change
@@ -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:
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/query/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/query/ip.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/query/logcli.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/query/metric_queries.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/query/query_examples.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/query/template_functions.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Loki reference topics
menuTitle: Reference
description: Reference topics for Loki.
description: Overview page for Loki reference topics.
weight: 1000
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/api.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/send-data/docker-driver/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/send-data/docker-driver/configuration.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/send-data/fluentbit/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/send-data/fluentd/_index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/send-data/k6/log-generation.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading
Loading