grafana/loki

Detailed Documentation around Result Caching

Open

#8 895 ouverte le 24 mars 2023

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)Go (3 997 forks)batch import
help wantedtype/docs

Métriques du dépôt

Stars
 (28 187 stars)
Métriques de merge PR
 (Merge moyen 7j 10h) (312 PRs mergées en 30 j)

Description

We are trying to understand how the result caching works for metrics queries in Loki and there seems to be not detailed documentation around it.

We did some testing and below are our high-level observation but it would be good to know the expected behaviour so that we can take advantage of the results cache for long duration queries.

  • d1,d2,d3,d4,d5,d6,d7 - queried individualy but tried to query between d1 to d7 it is not using the cache
  • We need to build the cache like d1,d1+d2,d1+d2+d3,d1+d2+d3+d4,d1+d2+d3+d4+d5,d1+d2+d3+d4+d5+d6,d1+d2+d3+d4+d5+d6+d7 and then it works
  1. Detailed documentation of how results query works and best practice around logql to use caching effectively will be helpful
  2. Also logging to indicate if the query is using the cache (full or partial or not using) will be good information to expose.

Guide contributeur

Direction de recherche
Étudiez l'implémentation actuelle du cache dans Loki, en vous concentrant sur le cache des résultats de requête (probablement dans pkg/querier/). Documentez comment les clés de cache sont construites et pourquoi les plages non chevauchantes ne touchent pas le cache. Envisagez de journaliser les informations de succès/échec du cache dans le chemin de la requête. Le problème demande à la fois de la documentation et une amélioration de la journalisation. Examinez les commentaires existants et le code associé pour garantir des descriptions précises.
Stack technique
go
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
understanding of Loki and query caching concepts
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85