Skip to content

Commit

Permalink
docs: review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
JStickler committed Apr 8, 2024
1 parent fcc2e80 commit 9e9a621
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
20 changes: 10 additions & 10 deletions docs/sources/operations/storage/retention.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you have a lifecycle policy configured on the object store, please ensure tha
Granular retention policies to apply retention at per tenant or per stream level are also supported by the Compactor.

{{% admonition type="note" %}}
The Compactor does not support retention on [legacy index types](https://grafana.com/docs/loki /<LOKI_VERSION>/configure/storage/#index-storage). Please use the [Table Manager](https://grafana.com/docs/loki /<LOKI_VERSION>/operations/storage/table-manager/) when using legacy index types.
The Compactor does not support retention on [legacy index types](https://grafana.com/docs/loki/<LOKI_VERSION>/configure/storage/#index-storage). Please use the [Table Manager](https://grafana.com/docs/loki/<LOKI_VERSION>/operations/storage/table-manager/) when using legacy index types.
Both the Table manager and legacy index types are deprecated and may be removed in future major versions of Loki.
{{% /admonition %}}

Expand Down Expand Up @@ -100,7 +100,7 @@ Retention is only available if the index period is 24h. Single store TSDB and si

#### Configuring the retention period

Retention period is configured within the [`limits_config`](https://grafana.com/docs/loki /<LOKI_VERSION>/configure/#limits_config) configuration section.
Retention period is configured within the [`limits_config`](https://grafana.com/docs/loki/<LOKI_VERSION>/configure/#limits_config) configuration section.

There are two ways of setting retention policies:

Expand Down Expand Up @@ -129,7 +129,7 @@ limits_config:
You can only use label matchers in the `selector` field of a `retention_stream` definition. Arbitrary LogQL expressions are not supported.
{{% /admonition %}}

Per tenant retention can be defined by configuring [runtime overrides](https://grafana.com/docs/loki /<LOKI_VERSION>/configure/#runtime-configuration-file). For example:
Per tenant retention can be defined by configuring [runtime overrides](https://grafana.com/docs/loki/<LOKI_VERSION>/configure/#runtime-configuration-file). For example:

```yaml
overrides:
Expand Down Expand Up @@ -181,13 +181,13 @@ The example configurations defined above will result in the following retention

## Table Manager (deprecated)

Retention through the [Table Manager](https://grafana.com/docs/loki /<LOKI_VERSION>/operations/storage/table-manager/) is
Retention through the [Table Manager](https://grafana.com/docs/loki/<LOKI_VERSION>/operations/storage/table-manager/) is
achieved by relying on the object store TTL feature, and will work for both
[boltdb-shipper](https://grafana.com/docs/loki /<LOKI_VERSION>/operations/storage/boltdb-shipper/) store and chunk/index stores.
[boltdb-shipper](https://grafana.com/docs/loki/<LOKI_VERSION>/operations/storage/boltdb-shipper/) store and chunk/index stores.

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`](https://grafana.com/docs/loki /<LOKI_VERSION>/configure/#table_manager)
[`table_manager`](https://grafana.com/docs/loki/<LOKI_VERSION>/configure/#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
Expand All @@ -196,12 +196,12 @@ can be parsed using the Prometheus common model [ParseDuration](https://pkg.go.d

{{% admonition type="warning" %}}
The retention period must be a multiple of the index and chunks table
`period`, configured in the [`period_config`](https://grafana.com/docs/loki /<LOKI_VERSION>/configure/#period_config) block.
See the [Table Manager](https://grafana.com/docs/loki /<LOKI_VERSION>/operations/storage/table-manager/#retention) documentation for more information.
`period`, configured in the [`period_config`](https://grafana.com/docs/loki/<LOKI_VERSION>/configure/#period_config) block.
See the [Table Manager](https://grafana.com/docs/loki/<LOKI_VERSION>/operations/storage/table-manager/#retention) documentation for more information.
{{% /admonition %}}

{{% admonition type="note" %}}
To avoid querying of data beyond the retention period,`max_query_lookback` config in [`limits_config`](https://grafana.com/docs/loki /<LOKI_VERSION>/configure/#limits_config) must be set to a value less than or equal to what is set in `table_manager.retention_period`.
To avoid querying of data beyond the retention period,`max_query_lookback` config in [`limits_config`](https://grafana.com/docs/loki/<LOKI_VERSION>/configure/#limits_config) must be set to a value less than or equal to what is set in `table_manager.retention_period`.
{{% /admonition %}}

When using S3 or GCS, the bucket storing the chunks needs to have the expiry
Expand All @@ -222,7 +222,7 @@ intact; you will still be able to see related labels but will be unable to
retrieve the deleted log content.

For further details on the Table Manager internals, refer to the
[Table Manager](https://grafana.com/docs/loki /<LOKI_VERSION>/operations/storage/table-manager/) documentation.
[Table Manager](https://grafana.com/docs/loki/<LOKI_VERSION>/operations/storage/table-manager/) documentation.


## Example Configuration
Expand Down
8 changes: 3 additions & 5 deletions docs/sources/release-notes/v3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,14 @@ For a full list of all changes and fixes, refer to the [CHANGELOG](https://githu

Key features in Loki 3.0.0 include the following:

- **Query acceleration with Bloom filters** (experimental): This is designed to speed up filter queries, with best results for queries that are looking for a specific text string like an error message or UUID.
- **Query acceleration with Bloom filters** (experimental): This is designed to speed up filter queries, with best results for queries that are looking for a specific text string like an error message or UUID. For more information, refer to [Query acceleration with Blooms](https://grafana.com/docs/loki/<LOKI_VERSION>/operations/query-acceleration-blooms/).

- **Native OTel Support**: A simplified ingestion pipeline (Loki Exporter no longer needed) and a more intuitive query experience for OTel logs.
- **Native OpenTelemetry Support**: A simplified ingestion pipeline (Loki Exporter no longer needed) and a more intuitive query experience for OTel logs.

- **Helm charts**: configurable API version for PodLog CRD ([#10812](https://github.com/grafana/loki/issues/10812)) ([d1dee91](https://github.com/grafana/loki/commit/d1dee9150b0e69941b2bd3ce4b23afead174ea29)).
- **Helm charts**: A major upgrade to the Loki helm chart introduces support for `Distributed` mode (also known as [microservices](https://grafana.com/docs/loki/<LOKI_VERSION>/get-started/deployment-modes/#microservices-mode) mode), includes memcached by default, and includes several updates to configurations to improve Loki operations.

- **Lambda/Promtail:** support dropping labels ([#10755](https://github.com/grafana/loki/issues/10755)) ([ec54c72](https://github.com/grafana/loki/commit/ec54c723ebbeeda88000dde188d539ecfe05dad8)).

- **Logstash:** clients logstash output structured metadata support ([#10899](https://github.com/grafana/loki/issues/10899)) ([32f1ec2](https://github.com/grafana/loki/commit/32f1ec2fda5057732a2b20b98942aafec112c4ba)).

- **Docs improvements**: All the Getting Started topics have been revised, including a new [Quickstart](https://grafana.com/docs/loki/latest/get-started/quick-start/) to help new users get up and running with Loki faster.The Storage, Configuration Reference, and API documentation have been updated to reflect deprecated and removed code, configuration options, and API endpoints.

## Deprecations
Expand Down

0 comments on commit 9e9a621

Please sign in to comment.