Metadata-Version: 2.1
Name: cdk-watchful
Version: 0.2.7
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
Description: # cdk-watchful
        
        [![CircleCI](https://circleci.com/gh/eladb/cdk-watchful.svg?style=svg)](https://circleci.com/gh/eladb/cdk-watchful)
        [![python](https://img.shields.io/badge/jsii-python-blueviolet.svg)](https://pypi.org/project/cdk-watchful/)
        [![typescript](https://img.shields.io/badge/jsii-typescript-blueviolet.svg)](https://www.npmjs.com/package/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.
        
        **TypeScript:**
        
        ```ts
        import { Watchful } from 'cdk-watchful'
        
        const wf = new Watchful(this, 'watchful');
        wf.watchDynamoTable('My Cute Little Table', myTable);
        wf.watchLambdaFunction('My Function', myFunction);
        wf.watchApiGateway('My REST API', myRestApi);
        ```
        
        **Python:**
        
        ```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...
        
        ![](https://raw.githubusercontent.com/eladb/cdk-watchful/master/example/sample.png)
        
        ## Install
        
        TypeScript/JavaScript:
        
        ```console
        $ npm install cdk-watchful
        ```
        
        Python:
        
        ```console
        $ 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):
        
        **TypeScript:**
        
        ```ts
        import Watchful from 'cdk-watchful';
        
        const wf = new Watchful(this, 'watchful', {
          alarmEmail: 'your@email.com'
        });
        ```
        
        **Python:**
        
        ```python
        from cdk_watchful import Watchful
        
        wf = Watchful(self, 'watchful', alarm_email='your@amil.com')
        ```
        
        ## 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](https://github.com/eladb/cdk-watchful/issues/new)
        
        ## 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:**
        
        ```ts
        wf.watchScope(storageLayer);
        ```
        
        **Python:**
        
        ```python
        wf.watch_scope(storage_layer)
        ```
        
        
        ## Example
        
        See a more complete [example](https://github.com/eladb/cdk-watchful/blob/master/example/index.ts).
        
        ## License
        
        [Apache 2.0](https://github.com/eladb/cdk-watchful/blob/master/LICENSE)
        
        
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
