You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Prometheus: Mark queryParameters as an optional field instead of an required field (kedacore#1395)
* Move queryParameters down to the optional field list
Signed-off-by: Alec Hinh <alec4555@gmail.com>
* Move the query parameters list entries down to optional in the other versions
Signed-off-by: Alec Hinh <alec4555@gmail.com>
---------
Signed-off-by: Alec Hinh <alec4555@gmail.com>
Copy file name to clipboardexpand all lines: content/docs/2.13/scalers/prometheus.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -17,14 +17,14 @@ triggers:
17
17
# Required fields:
18
18
serverAddress: http://<prometheus-host>:9090
19
19
query: sum(rate(http_requests_total{deployment="my-deployment"}[2m])) # Note: query must return a vector/scalar single element response
20
-
queryParameters: key-1=value-1,key-2=value-2
21
20
threshold: '100.50'
22
21
activationThreshold: '5.5'
23
22
# Optional fields:
24
23
namespace: example-namespace # for namespaced queries, eg. Thanos
25
24
cortexOrgID: my-org # DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of customHeaders and will be removed in version 2.12. Use custom headers instead to set X-Scope-OrgID header for Cortex. (see below)
26
25
customHeaders: X-Client-Id=cid,X-Tenant-Id=tid,X-Organization-Id=oid # Optional. Custom headers to include in query. In case of auth header, use the custom authentication or relevant authModes.
27
26
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
27
+
queryParameters: key-1=value-1,key-2=value-2
28
28
unsafeSsl: "false"# Default is `false`, Used for skipping certificate check when having self-signed certs for Prometheus endpoint
29
29
30
30
```
@@ -33,13 +33,13 @@ triggers:
33
33
34
34
-`serverAddress` - Address of Prometheus server. If using VictoriaMetrics cluster version, set full URL to Prometheus querying API, e.g. `http://<vmselect>:8481/select/0/prometheus`
35
35
-`query` - Query to run.
36
-
-`queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint.
37
36
-`threshold` - Value to start scaling for. (This value can be a float)
38
37
-`activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float)
39
38
-`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)
40
39
-`cortexOrgID` - DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of `customHeaders` and will be removed in version 2.12. Use `customHeaders: X-Scope-OrgID=##` instead to query multi tenant [Cortex](https://cortexmetrics.io/) or [Mimir](https://grafana.com/oss/mimir/). (Optional)
41
40
-`customHeaders` - Custom headers to include while querying the prometheus endpoint. In case of authentication headers, use custom authentication or relevant `authModes` instead. (Optional)
42
41
-`ignoreNullValues` - Value to reporting error when Prometheus target is lost (Values: `true`,`false`, Default: `true`, Optional)
42
+
-`queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint. (Optional)
43
43
-`unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs (Values: `true`,`false`, Default: `false`, Optional)
Copy file name to clipboardexpand all lines: content/docs/2.14/scalers/prometheus.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -17,14 +17,14 @@ triggers:
17
17
# Required fields:
18
18
serverAddress: http://<prometheus-host>:9090
19
19
query: sum(rate(http_requests_total{deployment="my-deployment"}[2m])) # Note: query must return a vector/scalar single element response
20
-
queryParameters: key-1=value-1,key-2=value-2
21
20
threshold: '100.50'
22
21
activationThreshold: '5.5'
23
22
# Optional fields:
24
23
namespace: example-namespace # for namespaced queries, eg. Thanos
25
24
cortexOrgID: my-org # DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of customHeaders and will be removed in version 2.12. Use custom headers instead to set X-Scope-OrgID header for Cortex. (see below)
26
25
customHeaders: X-Client-Id=cid,X-Tenant-Id=tid,X-Organization-Id=oid # Optional. Custom headers to include in query. In case of auth header, use the custom authentication or relevant authModes.
27
26
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
27
+
queryParameters: key-1=value-1,key-2=value-2
28
28
unsafeSsl: "false"# Default is `false`, Used for skipping certificate check when having self-signed certs for Prometheus endpoint
29
29
30
30
```
@@ -33,13 +33,13 @@ triggers:
33
33
34
34
-`serverAddress` - Address of Prometheus server. If using VictoriaMetrics cluster version, set full URL to Prometheus querying API, e.g. `http://<vmselect>:8481/select/0/prometheus`
35
35
-`query` - Query to run.
36
-
-`queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint.
37
36
-`threshold` - Value to start scaling for. (This value can be a float)
38
37
-`activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float)
39
38
-`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)
40
39
-`cortexOrgID` - DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of `customHeaders` and will be removed in version 2.12. Use `customHeaders: X-Scope-OrgID=##` instead to query multi tenant [Cortex](https://cortexmetrics.io/) or [Mimir](https://grafana.com/oss/mimir/). (Optional)
41
40
-`customHeaders` - Custom headers to include while querying the prometheus endpoint. In case of authentication headers, use custom authentication or relevant `authModes` instead. (Optional)
42
41
-`ignoreNullValues` - Value to reporting error when Prometheus target is lost (Values: `true`,`false`, Default: `true`, Optional)
42
+
-`queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint. (Optional)
43
43
-`unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs (Values: `true`,`false`, Default: `false`, Optional)
Copy file name to clipboardexpand all lines: content/docs/2.15/scalers/prometheus.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -17,14 +17,14 @@ triggers:
17
17
# Required fields:
18
18
serverAddress: http://<prometheus-host>:9090
19
19
query: sum(rate(http_requests_total{deployment="my-deployment"}[2m])) # Note: query must return a vector/scalar single element response
20
-
queryParameters: key-1=value-1,key-2=value-2
21
20
threshold: '100.50'
22
21
activationThreshold: '5.5'
23
22
# Optional fields:
24
23
namespace: example-namespace # for namespaced queries, eg. Thanos
25
24
cortexOrgID: my-org # DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of customHeaders and will be removed in version 2.12. Use custom headers instead to set X-Scope-OrgID header for Cortex. (see below)
26
25
customHeaders: X-Client-Id=cid,X-Tenant-Id=tid,X-Organization-Id=oid # Optional. Custom headers to include in query. In case of auth header, use the custom authentication or relevant authModes.
27
26
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
27
+
queryParameters: key-1=value-1,key-2=value-2
28
28
unsafeSsl: "false"# Default is `false`, Used for skipping certificate check when having self-signed certs for Prometheus endpoint
29
29
30
30
```
@@ -33,13 +33,13 @@ triggers:
33
33
34
34
-`serverAddress` - Address of Prometheus server. If using VictoriaMetrics cluster version, set full URL to Prometheus querying API, e.g. `http://<vmselect>:8481/select/0/prometheus`
35
35
-`query` - Query to run.
36
-
-`queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint.
37
36
-`threshold` - Value to start scaling for. (This value can be a float)
38
37
-`activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float)
39
38
-`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)
40
39
-`cortexOrgID` - DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of `customHeaders` and will be removed in version 2.12. Use `customHeaders: X-Scope-OrgID=##` instead to query multi tenant [Cortex](https://cortexmetrics.io/) or [Mimir](https://grafana.com/oss/mimir/). (Optional)
41
40
-`customHeaders` - Custom headers to include while querying the prometheus endpoint. In case of authentication headers, use custom authentication or relevant `authModes` instead. (Optional)
42
41
-`ignoreNullValues` - Value to reporting error when Prometheus target is lost (Values: `true`,`false`, Default: `true`, Optional)
42
+
-`queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint. (Optional)
43
43
-`unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs (Values: `true`,`false`, Default: `false`, Optional)
0 commit comments