Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@stlasalle/cdk-datadog-resources
Advanced tools
@stlasalle/cdk-datadog-resources - npm Package Compare versions
Comparing version 0.0.0 to 0.0.1
@@ -77,3 +77,3 @@ { | ||
| }, | ||
| "version": "0.0.0", | ||
| "version": "0.0.1", | ||
| "jest": { | ||
@@ -80,0 +80,0 @@ "testMatch": [ |
137
README.md
| # AWS CDK Datadog Resources | ||
| [](https://badge.fury.io/js/%40nomadblacky%2Fcdk-datadog-resources) | ||
| This is a fork of [@nomadblacky/cdk-datadog-resources](https://www.npmjs.com/package/@nomadblacky/cdk-datadog-resources) that updates CDK to `1.117.0` for use with the linktree CDK construct library. | ||
| An AWS CDK construct library that wrapped [DataDog/datadog-cloudformation-resources](https://github.com/DataDog/datadog-cloudformation-resources). | ||
| It's intended for development purposes - until @nomadblacky updates their package to update CDK, or linktree rolls it into it's internal CDK construct library. | ||
| ## Requirements | ||
| Before use this library, [register datadog-cloudformation-resources to your AWS account.](https://github.com/DataDog/datadog-cloudformation-resources#datadog-aws-cloudformation) | ||
| You need to register the correct version listed in `Supported Resources`. | ||
| ## Supported CDK Languages | ||
| - TypeScript | ||
| - Python | ||
| - ~~Java~~ Sorry, there is a problem with the release. ([#22](https://github.com/NomadBlacky/cdk-datadog-resources/issues/22)) | ||
| ## Supported Resources | ||
| | Supported? | Resource | Datadog CF Resource Name | Description | Datadog CF Version | | ||
| | :--------: | ----------------------- | -------------------------------- | -------------------------------------------------------- | ------------------ | | ||
| | ✅ | Dashboards | `Datadog::Dashboards::Dashboard` | [Create, update, and delete Datadog dashboards.][1] | [1.0.0][7] | | ||
| | | Datadog-AWS integration | `Datadog::Integrations::AWS` | [Manage your Datadog-Amazon Web Service integration.][2] | N/A | | ||
| | ✅ | Monitors | `Datadog::Monitors::Monitor` | [Create, update, and delete Datadog monitors.][3] | [3.0.0][6] | | ||
| | ✅ | Downtimes | `Datadog::Monitors::Downtime` | [Enable or disable downtimes for your monitors.][4] | [2.0.0][8] | | ||
| | ✅ | Users | `Datadog::IAM::User` | [Create and manage Datadog users.][5] | [1.2.0][9] | | ||
| [1]: https://github.com/DataDog/datadog-cloudformation-resources/tree/master/datadog-dashboards-dashboard-handler | ||
| [2]: https://github.com/DataDog/datadog-cloudformation-resources/tree/master/datadog-integrations-aws-handler | ||
| [3]: https://github.com/DataDog/datadog-cloudformation-resources/tree/master/datadog-monitors-monitor-handler | ||
| [4]: https://github.com/DataDog/datadog-cloudformation-resources/tree/master/datadog-monitors-downtime-handler | ||
| [5]: https://github.com/DataDog/datadog-cloudformation-resources/tree/master/datadog-iam-user-handler | ||
| [6]: https://github.com/DataDog/datadog-cloudformation-resources/blob/master/datadog-monitors-monitor-handler/CHANGELOG.md#300--2021-02-16 | ||
| [7]: https://github.com/DataDog/datadog-cloudformation-resources/blob/master/datadog-dashboards-dashboard-handler/CHANGELOG.md#100--2021-02-16 | ||
| [8]: https://github.com/DataDog/datadog-cloudformation-resources/blob/master/datadog-monitors-downtime-handler/CHANGELOG.md#200--2021-02-16 | ||
| [9]: https://github.com/DataDog/datadog-cloudformation-resources/blob/master/datadog-iam-user-handler/CHANGELOG.md#120--2021-02-16 | ||
| ## Installation | ||
| TypeScript | ||
| ```shell | ||
| npm install @nomadblacky/cdk-datadog-resources | ||
| ``` | ||
| Python | ||
| ```shell | ||
| pip install cdk-datadog-resources | ||
| ``` | ||
| Java | ||
| ```xml | ||
| <dependency> | ||
| <groupId>dev.nomadblacky</groupId> | ||
| <artifactId>cdk-datadog-resources</artifactId> | ||
| <version>x.y.z</version> | ||
| </dependency> | ||
| ``` | ||
| ## Usage | ||
| Belows are examples of TypeScript. | ||
| ### Dashboards | ||
| ```typescript | ||
| import * as fs from 'fs'; | ||
| import { DatadogDashboard } from '@nomadblacky/cdk-datadog-resources'; | ||
| new DatadogDashboard(yourStack, 'TestDashboard', { | ||
| datadogCredentials: { | ||
| apiKey: process.env.DATADOG_API_KEY!, | ||
| applicationKey: process.env.DATADOG_APP_KEY!, | ||
| }, | ||
| dashboardDefinition: fs.readFileSync(`${__dirname}/path/to/your/dashboard-definition.json`).toString(), | ||
| }); | ||
| ``` | ||
| ### Monitors | ||
| ```typescript | ||
| import { DatadogMonitor } from '@nomadblacky/cdk-datadog-resources'; | ||
| new DatadogMonitor(yourStack, 'TestMonitor', { | ||
| datadogCredentials: { | ||
| apiKey: process.env.DATADOG_API_KEY!, | ||
| applicationKey: process.env.DATADOG_APP_KEY!, | ||
| }, | ||
| query: 'avg(last_1h):sum:system.cpu.system{host:host0} > 100', | ||
| type: MonitorType.QueryAlert, | ||
| name: 'Test Monitor', | ||
| options: { | ||
| thresholds: { | ||
| critical: 100, | ||
| warning: 80, | ||
| oK: 90, | ||
| }, | ||
| notifyNoData: true, | ||
| evaluationDelay: 60, | ||
| }, | ||
| }); | ||
| ``` | ||
| ### Downtimes | ||
| ```typescript | ||
| import { DatadogDowntime } from '@nomadblacky/cdk-datadog-resources'; | ||
| new DatadogDowntime(stack, 'TestMonitor', { | ||
| datadogCredentials: { | ||
| apiKey: 'DATADOG_API_KEY', | ||
| applicationKey: 'DATADOG_APP_KEY', | ||
| }, | ||
| scope: ['host:myserver', 'service:myservice'], | ||
| start: 1624542715, | ||
| end: 1624546321, | ||
| }); | ||
| ``` | ||
| ### Users | ||
| ```typescript | ||
| import { DatadogIAMUser } from '@nomadblacky/cdk-datadog-resources'; | ||
| new DatadogIAMUser(stack, 'TestUser', { | ||
| datadogCredentials: { | ||
| apiKey: 'DATADOG_API_KEY', | ||
| applicationKey: 'DATADOG_APP_KEY', | ||
| }, | ||
| email: 'jane.doe@example.com', | ||
| name: 'name_example', | ||
| handle: 'title_example', | ||
| disabled: false, | ||
| }); | ||
| ``` | ||
| For now - please refer to @nomadblackys' readme for instructions for use. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-5.84%
73085
- Number of lines in readme file
- decreased by-94.96%
7
No dependency changes