prometheus scaler add option to ignore null value (kedacore#769)

* update doc for prometheus scaler Signed-off-by: Xinzhu Zhou <[email protected]> * revert params.version Signed-off-by: Xinzhu Zhou <[email protected]> * update according to review Signed-off-by: Xinzhu Zhou <[email protected]> * use true/false insteads of enable/disable Signed-off-by: Xinzhu Zhou <[email protected]> * fix typo Signed-off-by: Xinzhu Zhou <[email protected]>
vivekjainx86 · Jun 1, 2022 · 6be8451 · 6be8451
1 parent 1e53df4
commit 6be8451
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/content/docs/2.8/scalers/prometheus.md b/content/docs/2.8/scalers/prometheus.md
@@ -23,6 +23,7 @@ triggers:
     # Optional fields:
     namespace: example-namespace  # for namespaced queries, eg. Thanos
     cortexOrgId: my-org # Optional. X-Scope-OrgID header for Cortex.
+    ignoreNullValues: false # Default is `true`, which means ignoring the empty value list from Prometheus. Set to `false` the scaler will return error when Prometheus target is lost 
 ```
 
 **Parameter list:**
@@ -33,6 +34,7 @@ triggers:
 - `threshold` - Value to start scaling for.
 - `namespace` - A namespace that should be used for namespaced queries. These are required by some highly available Prometheus setups, such as [Thanos](https://thanos.io). (Optional)
 - `cortexOrgId` - The `X-Scope-OrgID` header to query multi tenant [Cortex](https://cortexmetrics.io/). (Optional)
+- `ignoreNullValues` - Value to reporting error when Prometheus target is lost (Values: `true`,`false`, Default: `true`, Optional)
 
 ### Authentication Parameters
 
@@ -289,4 +291,4 @@ spec:
         authModes: "tls,basic"
       authenticationRef:
         name: keda-prom-creds
-```
+```