promdoc automatically generates documentation from your PrometheusRules.
GO111MODULE=on go get github.com/plexsystems/promdoc
Binaries are also provided on the releases page.
promdoc will generate the output in the format that matches the output file.
For example, to generate markdown, run the following command in the root folder where you want promdoc to search for rules.
$ promdoc generateOptionally, you can specify a directory to generate alerts for. This will look at the specified directory and its subdirectories:
$ promdoc generate alertsdirectoryTo generate the output in CSV, include the .csv extension in the output:
$ promdoc generate --out alerts.csvSupported output formats:
- Markdown (.md)
- CSV (.csv)