From 3bd2b370e09de8ff5b305e31daa22309598f540b Mon Sep 17 00:00:00 2001 From: Milosz Watroba Date: Thu, 16 Nov 2023 15:49:01 +0100 Subject: [PATCH] feat(alarm): add minSampleCountToEvaluateDatapoint to CustomMonitoring (#458) Fixes #452 Follow up to https://github.com/cdklabs/cdk-monitoring-constructs/pull/453: * (feat) Exposing the new `minSampleCountToEvaluateDatapoint` through CustomMonitoring * (fix) Fixing the `minSampleCountToEvaluateDatapoint` MathExpression's period as it defaults to 5 minutes. This didn't come up during testing as I tested it using 5 minute period. Apparently, if we don't set the period on MathExpression explicitly, it overrides all child metrics to 5 minute, [reference](https://github.com/aws/aws-cdk/blob/db21fefc2dc76eb4ff306fa41652ab6a6cc95e42/packages/aws-cdk-lib/aws-cloudwatch/lib/metric.ts#L606). To avoid similar situations in the future, extended the unit test to cover custom periods. --- _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_ --- API.md | 1456 ++++++++++++++++- lib/common/alarm/AlarmFactory.ts | 1 + lib/common/alarm/CustomAlarmThreshold.ts | 15 + test/common/alarm/AlarmFactory.test.ts | 8 +- .../custom/CustomMonitoring.test.ts | 1 + .../CustomMonitoring.test.ts.snap | 50 +- 6 files changed, 1465 insertions(+), 66 deletions(-) diff --git a/API.md b/API.md index a7dc7f51..592d48be 100644 --- a/API.md +++ b/API.md @@ -4055,6 +4055,7 @@ const anomalyDetectionThreshold: AnomalyDetectionThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -4256,7 +4257,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -4276,6 +4281,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -8150,6 +8174,7 @@ const availabilityThreshold: AvailabilityThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -8348,7 +8373,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -8368,6 +8397,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -9586,6 +9634,7 @@ const changeInSecretCountThreshold: ChangeInSecretCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -9787,7 +9836,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -9807,6 +9860,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -10788,6 +10860,7 @@ const consumedCapacityThreshold: ConsumedCapacityThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -10986,7 +11059,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -11006,6 +11083,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -11125,6 +11221,7 @@ const customAlarmThreshold: CustomAlarmThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -11322,7 +11419,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -11342,6 +11443,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -12683,6 +12803,7 @@ const customThreshold: CustomThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -12884,7 +13005,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -12904,6 +13029,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -13189,6 +13333,7 @@ const daysSinceUpdateThreshold: DaysSinceUpdateThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -13387,7 +13532,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -13407,6 +13556,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -13524,6 +13692,7 @@ const daysToExpiryThreshold: DaysToExpiryThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -13722,7 +13891,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -13742,6 +13915,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -14284,6 +14476,7 @@ const durationThreshold: DurationThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -14482,7 +14675,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -14502,6 +14699,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -17208,6 +17424,7 @@ const errorCountThreshold: ErrorCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -17406,7 +17623,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -17426,6 +17647,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -17543,6 +17783,7 @@ const errorRateThreshold: ErrorRateThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -17741,7 +17982,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -17761,6 +18006,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -18742,6 +19006,7 @@ const firehoseStreamLimitThreshold: FirehoseStreamLimitThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -18940,7 +19205,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -18960,6 +19229,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -19079,6 +19367,7 @@ const fullRestartCountThreshold: FullRestartCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -19277,7 +19566,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -19297,6 +19590,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -19832,6 +20144,7 @@ const healthyTaskCountThreshold: HealthyTaskCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -20030,7 +20343,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -20050,6 +20367,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -20167,6 +20503,7 @@ const healthyTaskPercentThreshold: HealthyTaskPercentThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -20365,7 +20702,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -20385,6 +20726,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -20502,6 +20862,7 @@ const highConnectionCountThreshold: HighConnectionCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -20700,7 +21061,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -20720,6 +21085,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -20837,6 +21221,7 @@ const highMessagesPublishedThreshold: HighMessagesPublishedThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -21035,7 +21420,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -21055,6 +21444,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -21172,6 +21580,7 @@ const highServerlessDatabaseCapacityThreshold: HighServerlessDatabaseCapacityThr | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -21370,7 +21779,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -21390,6 +21803,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -21507,6 +21939,7 @@ const highTpsThreshold: HighTpsThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -21705,7 +22138,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -21725,6 +22162,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -23760,6 +24216,7 @@ const latencyThreshold: LatencyThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -23958,7 +24415,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -23978,6 +24439,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -24095,6 +24575,7 @@ const logLevelCountThreshold: LogLevelCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -24293,7 +24774,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -24313,6 +24798,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -24619,6 +25123,7 @@ const lowConnectionCountThreshold: LowConnectionCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -24817,7 +25322,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -24837,6 +25346,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -24954,6 +25482,7 @@ const lowMessagesPublishedThreshold: LowMessagesPublishedThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -25152,7 +25681,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -25172,6 +25705,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -25289,6 +25841,7 @@ const lowTpsThreshold: LowTpsThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -25487,7 +26040,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -25507,6 +26064,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -25624,6 +26200,7 @@ const maxAgeThreshold: MaxAgeThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -25822,7 +26399,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -25842,6 +26423,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -25959,6 +26559,7 @@ const maxDowntimeThreshold: MaxDowntimeThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -26157,7 +26758,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -26177,6 +26782,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -26294,6 +26918,7 @@ const maxIncomingMessagesCountThreshold: MaxIncomingMessagesCountThreshold = { . | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -26492,7 +27117,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -26512,6 +27141,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -26629,6 +27277,7 @@ const maxItemsCountThreshold: MaxItemsCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -26827,7 +27476,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -26847,6 +27500,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -26964,6 +27636,7 @@ const maxIteratorAgeThreshold: MaxIteratorAgeThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -27162,7 +27835,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -27182,6 +27859,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -27299,6 +27995,7 @@ const maxMessageAgeThreshold: MaxMessageAgeThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -27497,7 +28194,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -27517,6 +28218,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -27634,6 +28354,7 @@ const maxMessageCountThreshold: MaxMessageCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -27832,7 +28553,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -27852,6 +28577,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -27969,6 +28713,7 @@ const maxSecretCountThreshold: MaxSecretCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -28167,7 +28912,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -28187,6 +28936,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -28304,6 +29072,7 @@ const maxTimeToDrainThreshold: MaxTimeToDrainThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -28502,7 +29271,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -28522,6 +29295,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -28639,6 +29431,7 @@ const maxUsedSwapMemoryThreshold: MaxUsedSwapMemoryThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -28837,7 +29630,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -28857,6 +29654,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -29086,6 +29902,7 @@ const minFreeableMemoryThreshold: MinFreeableMemoryThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -29284,7 +30101,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -29304,6 +30125,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -29421,6 +30261,7 @@ const minIncomingMessagesCountThreshold: MinIncomingMessagesCountThreshold = { . | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -29619,7 +30460,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -29639,6 +30484,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -29756,6 +30620,7 @@ const minMessageCountThreshold: MinMessageCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -29954,7 +30819,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -29974,6 +30843,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -30091,6 +30979,7 @@ const minProcessedBytesThreshold: MinProcessedBytesThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -30289,7 +31178,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -30309,6 +31202,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -30428,6 +31340,7 @@ const minRunningTaskCountThreshold: MinRunningTaskCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -30626,7 +31539,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -30646,6 +31563,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -30763,6 +31699,7 @@ const minSecretCountThreshold: MinSecretCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -30961,7 +31898,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -30981,6 +31922,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -31098,6 +32058,7 @@ const minUsageCountThreshold: MinUsageCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -31296,7 +32257,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -31316,6 +32281,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -32557,6 +33541,7 @@ const notificationsFailedThreshold: NotificationsFailedThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -32755,7 +33740,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -32775,6 +33764,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -32892,6 +33900,7 @@ const openSearchClusterAutomatedSnapshotFailureThreshold: OpenSearchClusterAutom | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -33090,7 +34099,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -33110,6 +34123,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -33227,6 +34259,7 @@ const openSearchClusterIndexWritesBlockedThreshold: OpenSearchClusterIndexWrites | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -33425,7 +34458,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -33445,6 +34482,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -34267,6 +35323,7 @@ const openSearchClusterNodesThreshold: OpenSearchClusterNodesThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -34465,7 +35522,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -34485,6 +35546,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -34602,6 +35682,7 @@ const openSearchClusterStatusCustomization: OpenSearchClusterStatusCustomization | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -34800,7 +35881,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -34820,6 +35905,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -34937,6 +36041,7 @@ const openSearchKmsKeyErrorThreshold: OpenSearchKmsKeyErrorThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -35135,7 +36240,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -35155,6 +36264,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -35272,6 +36400,7 @@ const openSearchKmsKeyInaccessibleThreshold: OpenSearchKmsKeyInaccessibleThresho | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -35470,7 +36599,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -35490,6 +36623,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -36344,6 +37496,7 @@ const recordsFailedThreshold: RecordsFailedThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -36542,7 +37695,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -36562,6 +37719,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -36679,6 +37855,7 @@ const recordsThrottledThreshold: RecordsThrottledThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -36877,7 +38054,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -36897,6 +38078,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -37407,6 +38607,7 @@ const runningTaskCountThreshold: RunningTaskCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -37605,7 +38806,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -37625,6 +38830,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -37742,6 +38966,7 @@ const runningTaskRateThreshold: RunningTaskRateThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -37940,7 +39165,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -37960,6 +39189,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -42323,6 +43571,7 @@ const throttledEventsThreshold: ThrottledEventsThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -42521,7 +43770,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -42541,6 +43794,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -42658,6 +43930,7 @@ const unhealthyTaskCountThreshold: UnhealthyTaskCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -42856,7 +44129,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -42876,6 +44153,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -42993,6 +44289,7 @@ const usageCountThreshold: UsageCountThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -43191,7 +44488,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -43211,6 +44512,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript @@ -43328,6 +44648,7 @@ const usageThreshold: UsageThreshold = { ... } | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | +| minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | @@ -43526,7 +44847,11 @@ If specified, adjusts the metric before creating an alarm from it. --- -##### `minMetricSamplesToAlarm`Optional +##### ~~`minMetricSamplesToAlarm`~~Optional + +- *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation +period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has +sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; @@ -43546,6 +44871,25 @@ This composite alarm will be returned as a result and uses the specified alarm a --- +##### `minSampleCountToEvaluateDatapoint`Optional + +```typescript +public readonly minSampleCountToEvaluateDatapoint: number; +``` + +- *Type:* number +- *Default:* default behaviour - no condition on sample count will be used + +Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + +If this property is specified, your metric will be subject to MathExpression that will add an IF condition +to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. +If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated +according to the treatMissingData parameter. +If specified, deprecated minMetricSamplesToAlarm has no effect. + +--- + ##### `overrideAnnotationColor`Optional ```typescript diff --git a/lib/common/alarm/AlarmFactory.ts b/lib/common/alarm/AlarmFactory.ts index 5c8990ff..5f450a3a 100644 --- a/lib/common/alarm/AlarmFactory.ts +++ b/lib/common/alarm/AlarmFactory.ts @@ -587,6 +587,7 @@ export class AlarmFactory { alarmMetric = new MathExpression({ label: `${adjustedMetric}`, expression: `IF(sampleCount > ${props.minSampleCountToEvaluateDatapoint}, metric)`, + period: adjustedMetric.period, usingMetrics: { metric: adjustedMetric, sampleCount: metricSampleCount, diff --git a/lib/common/alarm/CustomAlarmThreshold.ts b/lib/common/alarm/CustomAlarmThreshold.ts index 4bf83700..623db0cf 100644 --- a/lib/common/alarm/CustomAlarmThreshold.ts +++ b/lib/common/alarm/CustomAlarmThreshold.ts @@ -39,6 +39,18 @@ export interface CustomAlarmThreshold { */ readonly alarmDescriptionOverride?: string; + /** + * Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. + * If this property is specified, your metric will be subject to MathExpression that will add an IF condition + * to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. + * If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated + * according to the treatMissingData parameter. + * If specified, deprecated minMetricSamplesToAlarm has no effect. + * + * @default - default behaviour - no condition on sample count will be used + */ + readonly minSampleCountToEvaluateDatapoint?: number; + /** * Specifies how many samples (N) of the metric is needed to trigger the alarm. * If this property is specified, a composite alarm is created of the following: @@ -48,6 +60,9 @@ export interface CustomAlarmThreshold { * * This composite alarm will be returned as a result and uses the specified alarm actions. * @default - default behaviour - no condition on sample count will be added to the alarm + * @deprecated Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation + * period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has + * sufficient number of samples */ readonly minMetricSamplesToAlarm?: number; diff --git a/test/common/alarm/AlarmFactory.test.ts b/test/common/alarm/AlarmFactory.test.ts index 8357acf7..9156488b 100644 --- a/test/common/alarm/AlarmFactory.test.ts +++ b/test/common/alarm/AlarmFactory.test.ts @@ -285,6 +285,7 @@ test("addAlarm: check created alarms when minMetricSamplesToAlarm is used", () = alarmNameSuffix: "none", comparisonOperator: ComparisonOperator.LESS_THAN_THRESHOLD, minMetricSamplesToAlarm: 42, + period: Duration.minutes(15), }); const template = Template.fromStack(stack); @@ -292,6 +293,7 @@ test("addAlarm: check created alarms when minMetricSamplesToAlarm is used", () = AlarmName: "DummyServiceAlarms-prefix-none", MetricName: "DummyMetric1", Statistic: "Average", + Period: 900, }); template.hasResourceProperties("AWS::CloudWatch::Alarm", { AlarmName: "DummyServiceAlarms-prefix-none-NoSamples", @@ -304,6 +306,7 @@ test("addAlarm: check created alarms when minMetricSamplesToAlarm is used", () = Statistic: "SampleCount", Threshold: 42, TreatMissingData: "breaching", + Period: 900, }); const alarmRuleCapture = new Capture(); @@ -344,6 +347,7 @@ test("addAlarm: check created alarms when minSampleCountToEvaluateDatapoint is u comparisonOperator: ComparisonOperator.LESS_THAN_THRESHOLD, minSampleCountToEvaluateDatapoint: 42, minMetricSamplesToAlarm: 55, // not used if minSampleCountToEvaluateDatapoint defined + period: Duration.minutes(15), }); const template = Template.fromStack(stack); @@ -365,7 +369,7 @@ test("addAlarm: check created alarms when minSampleCountToEvaluateDatapoint is u Metric: Match.objectLike({ MetricName: "DummyMetric1", }), - Period: 300, + Period: 900, Stat: "Average", }, ReturnData: false, @@ -376,7 +380,7 @@ test("addAlarm: check created alarms when minSampleCountToEvaluateDatapoint is u Metric: Match.objectLike({ MetricName: "DummyMetric1", }), - Period: 300, + Period: 900, Stat: "SampleCount", }, ReturnData: false, diff --git a/test/monitoring/custom/CustomMonitoring.test.ts b/test/monitoring/custom/CustomMonitoring.test.ts index 0b8ffc46..67731c43 100644 --- a/test/monitoring/custom/CustomMonitoring.test.ts +++ b/test/monitoring/custom/CustomMonitoring.test.ts @@ -90,6 +90,7 @@ test("snapshot test", () => { Warning: { threshold: 10, comparisonOperator: ComparisonOperator.GREATER_THAN_THRESHOLD, + minSampleCountToEvaluateDatapoint: 15, }, Critical: { threshold: 50, diff --git a/test/monitoring/custom/__snapshots__/CustomMonitoring.test.ts.snap b/test/monitoring/custom/__snapshots__/CustomMonitoring.test.ts.snap index 975ebb96..2bb865d4 100644 --- a/test/monitoring/custom/__snapshots__/CustomMonitoring.test.ts.snap +++ b/test/monitoring/custom/__snapshots__/CustomMonitoring.test.ts.snap @@ -701,17 +701,51 @@ Object { "AlarmName": "Test-DummyAlarmName-AlarmForDummyMetric12-Warning", "ComparisonOperator": "GreaterThanThreshold", "DatapointsToAlarm": 3, - "Dimensions": Array [ + "EvaluationPeriods": 3, + "Metrics": Array [ Object { - "Name": "CustomDimension", - "Value": "CustomDimensionValue", + "Expression": "IF(sampleCount > 15, metric)", + "Id": "expr_1", + "Label": "DummyMetric12", + }, + Object { + "Id": "metric", + "MetricStat": Object { + "Metric": Object { + "Dimensions": Array [ + Object { + "Name": "CustomDimension", + "Value": "CustomDimensionValue", + }, + ], + "MetricName": "DummyMetric12", + "Namespace": "DummyCustomNamespace", + }, + "Period": 300, + "Stat": "Average", + }, + "ReturnData": false, + }, + Object { + "Id": "sampleCount", + "Label": "Sample count", + "MetricStat": Object { + "Metric": Object { + "Dimensions": Array [ + Object { + "Name": "CustomDimension", + "Value": "CustomDimensionValue", + }, + ], + "MetricName": "DummyMetric12", + "Namespace": "DummyCustomNamespace", + }, + "Period": 300, + "Stat": "SampleCount", + }, + "ReturnData": false, }, ], - "EvaluationPeriods": 3, - "MetricName": "DummyMetric12", - "Namespace": "DummyCustomNamespace", - "Period": 300, - "Statistic": "Average", "Threshold": 10, "TreatMissingData": "missing", },