nlamirault / promdoc

Generate documentation from your Prometheus rules

promdoc

promdoc automatically generates documentation from your PrometheusRules.

Installation

GO111MODULE=on go get github.com/plexsystems/promdoc

Binaries are also provided on the releases page.

Usage

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 generate

Optionally, you can specify a directory to generate alerts for. This will look at the specified directory and its subdirectories:

$ promdoc generate alertsdirectory

To generate the output in CSV, include the .csv extension in the output:

$ promdoc generate --out alerts.csv

Supported output formats:

• Markdown (.md)
• CSV (.csv)