cdklabs / cdk-monitoring-constructs

Easy-to-use CDK constructs for monitoring your AWS infrastructure
https://constructs.dev/packages/cdk-monitoring-constructs
Apache License 2.0
468 stars 61 forks source link

Better document what metrics the add*Alarm props are for #350

Open echeung-amzn opened 1 year ago

echeung-amzn commented 1 year ago

Feature scope

All

Describe your suggested feature

Some alarming props like addQueueMinSizeAlarm are relatively easy to understand what it's meant for, but some like addQueueMaxTimeToDrainMessagesAlarm aren't as clear since it isn't a "standard" metric.

We should try to document all of these props to clarify what exactly is being monitored/alarmed on.