Metadata-Version: 2.1
Name: cdk-watchful
Version: 0.1.3
Summary: Watching your CDK apps since 2019
Home-page: https://github.com/eladb/cdk-watchful
Author: Elad Ben-Israel<elad.benisrael@gmail.com>
License: UNKNOWN
Project-URL: Source, https://github.com/eladb/cdk-watchful
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: jsii (~=0.13.3)
Requires-Dist: publication (>=0.0.3)
Requires-Dist: aws-cdk.aws-apigateway (~=0.36.1)
Requires-Dist: aws-cdk.aws-cloudwatch (~=0.36.1)
Requires-Dist: aws-cdk.aws-cloudwatch-actions (~=0.36.1)
Requires-Dist: aws-cdk.aws-dynamodb (~=0.36.1)
Requires-Dist: aws-cdk.aws-events (~=0.36.1)
Requires-Dist: aws-cdk.aws-events-targets (~=0.36.1)
Requires-Dist: aws-cdk.aws-lambda (~=0.36.1)
Requires-Dist: aws-cdk.aws-sns (~=0.36.1)
Requires-Dist: aws-cdk.aws-sns-subscriptions (~=0.36.1)
Requires-Dist: aws-cdk.core (~=0.36.1)

# cdk-watchful

> Watching your CDK back since 2019

Watchful is an [AWS CDK](https://github.com/awslabs/aws-cdk) construct library that makes it easy
to monitor CDK apps.

Watchful is released through [jsii](https://github.com/awslabs/jsii) to:

- npm (JavaScript/TypeScript)
- PyPI (Pyton)

Watchful can manage a nice central dashboard and automatically configure alarms for the following AWS resources:

- Amazon DynamoDB
- AWS Lambda
- ...more to come!

To get started, just define a `Watchful` construct in your CDK app (code is in
TypeScript, but python will work too):

```ts
const wf = new Watchful(this, 'watchful', {
  alarmEmail: 'your@email.com'
});
```

And then, add your resources to it:

```ts
// `table` is a dynamodb.Table construct
wf.watchDynamoTable('My Happy Little Table', table);

// `fn` is a lambda.Function construct
wf.watchLambdaFunction('The Function', fn);
```

Constructs that implement `IWatchable` can be added with:

```ts
wf.watch(watchable);
```

And they will get a chance to add themselves to the watchful dashboard.

## Example

See a more complete [example](./example/index.ts).

## License

[Apache 2.0](./LICENSE)


