Skip to content

Commit

Permalink
<doc>: information about max_look_back_period (#1474)
Browse files Browse the repository at this point in the history
* <doc>: information about max_look_back_period

* update example

* added a note to retention doc and fixed a spell error

Co-authored-by: Sandeep Sukhani <sandeep.d.sukhani@gmail.com>
  • Loading branch information
eraac and sandeepsukhani committed Jan 8, 2020
1 parent 29e4ad8 commit 18faf99
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -643,7 +643,9 @@ to wait before saving them to the backing store.
# disabled.
[cache_lookups_older_than: <duration>]
# Limit how long back data can be queries. Default is disabled.
# Limit how long back data can be queried. Default is disabled.
# This should always be set to a value less than or equal to
# what is set in `table_manager.retention_period`.
[max_look_back_period: <duration>]
```
Expand Down
7 changes: 7 additions & 0 deletions docs/operations/storage/retention.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ can be parsed using Go's [time.Duration](https://golang.org/pkg/time/#ParseDurat
block. See the [Table Manager](./table-manager.md#retention) documentation for
more information.

> **NOTE**: To avoid querying of data beyond the retention period,
`max_look_back_period` config in [`chunk_store_config`](../../configuration/README.md#chunk_store_config) must be set to a value less than or equal to
what is set in `table_manager.retention_period`.

When using S3 or GCS, the bucket storing the chunks needs to have the expiry
policy set correctly. For more details check
[S3's documentation](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html)
Expand Down Expand Up @@ -57,6 +61,9 @@ storage_config:
gcs:
bucket_name: GCS_BUCKET_NAME

chunk_store_config:
max_look_back_period: 720h

table_manager:
retention_deletes_enabled: true
retention_period: 720h
Expand Down

0 comments on commit 18faf99

Please sign in to comment.