prometheus/prometheus

promql: option to preserve comments in parser

Ouverte

#15 871 ouverte le 28 janv. 2025

Voir sur GitHubGuide contributeur
 (3 commentaires) (0 réaction) (0 personne assignée)Go (10 408 forks)batch import
component/promqlhelp wantedkind/featurenot-as-easy-as-it-lookspriority/P3

Métriques du dépôt

Stars
 (64 042 étoiles)
Métriques de merge PR
 (Merge moyen 11j 5h) (118 PRs mergées en 30 j)

Description

Proposal

I have a requirement to analyse and modify promql expressions to enforce some business-specific rules. This is being achieved by parsing to the AST, analysing the tree through traversal, and optionally applying modifications to the AST before rendering it back to a string.

Comments are currently stripped in this process by a hard-coded skip in the parser.

We would like this to be an option somewhere so that we can preserve these comments through the parse->AST->string process, as these comments can contain useful debugging/tracing information provided by the original query issuer.

Guide contributeur

Direction de recherche
Examinez la logique de saut codée en dur dans parser.parse aux lignes 356-363. Comprenez comment les commentaires sont actuellement supprimés et comment ajouter une option pour les conserver. Cherchez les modèles d'options de parseur existants dans la base de code.
Stack technique
go
Domaine
backend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
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
Go
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50