@rio-cloud/cdk-v2-constructs 4.13.2 → 4.14.0

package/lib/watchfulv2/watchful.d.ts

@@ -0,0 +1,53 @@
+import { Construct } from 'constructs';
+import { INotification } from '../datadogv2';
+import { MetricAlarmProps, AbstractWatchful } from '../watchful';
+import { LogAlarmProps } from './datadog-log-alarm';
+/**
+ * Properties for defining Watchful
+ */
+export interface WatchfulProps {
+    /**
+     * The service name.
+     *
+     * @defaultValue The stack name.
+     */
+    readonly serviceName?: string;
+    /**
+     * Set the way how monitors should notify in case of an alert.
+     *
+     * @defaultValue {@link DefaultSlackNotification}
+     */
+    readonly notification?: INotification;
+}
+/**
+ * A construct to watch given scope or resources. Opinionated DataDog alarms are automatically created for watched resources.
+ *
+ * Usage with non-default notification:
+ * ```ts
+ * const dw = new watchfulv2.Watchful(this, 'Watchful', {
+ *   serviceName: props.serviceName,
+ *   notification: new datadogv2.SlackNotification({channel: 'team-alert-channel'})
+ * });
+ * dw.watchScope(this);
+ *```
+ */
+export declare class Watchful extends AbstractWatchful {
+    private readonly notification;
+    private readonly serviceName;
+    constructor(scope: Construct, id: string, props?: WatchfulProps);
+    /**
+     * Adds the alarmTopic as alarm action to the given alarm.
+     *
+     * @param alarm - The watchful to add those resources to
+     */
+    createAlarm(scope: Construct, id: string, alarm: MetricAlarmProps): void;
+    /**
+     * Adds an alert for error logs
+     * @param scope
+     */
+    createLogAlarm(scope: Construct, id: string, alarm: LogAlarmProps): void;
+    /**
+     * Watches the given scope and adds alarms for known resources.
+     */
+    watchScope(scope: Construct): void;
+}

package/lib/watchfulv2/watchful.js

