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.

Sign up for GitHub

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

Jump to bottom

docs: clarified the relation between retention period and table period #1129

Merged
merged 1 commit into from
Oct 8, 2019
Merged

docs: clarified the relation between retention period and table period #1129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion docs/configuration/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,8 @@ and how to provision tables when DynamoDB is used as the backing store.
[retention_deletes_enabled: <boolean> | default = false]

# How far back tables will be kept before they are deleted. 0s disables
# deletion.
# deletion. The retention period must be a multiple of the index / chunks
# table "period" (see period_config).
[retention_period: <duration> | default = 0s]

# Period with which the table manager will poll for tables.
Expand Down
6 changes: 4 additions & 2 deletions docs/operations/storage/retention.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ Alternatively, the `table-manager.retention-period` and
provided retention period needs to be a duration represented as a string that
can be parsed using Go's [time.Duration](https://golang.org/pkg/time/#ParseDuration).

> **WARNING**: The retention period should be at least twice the [duration of
the periodic table config](https://github.com/grafana/loki/blob/347a3e18f4976d799d51a26cee229efbc27ef6c9/production/helm/loki/values.yaml#L53), which currently defaults to 7 days.
> **WARNING**: The retention period must be a multiple of the index and chunks table
`period`, configured in the [`period_config`](../../configuration/README.md#period_config)
block. See the [Table Manager](./table-manager.md#retention) documentation for
more information.

When using S3 or GCS, the bucket storing the chunks needs to have the expiry
policy set correctly. For more details check
Expand Down