doc: API/field/structure reference for most frequently used flags and configs
#9.976 aberto em 7 de nov. de 2025
Métricas do repositório
- Stars
- (17.118 estrelas)
- Métricas de merge de PR
- (Mesclagem média 19d 16h) (65 fundiu PRs em 30d)
Description
Is your feature request related to a problem? Please describe
For some most frequently used flags and configs, our doc only provides links to the somewhere else (such as Prometheus' doc).
Take relabeling as an example:
- user visit VictoriaMetrics doc.
- user search for keyword
relabeling. - user aware that
-relabelConfigflag is needed, and prepare to write such config file. - there's a code snippet in doc, but no other reference, unless user click the links such as relabel_config, Cookbook for common relabeling tasks, etc...
These links either don’t clearly indicate that "this is a reference containing all fields," or they consist mostly of examples—which can be scary for new users eager to find a straightforward reference.
Ideally, if users click on the relabel_config link, they’ll find exactly what they need. However, they may not know in advance whether the link leads to a reference, examples, or something else, leading to potential confusion.
Describe the solution you'd like
Think about a more proper way to lead user to:
- reference.
- examples.
For example, having an seperate doc for all configs reference of the most frequently used flag such as relabelConfig, just like sd_configs.
Describe alternatives you've considered
No response
Additional information
The enhancement request was originally from this public question: https://victoriametrics.slack.com/archives/CGZF1H6L9/p1762358837043459