Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add ignoreNullValues for AWS CloudWatch Scaler #1346

Merged
merged 10 commits into from
Aug 20, 2024
Merged

add ignoreNullValues for AWS CloudWatch Scaler #1346

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e42d3fc
add errorWhenMetricValueEmpty
robpickerill Mar 28, 2024
0879714
rename errorWhenMetricValuesEmpty -> errorWhenNullValues
robpickerill Apr 4, 2024
3e32ad8
rename errorWhenMetricValuesEmpty -> ignoreNullValues
robpickerill Apr 11, 2024
475a1d8
Merge branch 'kedacore:main' into cloudwatch-error-when-empty-metrics
robpickerill May 17, 2024
163b22c
move ignoreNullValues to 2.15
robpickerill May 17, 2024
4092fd3
Merge branch 'kedacore:main' into cloudwatch-error-when-empty-metrics
robpickerill Aug 16, 2024
6fb1ea5
remove references to aws kiam
robpickerill Aug 16, 2024
ac771f5
Merge branch 'main' into cloudwatch-error-when-empty-metrics
robpickerill Aug 20, 2024
e6a0033
move ignoreNullValues to 2.16
robpickerill Aug 20, 2024
aaee085
Merge branch 'main' into cloudwatch-error-when-empty-metrics
robpickerill Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/docs/2.16/scalers/aws-cloudwatch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ triggers:
metricName: ApproximateNumberOfMessagesVisible
targetMetricValue: "2.1"
minMetricValue: "1.5"
# Optional: ignoreNullValues
ignoreNullValues: false
# Required: region
awsRegion: "eu-west-1"
# Optional: AWS endpoint url
Expand Down Expand Up @@ -69,6 +71,10 @@ 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)
- `ignoreNullValues`- Describes the behaviour when the metric query returns no metric values in the response. If set to `true`, the scaler will scale the workload based on the `minMetricValue` provided. If set to `false`, the scaler will return an error and not adjust the scale of the workload. When set to `false` this will take precedence over `minMetricValue`. (Default: `true`, Optional)
JorTurFer marked this conversation as resolved.
Show resolved Hide resolved

> Both `minMetricValue` and `ignoreNullValues` are used to handle the case when the metric query returns no metric values in the response from AWS CloudWatch. `minMetricValue` will scale the workload based on the value provided, while `ignoreNullValues`, if false, will return an error and not adjust the scale of 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)

Expand Down