prometheus/prometheus

Rule formatting tool.

Open

#21 opened on Jan 4, 2013

View on GitHub
 (41 comments) (6 reactions) (0 assignees)Go (64,042 stars) (10,408 forks)batch import
component/promtoolhelp wantedkind/enhancementpriority/P3

Description

Like "gofmt" for Go, we ought to have a "promfmt" for Prometheus since we have a syntax tree. The idea being that the system produces uniform style that minimizes deviation and learning curve.

Update after we have totally moved to YAML rule files: In addition to formatting the PromQL expressions, we also want to format the YAML files to have a fixed structure, while preserving comments for both PromQL expressions and the YAML file.

Contributor guide

Tech stack
go
Domain
toolingcli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go programmingUnderstanding of ASTPromQL knowledgeYAML formatting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Start by examining the existing PromQL parsing code in promql/parser and the YAML rule file handling in rules/. Study gofmt's implementation for inspiration on formatting approach. Review the comment threads for design considerations on preserving comments in both PromQL expressions and YAML structure.