Docs: Modify label names of configuration blocks (#4787)

* Docs: Add label names of configuration blocks

* Docs: Match configuration block name with docs subsection name
pull/4803/head
Karen Miller 5 years ago committed by GitHub
parent 88feda41a0
commit 2a6ddffb49
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 123
      docs/sources/configuration/_index.md
  2. 2
      docs/sources/configuration/query-frontend.md
  3. 2
      docs/sources/operations/recording-rules.md
  4. 2
      docs/sources/operations/storage/retention.md
  5. 6
      docs/sources/operations/storage/table-manager.md
  6. 2
      docs/sources/release-notes/v2-4.md
  7. 2
      docs/sources/rules/_index.md

@ -93,36 +93,37 @@ Pass the `-config.expand-env` flag at the command line to enable this way of set
[auth_enabled: <boolean> | default = true]
# Configures the server of the launched module(s).
[server: <server_config>]
[server: <server>]
# Configures the distributor.
[distributor: <distributor_config>]
[distributor: <distributor>]
# Configures the querier. Only appropriate when running all modules or
# just the querier.
[querier: <querier_config>]
[querier: <querier>]
# The query_scheduler block configures the Loki query scheduler.
# When configured it separates the tenant query queues from the query-frontend
[query_scheduler: <query_scheduler_config>]
[query_scheduler: <query_scheduler>]
# The query_frontend_config configures the Loki query-frontend.
[frontend: <query_frontend_config>]
# The frontend block configures the Loki query-frontend.
[frontend: <frontend>]
# The queryrange_config configures the query splitting and caching in the Loki
# The query_range block configures the query splitting and caching in the Loki
# query-frontend.
[query_range: <queryrange_config>]
[query_range: <query_range>]
# The ruler_config configures the Loki ruler.
[ruler: <ruler_config>]
# The ruler block configures the Loki ruler.
[ruler: <ruler>]
# Configures how the distributor will connect to ingesters. Only appropriate
# when running all modules, the distributor, or the querier.
[ingester_client: <ingester_client_config>]
# The ingester_client block configures how the distributor will connect
# to ingesters. Only appropriate when running all components, the distributor,
# or the querier.
[ingester_client: <ingester_client>]
# Configures the ingester and how the ingester will register itself to a
# The ingester block configures the ingester and how the ingester will register itself to a
# key value store.
[ingester: <ingester_config>]
[ingester: <ingester>]
# Configures where Loki will store data.
[storage_config: <storage_config>]
@ -133,34 +134,35 @@ Pass the `-config.expand-env` flag at the command line to enable this way of set
# Configures the chunk index schema and where it is stored.
[schema_config: <schema_config>]
# Configures the compactor component which compacts index shards for performance.
[compactor: <compactor_config>]
# The compactor block configures the compactor component which compacts index shards for performance.
[compactor: <compactor>]
# Configures limits per-tenant or globally.
[limits_config: <limits_config>]
# The frontend_worker_config configures the worker - running within the Loki
# The frontend_worker configures the worker - running within the Loki
# querier - picking up and executing queries enqueued by the query-frontend.
[frontend_worker: <frontend_worker_config>]
[frontend_worker: <frontend_worker>]
# Configures the table manager for retention.
[table_manager: <table_manager_config>]
# The table_manager block configures the table manager for retention.
[table_manager: <table_manager>]
# Configuration for "runtime config" module, responsible for reloading runtime configuration file.
[runtime_config: <runtime_config>]
# Configuration for tracing.
[tracing: <tracing_config>]
[tracing: <tracing>]
# Common config to be shared between multiple modules.
# If a more specific config is given in other sections, the related config under this section
# will be ignored.
[common: <common_config>]
# Common configuration to be shared between multiple modules.
# If a more specific configuration is given in other sections,
# the related configuration within this section will be ignored.
[common: <common>]
```
## server_config
## server
The `server_config` block configures the HTTP and gRPC server of the launched service(s):
The `server` block
configures the HTTP and gRPC server communication of the launched service(s).
```yaml
# HTTP server listen host
@ -221,9 +223,9 @@ The `server_config` block configures the HTTP and gRPC server of the launched se
[http_path_prefix: <string> | default = ""]
```
## distributor_config
## distributor
The `distributor_config` block configures the Loki Distributor.
The `distributor` block configures the distributor component.
```yaml
# Configures the distributors ring, used when the "global" ingestion rate
@ -253,9 +255,9 @@ ring:
[heartbeat_timeout: <duration> | default = 1m]
```
## querier_config
## querier
The `querier_config` block configures the Loki Querier.
The `querier` block configures the Loki Querier.
```yaml
# Timeout when querying ingesters or storage during the execution of a query request.
@ -296,9 +298,9 @@ engine:
[max_look_back_period: <duration> | default = 30s]
```
## query_scheduler_config
## query_scheduler
The `query_scheduler_config` block configures the Loki query scheduler.
The `query_scheduler` block configures the Loki query scheduler.
```yaml
# Maximum number of outstanding requests per tenant per query-scheduler.
@ -321,9 +323,9 @@ The `query_scheduler_config` block configures the Loki query scheduler.
[scheduler_ring: <ring_config>]
```
## query_frontend_config
## frontend
The query_frontend_config configures the Loki query-frontend.
The `frontend` block configures the Loki query-frontend.
```yaml
# Maximum number of outstanding requests per tenant per frontend; requests
@ -363,9 +365,9 @@ The query_frontend_config configures the Loki query-frontend.
[scheduler_worker_concurrency: <int> | default = 5]
```
## queryrange_config
## query_range
The queryrange_config configures the query splitting and caching in the Loki query-frontend.
The `query_range` block configures query splitting and caching in the Loki query-frontend.
```yaml
# Split queries by an interval and execute in parallel, 0 disables it. You
@ -410,9 +412,9 @@ results_cache:
[parallelise_shardable_queries: <boolean> | default = false]
```
## ruler_config
## ruler
The `ruler_config` configures the Loki ruler.
The `ruler` block configures the Loki ruler.
```yaml
# URL of alerts return path.
@ -861,9 +863,9 @@ The `local_storage_config` configures a (local) filesystem as a general storage
[directory: <filename> | default = ""]
```
## frontend_worker_config
## frontend_worker
The `frontend_worker_config` configures the worker - running within the Loki querier - picking up and executing queries enqueued by the query-frontend.
The `frontend_worker` configures the worker - running within the Loki querier - picking up and executing queries enqueued by the query-frontend.
```yaml
# Address of query frontend service, in host:port format.
@ -887,9 +889,9 @@ The `frontend_worker_config` configures the worker - running within the Loki que
[scheduler_address: <string> | default = ""]
```
## ingester_client_config
## ingester_client
The `ingester_client_config` block configures how connections to ingesters
The `ingester_client` block configures how connections to ingesters
operate.
```yaml
@ -918,9 +920,9 @@ pool_config:
[grpc_client_config: <grpc_client_config>]
```
## ingester_config
## ingester
The `ingester_config` block configures the Loki Ingesters.
The `ingester` block configures the Loki Ingesters.
```yaml
# Configures how the lifecycle of the ingester will operate
@ -1842,9 +1844,9 @@ chunks:
[row_shards: <int> | default = 16]
```
## compactor_config
## compactor
The `compactor_config` block configures the compactor component. This component periodically
The `compactor` block configures the compactor component. This component periodically
compacts index shards to more performant forms.
```yaml
@ -2173,9 +2175,9 @@ backoff_config:
[max_retries: <int> | default = 10]
```
## table_manager_config
## table_manager
The `table_manager_config` block configures the Loki table-manager.
The `table_manager` block configures the Loki table-manager.
```yaml
# Master 'off-switch' for table capacity updates, e.g. when troubleshooting.
@ -2299,9 +2301,9 @@ The `auto_scaling_config` block configures autoscaling for DynamoDB.
[target: <float> | default = 80]
```
## tracing_config
## tracing
The `tracing_config` block configures tracing for Jaeger. Currently limited to disable auto-configuration per [environment variables](https://www.jaegertracing.io/docs/1.16/client-features/) only.
The `tracing` block configures tracing for Jaeger. Currently limited to disable auto-configuration per [environment variables](https://www.jaegertracing.io/docs/1.16/client-features/) only.
```yaml
# Whether or not tracing should be enabled.
@ -2309,14 +2311,14 @@ The `tracing_config` block configures tracing for Jaeger. Currently limited to d
[enabled: <boolean>: default = true]
```
## common_config
## common
The `common_config` block sets common definitions to be shared by different components.
This way, one doesn't have to replicate configs in multiple places.
The `common` block sets common definitions to be shared by different components.
This way, one doesn't have to replicate configuration in multiple places.
```yaml
# A common storage config to be used by the different Loki components.
[storage: <common_storage_config>]
# A common storage configuration to be used by the different Loki components.
[storage: <storage>]
# When defined, the given prefix will be present in front of the endpoint paths.
[path_prefix: <string>]
@ -2337,10 +2339,11 @@ This way, one doesn't have to replicate configs in multiple places.
[ring: <ring_config>]
```
### common_storage_config
### storage
The `common_storage_config` block defines a common storage to be reused by different components as a way to facilitate storage configuration.
If any specific configs for an object storage client have been provided elsewhere in the configuration file, the specific config will supersede the common storage config.
The common `storage` block defines a common storage to be reused by different
components as a way to facilitate storage configuration.
If any specific configuration for an object storage client have been provided elsewhere in the configuration file, the specific configuration will supersede the common storage configuration.
```yaml
# Configures Azure as the common storage.

@ -13,7 +13,7 @@ It's a common occurrence to start running Grafana Loki as a single binary while
### Parallelization
One of the most important functions of the query frontend is the ability to split larger queries into smaller ones, execute them in parallel, and stitch the results back together. How often it splits them is determined by the `querier.split-queries-by-interval` flag or the yaml config `queryrange.split_queriers_by_interval`. With this set to `1h`, the frontend will dissect a day long query into 24 one hour queries, distribute them to the queriers, and collect the results. This is immensely helpful in production environments as it not only allows us to perform larger queries via aggregation, but also evens the work distribution across queriers so that one or two are not stuck with impossibly large queries while others are left idle.
One of the most important functions of the query frontend is the ability to split larger queries into smaller ones, execute them in parallel, and stitch the results back together. How often it splits them is determined by the `querier.split-queries-by-interval` flag or the yaml config `query_range.split_queriers_by_interval`. With this set to `1h`, the frontend will dissect a day long query into 24 one hour queries, distribute them to the queriers, and collect the results. This is immensely helpful in production environments as it not only allows us to perform larger queries via aggregation, but also evens the work distribution across queriers so that one or two are not stuck with impossibly large queries while others are left idle.
## Kubernetes Deployment

@ -71,7 +71,7 @@ so a `Persistent Volume` should be utilised.
### Per-Tenant Limits
Remote-write can be configured at a global level in the base configuration, and certain parameters tuned specifically on
a per-tenant basis. Most of the configuration options [defined here](../../configuration/#ruler_config)
a per-tenant basis. Most of the configuration options [defined here](../../configuration/#ruler)
have [override options](../../configuration/#limits_config) (which can be also applied at runtime!).
### Tuning

@ -160,7 +160,7 @@ The example configurations will set these rules:
In order to enable the retention support, the Table Manager needs to be
configured to enable deletions and a retention period. Please refer to the
[`table_manager_config`](../../../configuration#table_manager_config)
[`table_manager`](../../../configuration#table_manager)
section of the Loki configuration reference for all available options.
Alternatively, the `table-manager.retention-period` and
`table-manager.retention-deletes-enabled` command line flags can be used. The

@ -38,7 +38,7 @@ to store chunks, are not managed by the Table Manager, and a custom bucket polic
should be set to delete old data.
For detailed information on configuring the Table Manager, refer to the
[`table_manager`](../../../configuration#table_manager_config)
[`table_manager`](../../../configuration#table_manager)
section in the Loki configuration document.
@ -104,7 +104,7 @@ order to make sure that the new table is ready once the current table end
period is reached.
The `creation_grace_period` property - in the
[`table_manager`](../../../configuration#table_manager_config)
[`table_manager`](../../../configuration#table_manager)
configuration block - defines how long before a table should be created.
@ -148,7 +148,7 @@ documentation.
A table can be active or inactive.
A table is considered **active** if the current time is within the range:
- Table start period - [`creation_grace_period`](../../../configuration#table_manager_config)
- Table start period - [`creation_grace_period`](../../../configuration#table_manager)
- Table end period + max chunk age (hardcoded to `12h`)
![active_vs_inactive_tables](../table-manager-active-vs-inactive-tables.png)

@ -14,7 +14,7 @@ Loki 2.4 focuses on two items:
* [**Loki no longer requires logs to be sent in perfect chronological order.**](../../configuration/#accept-out-of-order-writes) Support for out of order logs is one of the most highly requested features for Loki. The strict ordering constraint has been removed.
* Scaling Loki is now easier with a hybrid deployment mode that falls between our single binary and our microservices. The [Simple scalable deployment](../../fundamentals/architecture/#modes-of-operation) scales Loki with new `read` and `write` targets. Where previously you would have needed Kubernetes and the microservices approach to start tapping into Loki’s potential, it’s now possible to do this in a simpler way.
* The new [`common_config` section](../../configuration/#common_config) results in a 70% smaller Loki configuration. Pair that with updated defaults and Loki comes out of the box with more appropriate defaults and limits. Check out the [example local configuration](https://github.com/grafana/loki/blob/main/cmd/loki/loki-local-config.yaml) as the new reference for running Loki.
* The new [`common` section](../../configuration/#common) results in a 70% smaller Loki configuration. Pair that with updated defaults and Loki comes out of the box with more appropriate defaults and limits. Check out the [example local configuration](https://github.com/grafana/loki/blob/main/cmd/loki/loki-local-config.yaml) as the new reference for running Loki.
* [**Recording rules**](../../rules/#recording-rules) are no longer an experimental feature. We've given them a more resilient implementation which leverages the existing write ahead log code in Prometheus.
* The new [**Promtail Kafka Consumer**](../../clients/promtail/scraping/#kafka) can easily get your logs out of Kafka and into Loki.
* There are **nice LogQL enhancements**, thanks to the amazing Loki community. LogQL now has [group_left and group_right](../../logql/#many-to-one-and-one-to-many-vector-matches). And, the `label_format` and `line_format` functions now support [working with dates and times](../../logql/template_functions/#now).

@ -122,7 +122,7 @@ ruler:
url: http://localhost:9090/api/v1/write
```
Further configuration options can be found under [ruler_config](/configuration#ruler_config).
Further configuration options can be found under [ruler](../configuration#ruler).
### Operations

Loading…
Cancel
Save