From df5217baefae401163390332b8489a044f39c17c Mon Sep 17 00:00:00 2001 From: Zirpolo <111393839+Zirpolo@users.noreply.github.com> Date: Mon, 1 May 2023 01:29:14 -0700 Subject: [PATCH] Change upper and lower case Compactor name (#9288) Made chances to reflect uniform reference to the name Compactor, changed all lowercase instance outside of code to uppercase. **What this PR does / why we need it**: To make the docs uniform when speaking about the Compactor **Which issue(s) this PR fixes**: Fixes # **Special notes for your reviewer**: **Checklist** - [ ] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) - [ ] Documentation added - [ ] Tests updated - [ ] `CHANGELOG.md` updated - [ ] Changes that require user attention or interaction to upgrade are documented in `docs/sources/upgrading/_index.md` --- docs/sources/operations/storage/retention.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/sources/operations/storage/retention.md b/docs/sources/operations/storage/retention.md index 111535d53e..93c112652f 100644 --- a/docs/sources/operations/storage/retention.md +++ b/docs/sources/operations/storage/retention.md @@ -16,13 +16,13 @@ The Compactor retention will become the default and have long term support. It s The [Compactor]({{}}) can deduplicate index entries. It can also apply granular retention. When applying retention with the Compactor, the [Table Manager]({{}}) is unnecessary. -> Run the compactor as a singleton (a single instance). +> Run the Compactor as a singleton (a single instance). -Compaction and retention are idempotent. If the compactor restarts, it will continue from where it left off. +Compaction and retention are idempotent. If the Compactor restarts, it will continue from where it left off. The Compactor loops to apply compaction and retention at every `compaction_interval`, or as soon as possible if running behind. -The compactor's algorithm to update the index: +The Compactor's algorithm to update the index: - For each table within each day: - Compact the table into a single index file. @@ -30,7 +30,7 @@ The compactor's algorithm to update the index: - Remove marked chunks from the index and save their reference in a file on disk. - Upload the new modified index files. -The retention algorithm is applied to the index. Chunks are not deleted while applying the retention algorithm. The chunks will be deleted by the compactor asynchronously when swept. +The retention algorithm is applied to the index. Chunks are not deleted while applying the retention algorithm. The chunks will be deleted by the Compactor asynchronously when swept. Marked chunks will only be deleted after `retention_delete_delay` configured is expired because: @@ -42,7 +42,7 @@ Marker files (containing chunks to delete) should be stored on a persistent disk ### Retention Configuration -This compactor configuration example activates retention. +This Compactor configuration example activates retention. ```yaml compactor: @@ -82,7 +82,7 @@ The index period must be 24h. `compaction_interval` dictates how often compaction and/or retention is applied. If the Compactor falls behind, compaction and/or retention occur as soon as possible. -`retention_delete_delay` is the delay after which the compactor will delete marked chunks. +`retention_delete_delay` is the delay after which the Compactor will delete marked chunks. `retention_delete_worker_count` specifies the maximum quantity of goroutine workers instantiated to delete chunks.