@@ -0,0 +1,76 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Watchful = void 0;
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const datadogv2_1 = require("../datadogv2");
+const watchful_1 = require("../watchful");
+const datadog_log_alarm_1 = require("./datadog-log-alarm");
+const datadog_metric_alarm_1 = require("./datadog-metric-alarm");
+/**
+ * A construct to watch given scope or resources. Opinionated DataDog alarms are automatically created for watched resources.
+ *
+ * Usage with non-default notification:
+ * ```ts
+ * const dw = new watchfulv2.Watchful(this, 'Watchful', {
+ *   serviceName: props.serviceName,
+ *   notification: new datadogv2.SlackNotification({channel: 'team-alert-channel'})
+ * });
+ * dw.watchScope(this);
+ *```
+ */
+class Watchful extends watchful_1.AbstractWatchful {
+    constructor(scope, id, props = {}) {
+        super(scope, id);
+        this.serviceName = props.serviceName ?? aws_cdk_lib_1.Stack.of(this).stackName;
+        this.notification = props.notification ?? new datadogv2_1.DefaultSlackNotification();
+    }
+    /**
+     * Adds the alarmTopic as alarm action to the given alarm.
+     *
+     * @param alarm - The watchful to add those resources to
+     */
+    createAlarm(scope, id, alarm) {
+        new datadog_metric_alarm_1.DataDogMetricAlarm(scope, id, {
+            serviceName: this.serviceName,
+            notification: this.notification,
+            alarmDescription: alarm.alarmDescription,
+            comparisonOperator: alarm.comparisonOperator,
+            evaluationPeriods: alarm.evaluationPeriods,
+            metric: alarm.metric,
+            threshold: alarm.threshold,
+            treatMissingData: alarm.treatMissingData,
+        });
+    }
+    /**
+     * Adds an alert for error logs
+     * @param scope
+     */
+    createLogAlarm(scope, id, alarm) {
+        new datadog_log_alarm_1.DataDogLogAlarm(scope, id, {
+            serviceName: alarm.lambdaCloudwatchGroupName ?? this.serviceName,
+            autoCloseOpsGenieAlerts: alarm.autoCloseOpsGenieAlerts,
+            period: alarm.period,
+            unitOfPeriod: alarm.unitOfPeriod,
+            periodOperator: alarm.periodOperator,
+            statistic: alarm.statistic,
+            queryFilters: alarm.queryFilters,
+            alarmDescription: alarm.alarmDescription,
+            threshold: alarm.threshold,
+            priority: alarm.priority,
+            index: alarm.index,
+        });
+    }
+    /**
+     * Watches the given scope and adds alarms for known resources.
+     */
+    watchScope(scope) {
+        const aspect = new watchful_1.WatchfulAspect(this);
+        aws_cdk_lib_1.Aspects.of(scope).add(aspect);
+    }
+}
+exports.Watchful = Watchful;
+_a = JSII_RTTI_SYMBOL_1;
+Watchful[_a] = { fqn: "@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful", version: "0.0.0" };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2F0Y2hmdWwuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvd2F0Y2hmdWx2Mi93YXRjaGZ1bC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLDZDQUE2QztBQUU3Qyw0Q0FBdUU7QUFDdkUsMENBQWlGO0FBQ2pGLDJEQUFxRTtBQUNyRSxpRUFBNEQ7QUFxQjVEOzs7Ozs7Ozs7OztHQVdHO0FBQ0gsTUFBYSxRQUFTLFNBQVEsMkJBQWdCO0lBSTVDLFlBQVksS0FBZ0IsRUFBRSxFQUFVLEVBQUUsUUFBdUIsRUFBRTtRQUNqRSxLQUFLLENBQUMsS0FBSyxFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBQ2pCLElBQUksQ0FBQyxXQUFXLEdBQUcsS0FBSyxDQUFDLFdBQVcsSUFBSSxtQkFBSyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsQ0FBQyxTQUFTLENBQUM7UUFFakUsSUFBSSxDQUFDLFlBQVksR0FBRyxLQUFLLENBQUMsWUFBWSxJQUFJLElBQUksb0NBQXdCLEVBQUUsQ0FBQztJQUMzRSxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLFdBQVcsQ0FBQyxLQUFnQixFQUFFLEVBQVUsRUFBRSxLQUF1QjtRQUN0RSxJQUFJLHlDQUFrQixDQUFDLEtBQUssRUFBRSxFQUFFLEVBQUU7WUFDaEMsV0FBVyxFQUFFLElBQUksQ0FBQyxXQUFXO1lBQzdCLFlBQVksRUFBRSxJQUFJLENBQUMsWUFBWTtZQUMvQixnQkFBZ0IsRUFBRSxLQUFLLENBQUMsZ0JBQWdCO1lBQ3hDLGtCQUFrQixFQUFFLEtBQUssQ0FBQyxrQkFBa0I7WUFDNUMsaUJBQWlCLEVBQUUsS0FBSyxDQUFDLGlCQUFpQjtZQUMxQyxNQUFNLEVBQUUsS0FBSyxDQUFDLE1BQU07WUFDcEIsU0FBUyxFQUFFLEtBQUssQ0FBQyxTQUFTO1lBQzFCLGdCQUFnQixFQUFFLEtBQUssQ0FBQyxnQkFBZ0I7U0FDekMsQ0FBQyxDQUFDO0lBQ0wsQ0FBQztJQUVEOzs7T0FHRztJQUNJLGNBQWMsQ0FBQyxLQUFnQixFQUFFLEVBQVUsRUFBRSxLQUFvQjtRQUV0RSxJQUFJLG1DQUFlLENBQUMsS0FBSyxFQUFFLEVBQUUsRUFBRTtZQUM3QixXQUFXLEVBQUUsS0FBSyxDQUFDLHlCQUF5QixJQUFJLElBQUksQ0FBQyxXQUFXO1lBQ2hFLHVCQUF1QixFQUFFLEtBQUssQ0FBQyx1QkFBdUI7WUFDdEQsTUFBTSxFQUFFLEtBQUssQ0FBQyxNQUFNO1lBQ3BCLFlBQVksRUFBRSxLQUFLLENBQUMsWUFBWTtZQUNoQyxjQUFjLEVBQUUsS0FBSyxDQUFDLGNBQWM7WUFDcEMsU0FBUyxFQUFFLEtBQUssQ0FBQyxTQUFTO1lBQzFCLFlBQVksRUFBRSxLQUFLLENBQUMsWUFBWTtZQUNoQyxnQkFBZ0IsRUFBRSxLQUFLLENBQUMsZ0JBQWdCO1lBQ3hDLFNBQVMsRUFBRSxLQUFLLENBQUMsU0FBUztZQUMxQixRQUFRLEVBQUUsS0FBSyxDQUFDLFFBQVE7WUFDeEIsS0FBSyxFQUFFLEtBQUssQ0FBQyxLQUFLO1NBQ25CLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRDs7T0FFRztJQUNJLFVBQVUsQ0FBQyxLQUFnQjtRQUNoQyxNQUFNLE1BQU0sR0FBRyxJQUFJLHlCQUFjLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDeEMscUJBQU8sQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQ2hDLENBQUM7O0FBeERILDRCQXlEQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEFzcGVjdHMsIFN0YWNrIH0gZnJvbSAnYXdzLWNkay1saWInO1xuaW1wb3J0IHsgQ29uc3RydWN0IH0gZnJvbSAnY29uc3RydWN0cyc7XG5pbXBvcnQgeyBEZWZhdWx0U2xhY2tOb3RpZmljYXRpb24sIElOb3RpZmljYXRpb24gfSBmcm9tICcuLi9kYXRhZG9ndjInO1xuaW1wb3J0IHsgV2F0Y2hmdWxBc3BlY3QsIE1ldHJpY0FsYXJtUHJvcHMsIEFic3RyYWN0V2F0Y2hmdWwgfSBmcm9tICcuLi93YXRjaGZ1bCc7XG5pbXBvcnQgeyBEYXRhRG9nTG9nQWxhcm0sIExvZ0FsYXJtUHJvcHMgfSBmcm9tICcuL2RhdGFkb2ctbG9nLWFsYXJtJztcbmltcG9ydCB7IERhdGFEb2dNZXRyaWNBbGFybSB9IGZyb20gJy4vZGF0YWRvZy1tZXRyaWMtYWxhcm0nO1xuXG4vKipcbiAqIFByb3BlcnRpZXMgZm9yIGRlZmluaW5nIFdhdGNoZnVsXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgV2F0Y2hmdWxQcm9wcyB7XG4gIC8qKlxuICAgKiBUaGUgc2VydmljZSBuYW1lLlxuICAgKlxuICAgKiBAZGVmYXVsdFZhbHVlIFRoZSBzdGFjayBuYW1lLlxuICAgKi9cbiAgcmVhZG9ubHkgc2VydmljZU5hbWU/OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFNldCB0aGUgd2F5IGhvdyBtb25pdG9ycyBzaG91bGQgbm90aWZ5IGluIGNhc2Ugb2YgYW4gYWxlcnQuXG4gICAqXG4gICAqIEBkZWZhdWx0VmFsdWUge0BsaW5rIERlZmF1bHRTbGFja05vdGlmaWNhdGlvbn1cbiAgICovXG4gIHJlYWRvbmx5IG5vdGlmaWNhdGlvbj86IElOb3RpZmljYXRpb247XG59XG5cbi8qKlxuICogQSBjb25zdHJ1Y3QgdG8gd2F0Y2ggZ2l2ZW4gc2NvcGUgb3IgcmVzb3VyY2VzLiBPcGluaW9uYXRlZCBEYXRhRG9nIGFsYXJtcyBhcmUgYXV0b21hdGljYWxseSBjcmVhdGVkIGZvciB3YXRjaGVkIHJlc291cmNlcy5cbiAqXG4gKiBVc2FnZSB3aXRoIG5vbi1kZWZhdWx0IG5vdGlmaWNhdGlvbjpcbiAqIGBgYHRzXG4gKiBjb25zdCBkdyA9IG5ldyB3YXRjaGZ1bHYyLldhdGNoZnVsKHRoaXMsICdXYXRjaGZ1bCcsIHtcbiAqICAgc2VydmljZU5hbWU6IHByb3BzLnNlcnZpY2VOYW1lLFxuICogICBub3RpZmljYXRpb246IG5ldyBkYXRhZG9ndjIuU2xhY2tOb3RpZmljYXRpb24oe2NoYW5uZWw6ICd0ZWFtLWFsZXJ0LWNoYW5uZWwnfSlcbiAqIH0pO1xuICogZHcud2F0Y2hTY29wZSh0aGlzKTtcbiAqYGBgXG4gKi9cbmV4cG9ydCBjbGFzcyBXYXRjaGZ1bCBleHRlbmRzIEFic3RyYWN0V2F0Y2hmdWwge1xuICBwcml2YXRlIHJlYWRvbmx5IG5vdGlmaWNhdGlvbjogSU5vdGlmaWNhdGlvbjtcbiAgcHJpdmF0ZSByZWFkb25seSBzZXJ2aWNlTmFtZTogc3RyaW5nO1xuXG4gIGNvbnN0cnVjdG9yKHNjb3BlOiBDb25zdHJ1Y3QsIGlkOiBzdHJpbmcsIHByb3BzOiBXYXRjaGZ1bFByb3BzID0ge30pIHtcbiAgICBzdXBlcihzY29wZSwgaWQpO1xuICAgIHRoaXMuc2VydmljZU5hbWUgPSBwcm9wcy5zZXJ2aWNlTmFtZSA/PyBTdGFjay5vZih0aGlzKS5zdGFja05hbWU7XG5cbiAgICB0aGlzLm5vdGlmaWNhdGlvbiA9IHByb3BzLm5vdGlmaWNhdGlvbiA/PyBuZXcgRGVmYXVsdFNsYWNrTm90aWZpY2F0aW9uKCk7XG4gIH1cblxuICAvKipcbiAgICogQWRkcyB0aGUgYWxhcm1Ub3BpYyBhcyBhbGFybSBhY3Rpb24gdG8gdGhlIGdpdmVuIGFsYXJtLlxuICAgKlxuICAgKiBAcGFyYW0gYWxhcm0gLSBUaGUgd2F0Y2hmdWwgdG8gYWRkIHRob3NlIHJlc291cmNlcyB0b1xuICAgKi9cbiAgcHVibGljIGNyZWF0ZUFsYXJtKHNjb3BlOiBDb25zdHJ1Y3QsIGlkOiBzdHJpbmcsIGFsYXJtOiBNZXRyaWNBbGFybVByb3BzKTogdm9pZCB7XG4gICAgbmV3IERhdGFEb2dNZXRyaWNBbGFybShzY29wZSwgaWQsIHtcbiAgICAgIHNlcnZpY2VOYW1lOiB0aGlzLnNlcnZpY2VOYW1lLFxuICAgICAgbm90aWZpY2F0aW9uOiB0aGlzLm5vdGlmaWNhdGlvbixcbiAgICAgIGFsYXJtRGVzY3JpcHRpb246IGFsYXJtLmFsYXJtRGVzY3JpcHRpb24sXG4gICAgICBjb21wYXJpc29uT3BlcmF0b3I6IGFsYXJtLmNvbXBhcmlzb25PcGVyYXRvcixcbiAgICAgIGV2YWx1YXRpb25QZXJpb2RzOiBhbGFybS5ldmFsdWF0aW9uUGVyaW9kcyxcbiAgICAgIG1ldHJpYzogYWxhcm0ubWV0cmljLFxuICAgICAgdGhyZXNob2xkOiBhbGFybS50aHJlc2hvbGQsXG4gICAgICB0cmVhdE1pc3NpbmdEYXRhOiBhbGFybS50cmVhdE1pc3NpbmdEYXRhLFxuICAgIH0pO1xuICB9XG5cbiAgLyoqXG4gICAqIEFkZHMgYW4gYWxlcnQgZm9yIGVycm9yIGxvZ3NcbiAgICogQHBhcmFtIHNjb3BlXG4gICAqL1xuICBwdWJsaWMgY3JlYXRlTG9nQWxhcm0oc2NvcGU6IENvbnN0cnVjdCwgaWQ6IHN0cmluZywgYWxhcm06IExvZ0FsYXJtUHJvcHMpOnZvaWQge1xuXG4gICAgbmV3IERhdGFEb2dMb2dBbGFybShzY29wZSwgaWQsIHtcbiAgICAgIHNlcnZpY2VOYW1lOiBhbGFybS5sYW1iZGFDbG91ZHdhdGNoR3JvdXBOYW1lID8/IHRoaXMuc2VydmljZU5hbWUsXG4gICAgICBhdXRvQ2xvc2VPcHNHZW5pZUFsZXJ0czogYWxhcm0uYXV0b0Nsb3NlT3BzR2VuaWVBbGVydHMsXG4gICAgICBwZXJpb2Q6IGFsYXJtLnBlcmlvZCxcbiAgICAgIHVuaXRPZlBlcmlvZDogYWxhcm0udW5pdE9mUGVyaW9kLCAvLyB0b0RvOiBtb3ZlIHRoYXQgc29tZXdoZXJlIGVsc2UgYW5kIHNldCBkZWZhdWx0cyB0aGVyZT9cbiAgICAgIHBlcmlvZE9wZXJhdG9yOiBhbGFybS5wZXJpb2RPcGVyYXRvcixcbiAgICAgIHN0YXRpc3RpYzogYWxhcm0uc3RhdGlzdGljLFxuICAgICAgcXVlcnlGaWx0ZXJzOiBhbGFybS5xdWVyeUZpbHRlcnMsIC8vIHRvRG86IG1vdmUgdGhhdCBzb21ld2hlcmUgZWxzZSBhbmQgc2V0IGRlZmF1bHRzIHRoZXJlP1xuICAgICAgYWxhcm1EZXNjcmlwdGlvbjogYWxhcm0uYWxhcm1EZXNjcmlwdGlvbixcbiAgICAgIHRocmVzaG9sZDogYWxhcm0udGhyZXNob2xkLFxuICAgICAgcHJpb3JpdHk6IGFsYXJtLnByaW9yaXR5LFxuICAgICAgaW5kZXg6IGFsYXJtLmluZGV4LFxuICAgIH0pO1xuICB9XG5cbiAgLyoqXG4gICAqIFdhdGNoZXMgdGhlIGdpdmVuIHNjb3BlIGFuZCBhZGRzIGFsYXJtcyBmb3Iga25vd24gcmVzb3VyY2VzLlxuICAgKi9cbiAgcHVibGljIHdhdGNoU2NvcGUoc2NvcGU6IENvbnN0cnVjdCk6IHZvaWQge1xuICAgIGNvbnN0IGFzcGVjdCA9IG5ldyBXYXRjaGZ1bEFzcGVjdCh0aGlzKTtcbiAgICBBc3BlY3RzLm9mKHNjb3BlKS5hZGQoYXNwZWN0KTtcbiAgfVxufVxuIl19

