grafana/loki

No documentation on lifecycle policies for retention in object stores

Open

#15528 opened on Dec 20, 2024

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Go (28,187 stars) (3,997 forks)batch import
component/storagehelp wantedtype/docs

Description

The documentation about retention states that logs are only deleted if a lifecycle storage policy on the store deletes it, however, the documentation doesn't specify what that policy should look like.

For instance:

  1. What is the significance of the loki_cluster_seed.json file at the root of the container? (A blanket delete after x days policy would automatically delete this as well)
  2. Are files in /index meant to be deleted, or should it just be limited to /<orgId> or /fake

Contributor guide

Tech stack
go
Domain
documentation
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of object storage lifecycle policiesFamiliarity with Grafana Loki storage structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the current retention documentation at the provided URL to understand what is already stated. Look at the Loki source code to understand the significance of 'loki cluster seed.json' and the index files. Check for any existing issues or discussions about lifecycle policies. Then propose updates to the documentation to clarify the required lifecycle policy, addressing the specific questions about the seed file and index directory.