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

Support modern extended statistics for CloudWatch metric alarm #22942

Merged
merged 3 commits into from
Mar 1, 2022
Merged

Support modern extended statistics for CloudWatch metric alarm #22942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee3aa66
Support modern extended statistics for CloudWatch metric alarm
EpicWink Feb 4, 2022
da69790
Add CHANGELOG entry.
ewbankkit Mar 1, 2022
dbbdcaf
r/aws_cloudwatch_metric_alarm: Move `ExpectError` tests cases above s…
ewbankkit Mar 1, 2022
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
3 changes: 3 additions & 0 deletions .changelog/22942.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:enhancement
resource/aws_cloudwatch_metric_alarm: Additional allowed values for `extended_statistic` and `metric_query.metric.stat` arguments
```
12 changes: 10 additions & 2 deletions internal/service/cloudwatch/metric_alarm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,11 @@ func ResourceMetricAlarm() *schema.Resource {
Required: true,
ValidateFunc: validation.Any(
validation.StringInSlice(cloudwatch.Statistic_Values(), false),
validation.StringMatch(regexp.MustCompile(`p(\d{1,2}(\.\d{0,2})?|100)`), "must specify a value between p0.0 and p100"),
validation.StringMatch(
// doesn't catch: PR with %-values provided, TM/WM/PR/TC/TS with no values provided
regexp.MustCompile(`^((p|(tm)|(wm)|(tc)|(ts))((\d{1,2}(\.\d{1,2})?)|(100))|(IQM)|(((TM)|(WM)|(PR)|(TC)|(TS)))\((\d+(\.\d+)?%?)?:(\d+(\.\d+)?%?)?\))$`),
"invalid statistic, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html",
),
),
},
"unit": {
Expand Down Expand Up @@ -235,7 +239,11 @@ func ResourceMetricAlarm() *schema.Resource {
Type: schema.TypeString,
Optional: true,
ConflictsWith: []string{"statistic", "metric_query"},
ValidateFunc: validation.StringMatch(regexp.MustCompile(`p(\d{1,2}(\.\d{0,2})?|100)`), "must specify a value between p0.0 and p100"),
ValidateFunc: validation.StringMatch(
// doesn't catch: PR with %-values provided, TM/WM/PR/TC/TS with no values provided
regexp.MustCompile(`^((p|(tm)|(wm)|(tc)|(ts))((\d{1,2}(\.\d{1,2})?)|(100))|(IQM)|(((TM)|(WM)|(PR)|(TC)|(TS)))\((\d+(\.\d+)?%?)?:(\d+(\.\d+)?%?)?\))$`),
"invalid statistic, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html",
),
},
"treat_missing_data": {
Type: schema.TypeString,
Expand Down
138 changes: 134 additions & 4 deletions internal/service/cloudwatch/metric_alarm_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,12 +262,142 @@ func TestAccCloudWatchMetricAlarm_extendedStatistic(t *testing.T) {
CheckDestroy: testAccCheckMetricAlarmDestroy,
Steps: []resource.TestStep{
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName),
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "IQM(1:2)"), // IQM accepts no args
ExpectError: regexp.MustCompile(`invalid statistic, see: https:\/\/docs\.aws\.amazon\.com\/.*`),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "iqm10"), // IQM accepts no args
ExpectError: regexp.MustCompile(`invalid statistic, see: https:\/\/docs\.aws\.amazon\.com\/.*`),
},
// { TODO: more complex regex to reject this
// Config: testAccMetricAlarmExtendedStatisticConfig(rName, "PR(5%:10%)"), // PR args must be absolute
// ExpectError: regexp.MustCompile(`invalid statistic, see: https:\/\/docs\.aws\.amazon\.com\/.*`),
// },
// { TODO: more complex regex to reject this
// Config: testAccMetricAlarmExtendedStatisticConfig(rName, "TC(:)"), // at least one arg must be provided
// ExpectError: regexp.MustCompile(`invalid statistic, see: https:\/\/docs\.aws\.amazon\.com\/.*`),
// },
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "WM"), // missing syntax
ExpectError: regexp.MustCompile(`invalid statistic, see: https:\/\/docs\.aws\.amazon\.com\/.*`),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "p"), // missing arg
ExpectError: regexp.MustCompile(`invalid statistic, see: https:\/\/docs\.aws\.amazon\.com\/.*`),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "AB(1:2)"), // unknown stat 'AB'
ExpectError: regexp.MustCompile(`invalid statistic, see: https:\/\/docs\.aws\.amazon\.com\/.*`),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "cd42"), // unknown stat 'cd'
ExpectError: regexp.MustCompile(`invalid statistic, see: https:\/\/docs\.aws\.amazon\.com\/.*`),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "p88.0"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "p88.0"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "p0.0"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "p0.0"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "p100"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "p100"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "p95"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "p95"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "tm90"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "tm90"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "TM(2%:98%)"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "TM(2%:98%)"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "TM(150:1000)"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "TM(150:1000)"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "IQM"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "IQM"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "wm98"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "wm98"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "PR(:300)"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "PR(:300)"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "PR(100:2000)"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "PR(100:2000)"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "tc90"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "tc90"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "TC(0.005:0.030)"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "TC(0.005:0.030)"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "TS(80%:)"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "TS(80%:)"),
),
},
{
Config: testAccMetricAlarmExtendedStatisticConfig(rName, "TC(:0.5)"),
Check: resource.ComposeTestCheckFunc(
testAccCheckCloudWatchMetricAlarmExists(resourceName, &alarm),
resource.TestCheckResourceAttr(resourceName, "extended_statistic", "TC(:0.5)"),
),
},
},
})
}
Expand Down Expand Up @@ -614,7 +744,7 @@ resource "aws_cloudwatch_metric_alarm" "test" {
`, rName)
}

func testAccMetricAlarmExtendedStatisticConfig(rName string) string {
func testAccMetricAlarmExtendedStatisticConfig(rName string, stat string) string {
return fmt.Sprintf(`
resource "aws_cloudwatch_metric_alarm" "test" {
alarm_name = "%s"
Expand All @@ -623,7 +753,7 @@ resource "aws_cloudwatch_metric_alarm" "test" {
metric_name = "CPUUtilization"
namespace = "AWS/EC2"
period = "120"
extended_statistic = "p88.0"
extended_statistic = "%s"
threshold = "80"
alarm_description = "This metric monitors ec2 cpu utilization"
insufficient_data_actions = []
Expand All @@ -632,7 +762,7 @@ resource "aws_cloudwatch_metric_alarm" "test" {
InstanceId = "i-abc123"
}
}
`, rName)
`, rName, stat)
}

func testAccMetricAlarmMissingStatisticConfig(rName string) string {
Expand Down