Watching your CDK apps since 2019
Project description
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.
TypeScript:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from cdk_watchful import Watchful
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)
Python:
from cdk_watchful import Watchful
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...
Install
TypeScript/JavaScript:
$ npm install cdk-watchful
Python:
$ pip install cdk-watchful
Initialize
To get started, just define a Watchful
construct in your CDK app (code is in
TypeScript, but python will work too). You can initialize using an email address, SQS arn or both:
TypeScript:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from cdk_watchful import Watchful
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
)
Python:
from cdk_watchful import Watchful
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@amil.com',
alarm_sqs=alarm_sqs,
alarm_sns=alarm_sns
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.
TypeScript:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
wf.watch_scope(storage_layer)
Python:
wf.watch_scope(storage_layer)
API Reference
See API.md.
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
Release new versions:
yarn bump
And then publish as a PR.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cdk_watchful-0.5.111-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2fb0f1408eb9cb3f56a40440676acecf9f0d404d3e5f363af7f3c7c2a7d2f10 |
|
MD5 | fd27d0b6d9fe1ea6050366872e616c4a |
|
BLAKE2b-256 | ad169258b0ababaffd0e6b86ca5f2df059ba68a5c63a5e34f6df41c936b7ee95 |