diff --git a/app/vmalert/README.md b/app/vmalert/README.md index 1d0e785e01..1a98ed83f6 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -82,6 +82,10 @@ name: # up round execution speed. [ concurrency: | default = 1 ] +# Optional type for expressions inside the rules. Supported values: "graphite" and "prometheus". +# By default "prometheus" rule type is used. +[ type: ] + rules: [ - ... ] ``` @@ -182,7 +186,7 @@ Used as alert source in AlertManager. ### Graphite vmalert sends requests to `<-datasource.url>/render?format=json` during evaluation of alerting and recording rules -if the corresponding rule contains `type: "graphite"` config option. It is expected that the `<-datasource.url>/render` +if the corresponding group or rule contains `type: "graphite"` config option. It is expected that the `<-datasource.url>/render` implements [Graphite Render API](https://graphite.readthedocs.io/en/stable/render_api.html) for `format=json`. diff --git a/docs/vmalert.md b/docs/vmalert.md index 1d0e785e01..1a98ed83f6 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -82,6 +82,10 @@ name: # up round execution speed. [ concurrency: | default = 1 ] +# Optional type for expressions inside the rules. Supported values: "graphite" and "prometheus". +# By default "prometheus" rule type is used. +[ type: ] + rules: [ - ... ] ``` @@ -182,7 +186,7 @@ Used as alert source in AlertManager. ### Graphite vmalert sends requests to `<-datasource.url>/render?format=json` during evaluation of alerting and recording rules -if the corresponding rule contains `type: "graphite"` config option. It is expected that the `<-datasource.url>/render` +if the corresponding group or rule contains `type: "graphite"` config option. It is expected that the `<-datasource.url>/render` implements [Graphite Render API](https://graphite.readthedocs.io/en/stable/render_api.html) for `format=json`.