-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Allow non-integral latency thresholds and durations (#587)
Fixes #586. Adds the `integral: false` option to [`Duration.toMillisecond()`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Duration.html#towbrmillisecondsopts) calls to allow the original non-integral/sub-millisecond threshold values to be provided to CloudWatch. These four lines are the only uses of `toMilliseconds` in the package. I also created a new test for the `LatencyAlarmFactory` class to test these specific cases. To verify that they were working, I ran the tests without the fix in place and got the expected error messages: [gist](https://gist.github.com/sajidanw/37fd1ddd63ff763a911bb3a1cf58b2b8). --- _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_
- Loading branch information
Showing
2 changed files
with
71 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
import { Duration, Stack } from "aws-cdk-lib"; | ||
import { Metric } from "aws-cdk-lib/aws-cloudwatch"; | ||
import { Construct } from "constructs"; | ||
|
||
import { | ||
AlarmFactory, | ||
AlarmFactoryDefaults, | ||
LatencyAlarmFactory, | ||
LatencyType, | ||
MetricFactoryDefaults, | ||
noopAction, | ||
} from "../../../lib"; | ||
|
||
const stack = new Stack(); | ||
const construct = new Construct(stack, "SampleConstruct"); | ||
|
||
const globalMetricDefaults: MetricFactoryDefaults = { | ||
namespace: "DummyNamespace", | ||
}; | ||
const globalAlarmDefaults: AlarmFactoryDefaults = { | ||
alarmNamePrefix: "DummyServiceAlarms", | ||
actionsEnabled: true, | ||
datapointsToAlarm: 6, | ||
// we do not care about alarm actions in this test | ||
action: noopAction(), | ||
}; | ||
const factory = new AlarmFactory(construct, { | ||
globalMetricDefaults, | ||
globalAlarmDefaults, | ||
localAlarmNamePrefix: "prefix", | ||
}); | ||
|
||
const metric = new Metric({ | ||
metricName: "DummyMetric1", | ||
namespace: "DummyCustomNamespace", | ||
dimensionsMap: { CustomDimension: "CustomDimensionValue" }, | ||
}); | ||
|
||
const latencyAlarmFactory = new LatencyAlarmFactory(factory); | ||
|
||
test("addLatencyAlarm: non-integral millisecond thresholds do not throw error", () => { | ||
latencyAlarmFactory.addLatencyAlarm(metric, LatencyType.P99, { | ||
maxLatency: Duration.millis(0.5), | ||
}); | ||
}); | ||
|
||
test("addIntegrationLatencyAlarm: non-integral millisecond thresholds do not throw error", () => { | ||
latencyAlarmFactory.addIntegrationLatencyAlarm(metric, LatencyType.P99, { | ||
maxLatency: Duration.millis(2.5), | ||
}); | ||
}); | ||
|
||
test("addDurationAlarm: non-integral millisecond durations do not throw error", () => { | ||
latencyAlarmFactory.addDurationAlarm(metric, LatencyType.P99, { | ||
maxDuration: Duration.millis(0.5), | ||
}); | ||
}); | ||
|
||
test("addJvmGarbageCollectionDurationAlarm: non-integral millisecond durations do not throw error", () => { | ||
latencyAlarmFactory.addJvmGarbageCollectionDurationAlarm( | ||
metric, | ||
LatencyType.P99, | ||
{ | ||
maxDuration: Duration.millis(2.5), | ||
}, | ||
); | ||
}); |