README
¶
promql-formatter-cli
A Go library and CLI for formatting (prettifying) PromQL queries.
It powers the promql-formatter Chrome extension and can also be used standalone.
Two backends are available:
vic(default) — VictoriaMetricsmetricsql.Prettify.main— a custom Prometheus-AST formatter with Grafana$variablesupport.
Install
go install github.com/xhinliang/promql-formatter-cli/cmd/promql-formatter@latest
CLI usage
# format an argument (default backend: vic)
promql-formatter 'sum(rate(http_requests_total[1m])) by (job)'
# read from stdin, choose a backend
echo 'sum(rate(http_requests_total[1m])) by (job)' | promql-formatter --formatter main
Flags:
--formatter vic|main— choose the backend (defaultvic).--version— print the version.
Library usage
import promqlfmt "github.com/xhinliang/promql-formatter-cli"
out, err := promqlfmt.Format(query, "vic") // or promqlfmt.FormatVic / promqlfmt.FormatMain
License
Apache-2.0. See LICENSE.
Acknowledgements
The main backend originates from the o11y.tools PromQL
prettifier (Apache-2.0). The vic backend wraps VictoriaMetrics metricsql.
Documentation
¶
Overview ¶
Package promqlfmt formats PromQL queries.
Two backends are available:
- "vic": VictoriaMetrics metricsql.Prettify (the default)
- "main": a custom Prometheus-AST formatter with Grafana $variable support
Index ¶
Constants ¶
View Source
const ( BackendVic = "vic" BackendMain = "main" )
Backend names accepted by Format.
Variables ¶
This section is empty.
Functions ¶
func Format ¶
Format formats promql using the named backend. An empty or unrecognized backend falls back to BackendVic.
func FormatMain ¶
formatPromql takes a PromQL query string and returns a "prettified" version.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
promql-formatter
command
Command promql-formatter formats a PromQL query taken from a positional argument or from stdin, using the "vic" backend by default.
|
Command promql-formatter formats a PromQL query taken from a positional argument or from stdin, using the "vic" backend by default. |
Click to show internal directories.
Click to hide internal directories.