Skip to content

Commit e400212

Browse files
author
Eugene Cheung
committed
chore(sqs): note that incoming messages alarm does not capture messages sent to DLQ due to failed processing attempts (#117)
Closes #109 --- _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_ (cherry picked from commit 34be26f)
1 parent 1afd0c2 commit e400212

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

API.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7101,7 +7101,7 @@ const baseDlqAlarms: BaseDlqAlarms = { ... }
71017101

71027102
| **Name** | **Type** | **Description** |
71037103
| --- | --- | --- |
7104-
| <code><a href="#cdk-monitoring-constructs.BaseDlqAlarms.property.addDeadLetterQueueMaxIncomingMessagesAlarm">addDeadLetterQueueMaxIncomingMessagesAlarm</a></code> | <code>{[ key: string ]: <a href="#cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold">MaxIncomingMessagesCountThreshold</a>}</code> | *No description.* |
7104+
| <code><a href="#cdk-monitoring-constructs.BaseDlqAlarms.property.addDeadLetterQueueMaxIncomingMessagesAlarm">addDeadLetterQueueMaxIncomingMessagesAlarm</a></code> | <code>{[ key: string ]: <a href="#cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold">MaxIncomingMessagesCountThreshold</a>}</code> | Alarm on the number of messages added to a queue. |
71057105
| <code><a href="#cdk-monitoring-constructs.BaseDlqAlarms.property.addDeadLetterQueueMaxMessageAgeAlarm">addDeadLetterQueueMaxMessageAgeAlarm</a></code> | <code>{[ key: string ]: <a href="#cdk-monitoring-constructs.MaxMessageAgeThreshold">MaxMessageAgeThreshold</a>}</code> | *No description.* |
71067106
| <code><a href="#cdk-monitoring-constructs.BaseDlqAlarms.property.addDeadLetterQueueMaxSizeAlarm">addDeadLetterQueueMaxSizeAlarm</a></code> | <code>{[ key: string ]: <a href="#cdk-monitoring-constructs.MaxMessageCountThreshold">MaxMessageCountThreshold</a>}</code> | *No description.* |
71077107

@@ -7115,6 +7115,13 @@ public readonly addDeadLetterQueueMaxIncomingMessagesAlarm: {[ key: string ]: Ma
71157115

71167116
- *Type:* {[ key: string ]: <a href="#cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold">MaxIncomingMessagesCountThreshold</a>}
71177117

7118+
Alarm on the number of messages added to a queue.
7119+
7120+
Note that this corresponds with the NumberOfMessagesSent metric, which does not capture messages sent to the DLQ
7121+
as a result of a failed processing attempt.
7122+
7123+
> [https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html#sqs-dlq-number-of-messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html#sqs-dlq-number-of-messages)
7124+
71187125
---
71197126

71207127
##### `addDeadLetterQueueMaxMessageAgeAlarm`<sup>Optional</sup> <a name="addDeadLetterQueueMaxMessageAgeAlarm" id="cdk-monitoring-constructs.BaseDlqAlarms.property.addDeadLetterQueueMaxMessageAgeAlarm"></a>
@@ -30993,7 +31000,7 @@ const sqsQueueMonitoringWithDlqProps: SqsQueueMonitoringWithDlqProps = { ... }
3099331000
| <code><a href="#cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps.property.addToDetailDashboard">addToDetailDashboard</a></code> | <code>boolean</code> | Flag indicating if the widgets should be added to detailed dashboard. |
3099431001
| <code><a href="#cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps.property.addToSummaryDashboard">addToSummaryDashboard</a></code> | <code>boolean</code> | Flag indicating if the widgets should be added to summary dashboard. |
3099531002
| <code><a href="#cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps.property.useCreatedAlarms">useCreatedAlarms</a></code> | <code><a href="#cdk-monitoring-constructs.IAlarmConsumer">IAlarmConsumer</a></code> | Calls provided function to process all alarms created. |
30996-
| <code><a href="#cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps.property.addDeadLetterQueueMaxIncomingMessagesAlarm">addDeadLetterQueueMaxIncomingMessagesAlarm</a></code> | <code>{[ key: string ]: <a href="#cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold">MaxIncomingMessagesCountThreshold</a>}</code> | *No description.* |
31003+
| <code><a href="#cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps.property.addDeadLetterQueueMaxIncomingMessagesAlarm">addDeadLetterQueueMaxIncomingMessagesAlarm</a></code> | <code>{[ key: string ]: <a href="#cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold">MaxIncomingMessagesCountThreshold</a>}</code> | Alarm on the number of messages added to a queue. |
3099731004
| <code><a href="#cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps.property.addDeadLetterQueueMaxMessageAgeAlarm">addDeadLetterQueueMaxMessageAgeAlarm</a></code> | <code>{[ key: string ]: <a href="#cdk-monitoring-constructs.MaxMessageAgeThreshold">MaxMessageAgeThreshold</a>}</code> | *No description.* |
3099831005
| <code><a href="#cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps.property.addDeadLetterQueueMaxSizeAlarm">addDeadLetterQueueMaxSizeAlarm</a></code> | <code>{[ key: string ]: <a href="#cdk-monitoring-constructs.MaxMessageCountThreshold">MaxMessageCountThreshold</a>}</code> | *No description.* |
3099931006
| <code><a href="#cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps.property.deadLetterQueue">deadLetterQueue</a></code> | <code>monocdk.aws_sqs.IQueue</code> | *No description.* |
@@ -31177,6 +31184,13 @@ public readonly addDeadLetterQueueMaxIncomingMessagesAlarm: {[ key: string ]: Ma
3117731184

3117831185
- *Type:* {[ key: string ]: <a href="#cdk-monitoring-constructs.MaxIncomingMessagesCountThreshold">MaxIncomingMessagesCountThreshold</a>}
3117931186

31187+
Alarm on the number of messages added to a queue.
31188+
31189+
Note that this corresponds with the NumberOfMessagesSent metric, which does not capture messages sent to the DLQ
31190+
as a result of a failed processing attempt.
31191+
31192+
> [https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html#sqs-dlq-number-of-messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html#sqs-dlq-number-of-messages)
31193+
3118031194
---
3118131195

3118231196
##### `addDeadLetterQueueMaxMessageAgeAlarm`<sup>Optional</sup> <a name="addDeadLetterQueueMaxMessageAgeAlarm" id="cdk-monitoring-constructs.SqsQueueMonitoringWithDlqProps.property.addDeadLetterQueueMaxMessageAgeAlarm"></a>

lib/monitoring/aws-sqs/SqsQueueMonitoringWithDlq.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,20 @@ export interface BaseDlqAlarms {
3333
string,
3434
MaxMessageCountThreshold
3535
>;
36+
3637
readonly addDeadLetterQueueMaxMessageAgeAlarm?: Record<
3738
string,
3839
MaxMessageAgeThreshold
3940
>;
41+
42+
/**
43+
* Alarm on the number of messages added to a queue.
44+
*
45+
* Note that this corresponds with the NumberOfMessagesSent metric, which does not capture messages sent to the DLQ
46+
* as a result of a failed processing attempt.
47+
*
48+
* @see https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html#sqs-dlq-number-of-messages
49+
*/
4050
readonly addDeadLetterQueueMaxIncomingMessagesAlarm?: Record<
4151
string,
4252
MaxIncomingMessagesCountThreshold
@@ -47,6 +57,7 @@ export interface SqsQueueMonitoringWithDlqProps
4757
extends SqsQueueMonitoringProps,
4858
BaseDlqAlarms {
4959
readonly deadLetterQueue: IQueue;
60+
5061
/**
5162
* Indicates whether the DLQ monitoring should be added to summary dashboard.
5263
*

0 commit comments

Comments
 (0)