✨ Have you heard of cdk-monitoring-constructs? ✨
Watchful on steroids. Check it out! 🔝
cdk-watchful
Watching your CDK back since 2019
Watchful is an AWS CDK construct library that makes it easy to monitor CDK apps. It automatically synthesizes alarms and dashboards for supported AWS resources.
# my_table: dynamodb.Table
# my_function: lambda.Function
# my_rest_api: apigw.RestApi
wf = Watchful(self, "watchful")
wf.watch_dynamo_table("My Cute Little Table", my_table)
wf.watch_lambda_function("My Function", my_function)
wf.watch_api_gateway("My REST API", my_rest_api)
And...
Initialize
To get started, just define a Watchful construct in your CDK app.
You can initialize using an email address, SQS ARN or both:
import aws_cdk.aws_sns as sns
import aws_cdk.aws_sqs as sqs
alarm_sqs = sqs.Queue.from_queue_arn(self, "AlarmQueue", "arn:aws:sqs:us-east-1:444455556666:alarm-queue")
alarm_sns = sns.Topic.from_topic_arn(self, "AlarmTopic", "arn:aws:sns:us-east-2:444455556666:MyTopic")
wf = Watchful(self, "watchful",
alarm_email="your@email.com",
alarm_sqs=alarm_sqs,
alarm_sns=alarm_sns,
alarm_action_arns=["arn:aws:sqs:us-east-1:444455556666:alarm-queue"]
)
Add Resources
Watchful manages a central dashboard and configures default alarming for:
- Amazon DynamoDB:
watchful.watchDynamoTable - AWS Lambda:
watchful.watchLambdaFunction - Amazon API Gateway:
watchful.watchApiGateway - Request yours
Watching Scopes
Watchful can also watch complete CDK construct scopes. It will automatically discover all watchable resources within that scope (recursively), add them to your dashboard and configure alarms for them.
# storage_layer: Stack
# wf: Watchful
wf.watch_scope(storage_layer)
Example
See a more complete example.
Contributing
Contributions of all kinds are welcome and celebrated. Raise an issue, submit a PR, do the right thing.
To set up a dev environment:
- Clone this repo
yarn
Development workflow (change code and run tests automatically):
yarn test:watch
Build (like CI):
yarn build
And then publish as a PR.
License
2 maintainers
Metadata
2 maintainers
Release files for cdk-watchful 0.6.458
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cdk-watchful-0.6.458.tar.gz | 196.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cdk_watchful-0.6.458-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 392.1 kB
Release files / cdk-watchful-0.6.458.tar.gz
| Download URL | cdk-watchful-0.6.458.tar.gz |
|---|---|
| Size | 196.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
98b920701e1ccb715c36c3d05d91e06f8812f26c6bce287060ecdedac13357fd
|
|
BLAKE2b-256 checksum How to use checksums |
7402490d04e0790960c22b4023c265c27dcf3c0cf3130950338dc253f5ed44fb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.0
|
Release files / cdk_watchful-0.6.458-py3-none-any.whl
| Download URL | cdk_watchful-0.6.458-py3-none-any.whl |
|---|---|
| Size | 195.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
28ce530e2ec71235c4f497a8143d9eac8f40543ca203266677c9cb97308ce8bd
|
|
BLAKE2b-256 checksum How to use checksums |
7ab4e1cda1df30a05dff8f9d40c30152b1d3d2a16b3cde0810db78708c3a09f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.0
|
