# cdk-watchful
![Release](https://github.com/eladb/cdk-watchful/workflows/Release/badge.svg)
[![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:**
```python
# 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:**
```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). You can initialize using an email address, SQS arn or both:
**TypeScript:**
```python
# 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="[email protected]",
alarm_sqs=alarm_sqs,
alarm_sns=alarm_sns
)
```
**Python:**
```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='[email protected]',
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](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:**
```python
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
wf.watch_scope(storage_layer)
```
**Python:**
```python
wf.watch_scope(storage_layer)
```
## API Reference
See [API.md](./API.md).
## Example
See a more complete [example](https://github.com/eladb/cdk-watchful/blob/master/example/index.ts).
## 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:
1. Clone repo
2. `yarn install`
Development workflow (change code and run tests automatically):
```shell
yarn test:watch
```
Build (like CI):
```shell
yarn build
```
Release new versions:
```shell
yarn bump
```
And then publish as a PR.
## License
[Apache 2.0](https://github.com/eladb/cdk-watchful/blob/master/LICENSE)
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
共15个文件
txt:4个
py:3个
pkg-info:2个
资源分类:Python库 所属语言:Python 资源全名:cdk-watchful-0.5.19.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
资源推荐
资源详情
资源评论
收起资源包目录
cdk-watchful-0.5.19.tar.gz (15个子文件)
cdk-watchful-0.5.19
MANIFEST.in 23B
PKG-INFO 6KB
pyproject.toml 102B
src
cdk_watchful.egg-info
PKG-INFO 6KB
requires.txt 618B
SOURCES.txt 386B
top_level.txt 13B
dependency_links.txt 1B
cdk_watchful
setup.cfg 38B
setup.py 2KB
README.md 4KB
共 15 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功