From ebdb64b3f50ad2ca94fcf3b004e5ea23307cc2c6 Mon Sep 17 00:00:00 2001 From: Michel Hollands <42814411+MichelHollands@users.noreply.github.com> Date: Fri, 9 Sep 2022 09:50:27 +0100 Subject: [PATCH] Small updates to the deletion documentation (#7112) **What this PR does / why we need it**: - Fix a typo - Fix the links in for the deletion API **Checklist** - [X] Documentation added - [ ] Tests updated - [ ] Is this an important fix or new feature? Add an entry in the `CHANGELOG.md`. - [ ] Changes that require user attention or interaction to upgrade are documented in `docs/sources/upgrading/_index.md` Signed-off-by: Michel Hollands --- docs/sources/api/_index.md | 8 ++++---- docs/sources/operations/storage/logs-deletion.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/sources/api/_index.md b/docs/sources/api/_index.md index 0c20b67041..60fe0d76cb 100644 --- a/docs/sources/api/_index.md +++ b/docs/sources/api/_index.md @@ -74,10 +74,10 @@ These endpoints are exposed by the ruler: - [`GET /prometheus/api/v1/alerts`](#list-alerts) These endpoints are exposed by the compactor: -- [`GET /compactor/ring`](#get-compactorring) -- [`POST /loki/api/v1/delete`](#post-lokiapiv1delete) -- [`GET /loki/api/v1/delete`](#get-lokiapiv1delete) -- [`DELETE /loki/api/v1/delete`](#delete-lokiapiv1delete) +- [`GET /compactor/ring`](#compactor-ring-status) +- [`POST /loki/api/v1/delete`](#request-log-deletion) +- [`GET /loki/api/v1/delete`](#list-log-deletion-requests) +- [`DELETE /loki/api/v1/delete`](#request-cancellation-of-a-delete-request) A [list of clients](../clients) can be found in the clients documentation. diff --git a/docs/sources/operations/storage/logs-deletion.md b/docs/sources/operations/storage/logs-deletion.md index 9e58b27b1f..63c5c6e1ad 100644 --- a/docs/sources/operations/storage/logs-deletion.md +++ b/docs/sources/operations/storage/logs-deletion.md @@ -21,7 +21,7 @@ Log entry deletion relies on configuration of the custom logs retention workflow Enable log entry deletion by setting `retention_enabled` to true in the compactor's configuration and setting and `deletion_mode` to `filter-only` or `filter-and-delete` in the runtime config. -Because it is a runtime configuration, `deleteion_mode` can be set per-tenant, if desired. +Because it is a runtime configuration, `deletion_mode` can be set per-tenant, if desired. With `filter-only`, log lines matching the query in the delete request are filtered out when querying Loki. They are not removed from storage. With `filter-and-delete`, log lines matching the query in the delete request are filtered out when querying Loki, and they are also removed from storage.