From b890a2d81de0234c208f7827bef673014a600f4b Mon Sep 17 00:00:00 2001 From: Rob Pickerill Date: Thu, 4 Apr 2024 20:13:23 +0100 Subject: [PATCH] rename errorWhenMetricValuesEmpty -> errorWhenNullValues Signed-off-by: Rob Pickerill --- content/docs/2.14/scalers/aws-cloudwatch.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/content/docs/2.14/scalers/aws-cloudwatch.md b/content/docs/2.14/scalers/aws-cloudwatch.md index a68657644..4b6d4991c 100644 --- a/content/docs/2.14/scalers/aws-cloudwatch.md +++ b/content/docs/2.14/scalers/aws-cloudwatch.md @@ -37,7 +37,7 @@ triggers: # Optional: AWS Secret Access Key, can use TriggerAuthentication as well awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod - identityOwner: pod | operator + identityOwner: pod | operator # Optional: Collection Time metricCollectionTime: "300" # default 300 # Optional: Metric Statistic @@ -69,8 +69,11 @@ triggers: - `metricUnit` - Which unit to be used by the query. Used to define **Unit** ([official documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Unit)). (Default: `none`, Optional) - `metricEndTimeOffset` - How long in seconds to offset the **EndTime** ([official documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)). Due to the eventual consistency model which is used by Cloudwatch, the latest datapoint one can get from Cloudwatch might not be accurate. The `metricEndTimeOffset` config provides a way to skip the most recent datapoint if needed. (Default: `0`, Optional) - `minMetricValue`- Returned value in case of empty response from cloudwatch. (Default: 0, This value can be a float) -- `errorWhenMetricValuesEmpty`- If set to `true`, the scaler will return an error when the metric query is empty. This is to avoid any scaling activity if +- `errorWhenNullValues`- If set to `true`, the scaler will return an error when the metric query is empty. This is to avoid any scaling activity if no metrics are available in the query window, as opposed to scaling the workload based on the minMetricValue above. If set to `true`, takes precedence over `minMetricValue`. (Default: `false`, Optional) + +> Both `minMetricValue` and `errorWhenNullValues` are used to handle the case when the metric query returns no metric values in the response. `minMetricValue` will scale the workload based on the value provided, while `errorWhenNullValues` will return an error and not scale the workload. + - `targetMetricValue`- Target value for the metric. (Default: 0, This value can be a float) - `activationTargetMetricValue`- 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)