package/package.json

@@ -15,9 +15,14 @@
   ],
   "main": "lib/index.js",
   "license": "Apache-2.0",
-  "version": "4.13.2",
+  "version": "4.14.0",
   "types": "lib/index.d.ts",
   "stability": "stable",
+  "exports": {
+    ".": "./lib/index.js",
+    "./datadogv2": "./lib/datadogv2/index.js",
+    "./watchfulv2": "./lib/watchfulv2/index.js"
+  },
   "jsii": {
     "outdir": "dist",
     "targets": {},
@@ -47,7 +52,8 @@
     "release:check-last-commit": "node release-commit-check.js",
     "release:build": "npm run build && npm run bump",
     "release:push": "echo '✅  pushing release' && git push origin master --follow-tags",
-    "release": "npm run release:check-last-commit && npm run release:build"
+    "release": "npm run release:check-last-commit && npm run release:build",
+    "release:dry-run": "npm run build && npm run release:check && standard-version --dry-run"
   },
   "devDependencies": {
     "@types/jest": "27.4.1",
@@ -55,15 +61,16 @@
     "@types/node": "17.0.23",
     "@typescript-eslint/eslint-plugin": "5.18.0",
     "@typescript-eslint/parser": "5.18.0",
-    "aws-cdk": "^2.77.0",
-    "aws-cdk-lib": "^2.77.0",
-    "constructs": "10.0.107",
+    "aws-cdk": "~2.81.0",
+    "aws-cdk-lib": "2.81.0",
+    "constructs": "10.2.69",
     "copyfiles": "2.4.1",
     "esbuild": "0.14.32",
     "eslint": "8.12.0",
     "eslint-import-resolver-node": "0.3.6",
     "eslint-import-resolver-typescript": "2.7.1",
     "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
     "jest": "~27.5.1 ",
     "jest-junit": "13.1.0",
     "jsii": "~1.78.0",
@@ -74,8 +81,8 @@
     "typescript": "~4.6.4"
   },
   "peerDependencies": {
-    "aws-cdk-lib": "^2.41.0",
-    "constructs": "^10.0.107"
+    "aws-cdk-lib": "~2.81.0",
+    "constructs": "^10.2.69"
   },
   "dependencies": {
     "js-yaml": "~4.1.0"
@@ -124,5 +131,8 @@
         "tsconfig": "tsconfig.dev.json"
       }
     }
-  }
+  },
+  "bundleDependencies": [
+    "js-yaml"
+  ]
 }

package/version.json

@@ -1,3 +1,3 @@
 {
-  "version": "4.13.2"
+  "version": "4.14.0"
 }