grafana/loki

Documentation about deleting logs / retention should be reworked

Open

#7,742 opened on Nov 22, 2022

View on GitHub
 (3 comments) (20 reactions) (1 assignee)Go (3,997 forks)batch import
help wantedtype/docs

Repository metrics

Stars
 (28,187 stars)
PR merge metrics
 (Avg merge 5d 20h) (522 merged PRs in 30d)

Description

I'm always frustrated when it comes to deleting logs from loki.

  1. The documentation is splitted across at least 4 pages.

  1. After submitting a new delete request, it takes a few minutes a query could not find the logs anymore. The excact timing is not, if not poorly documented.

  2. The delete request have a states received and processed, but even if there are received only, it is not possible find them with a query (related to 2.).

  3. The deletion of chunks. When does is happen, where does is happen (dependency of the used storage)?

  4. How does deleting logs relates to Compactor and Table Manager?

  5. How does deleting logs relates to retention?

Describe the solution you'd like A clear and concise description of deleting logs, at best on a single page.

Contributor guide

Research direction
Review the linked documentation pages and identify overlaps and gaps. Propose a single page structure that covers deletion workflow, states, timings, and relation to compactor/table manager and retention.
Tech stack
go
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85