@rio-cloud/cdk-v2-constructs 4.32.0 → 4.33.1

package/.jsii

@@ -3668,7 +3668,7 @@
   },
   "name": "@rio-cloud/cdk-v2-constructs",
   "readme": {
-    "markdown": "# RIO CDK Constructs\n\nThis package contains CDK2 constructs for RIO teams.\n\n> NPM: `@rio-cloud/cdk-v2-constructs`\n\n## Bootstrapping of CDK project\n\n```\n$ npx cdk init --language typescript\n```\n\n## Installation\n\n```\n$ npm install --save @rio-cloud/cdk-v2-constructs\n```\n\n## See also\n\n * [How to contribut](./CONTRIBUTION.md)\n * [Changelog](./CHANGELOG.md)\n * [brief API desciption](./API.md)\n\n## Internal documentation for library devs\n[Documentation](./developers-readme.md)\n\n## FAQ's\n- How can I udpate the thresholds of monitors created by watchful?\n\n    There is an `overrideAlarmThreshold` method which can be used to override the default watchful thresholds. Please make aure to use the method before the `watchscope` function.\n    Eg -\n    ```\n    ...\n    const dw = new Watchful(stack, 'Watchful', {});\n    dw.overrideAlarmThreshold({\n      monitoredResourceScope: lambdaA,\n      monitorType: MonitorType.ERRORS,\n      threshold: 5,\n    });\n    dw.watchScope(stack);\n    ```"
+    "markdown": "# RIO CDK Constructs\n\nThis package contains CDK2 constructs for RIO teams.\n\n> NPM: `@rio-cloud/cdk-v2-constructs`\n\n## Bootstrapping of CDK project\n\n```\n$ npx cdk init --language typescript\n```\n\n## Installation\n\n```\n$ npm install --save @rio-cloud/cdk-v2-constructs\n```\n\n## See also\n\n * [How to contribute](./CONTRIBUTION.md)\n * [Changelog](./CHANGELOG.md)\n * [brief API description](./API.md)\n\n## Internal documentation for library devs\n[Documentation](./developers-readme.md)\n\n## FAQ's\n- How can I update the thresholds of monitors created by watchful?\n\n    There is an `overrideAlarmThreshold` method which can be used to override the default watchful thresholds. Please make aure to use the method before the `watchscope` function.\n    Eg -\n    ```\n    ...\n    const dw = new Watchful(stack, 'Watchful', {});\n    dw.overrideAlarmThreshold({\n      monitoredResourceScope: lambdaA,\n      monitorType: MonitorType.ERRORS,\n      threshold: 5,\n    });\n    dw.watchScope(stack);\n    ```"
   },
   "repository": {
     "type": "git",
@@ -4318,9 +4318,9 @@
       "assembly": "@rio-cloud/cdk-v2-constructs",
       "base": "constructs.Construct",
       "docs": {
-        "remarks": "The construct creates monitoring for detecting ECS containers that were stopped abruptly for reasons such as,\nout of memory, failed health checks.\n\nThe monitor will consume the ECS events and send them to a CloudWatch log group, which are forwarded to Datadog for\nbetter analyses and trigger an alert.\n\nMore details on the AWS ECS events can be found here:\n{@link https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_cwe_events.html}\n\nThis monitor adds transparency to such cases, which otherwise would happen without being noticed and could escalate\nto bigger issues, like a service being that requires more resources.",
+        "remarks": "The construct creates monitoring for detecting ECS containers that were stopped abruptly by AWS for reasons such as,\nout of memory, or failed health checks.\n\nThis monitor adds transparency to such cases, which otherwise would happen without being noticed and could escalate\nto bigger issues, like a service that requires more resources to run properly.\n\nThe construct will consume the ECS events and send them to a CloudWatch log group, which are forwarded to Datadog,\nallowing better analyses since AWS keeps the stopped task details for only one hour and will be used to create a\nmonitor.\n\nContributions are more than welcome, please get in touch with Team Outbound to ensure compatibility.\n\nThis construct was based on an AWS blog post about ECS anomaly detection, see here:\n{@link https://aws.amazon.com/blogs/containers/amazon-elastic-container-service-anomaly-detection-using-amazon-eventbridge/}.\n\nMore details on the AWS ECS events can be found here:\n{@link https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_cwe_events.html}.",
         "stability": "stable",
-        "summary": "# WARNING: This construct is still on beta phase."
+        "summary": "# WARNING: This construct is still in the beta phase."
       },
       "fqn": "@rio-cloud/cdk-v2-constructs.AwsEcsAbruptlyStoppedMonitor",
       "initializer": {
@@ -4329,7 +4329,7 @@
         },
         "locationInModule": {
           "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
-          "line": 31
+          "line": 61
         },
         "parameters": [
           {
@@ -4355,7 +4355,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
-        "line": 30
+        "line": 60
       },
       "name": "AwsEcsAbruptlyStoppedMonitor",
       "symbolId": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor:AwsEcsAbruptlyStoppedMonitor"
@@ -5814,29 +5814,34 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "Used to generate the monitor name as well a apply the `service` tag.",
+            "stability": "stable",
+            "summary": "The name of the service to which the monitor belongs."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
-            "line": 7
+            "line": 12
           },
-          "name": "notification",
+          "name": "serviceName",
           "type": {
-            "fqn": "@rio-cloud/cdk-v2-constructs.datadogv2.INotification"
+            "primitive": "string"
           }
         },
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "If no cluster is provided, the monitor will consume ECS events for all clusters within the account.",
+            "stability": "stable",
+            "summary": "ARN of the cluster that should be monitored, consuming only ECS events belonging to the cluster."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
-            "line": 6
+            "line": 36
           },
-          "name": "serviceName",
+          "name": "clusterArn",
+          "optional": true,
           "type": {
             "primitive": "string"
           }
@@ -5844,19 +5849,38 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "If no cluster is provided, all ECS will be part of the monitor.",
+            "default": "{@link DefaultSlackNotification }",
+            "see": "https://docs.datadoghq.com/monitors/notify",
             "stability": "stable",
-            "summary": "ARN of the cluster that should be monitored."
+            "summary": "To explicitly disable notifications use {@link NoNotification }."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
-            "line": 12
+            "line": 22
           },
-          "name": "clusterArn",
+          "name": "notification",
           "optional": true,
           "type": {
-            "primitive": "string"
+            "fqn": "@rio-cloud/cdk-v2-constructs.datadogv2.INotification"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "{@link DatadogMonitor.DEFAULT_PRIORITY }",
+            "stability": "stable",
+            "summary": "The alert priority of the monitor."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
+            "line": 30
+          },
+          "name": "priority",
+          "optional": true,
+          "type": {
+            "primitive": "number"
           }
         }
       ],
@@ -6287,7 +6311,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/kafka/kafka-event-spec.ts",
-        "line": 52
+        "line": 53
       },
       "methods": [
         {
@@ -6298,7 +6322,7 @@
           },
           "locationInModule": {
             "filename": "src/kafka/kafka-event-spec.ts",
-            "line": 59
+            "line": 60
           },
           "name": "fromYamlFile",
           "parameters": [
@@ -6328,7 +6352,7 @@
           },
           "locationInModule": {
             "filename": "src/kafka/kafka-event-spec.ts",
-            "line": 69
+            "line": 70
           },
           "name": "fromYamlString",
           "parameters": [
@@ -6356,7 +6380,7 @@
           },
           "locationInModule": {
             "filename": "src/kafka/kafka-event-spec.ts",
-            "line": 107
+            "line": 108
           },
           "name": "toSnsMessage",
           "returns": {
@@ -6375,7 +6399,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/kafka/kafka-event-spec.ts",
-            "line": 98
+            "line": 99
           },
           "name": "eventName",
           "type": {
@@ -7450,6 +7474,22 @@
             "fqn": "aws-cdk-lib.aws_cloudwatch.Metric"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "priority."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/watchful/metric-alarm.ts",
+            "line": 38
+          },
+          "name": "priority",
+          "type": {
+            "primitive": "number"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -10939,7 +10979,7 @@
           },
           "locationInModule": {
             "filename": "src/watchful/watchful.ts",
-            "line": 317
+            "line": 318
           },
           "name": "createLogAlarm",
           "overrides": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
@@ -10971,7 +11011,7 @@
           },
           "locationInModule": {
             "filename": "src/watchful/watchful.ts",
-            "line": 341
+            "line": 342
           },
           "name": "watchScope",
           "parameters": [
@@ -14562,7 +14602,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/kafka/kafka-event-spec.ts",
-        "line": 52
+        "line": 53
       },
       "methods": [
         {
@@ -14573,7 +14613,7 @@
           },
           "locationInModule": {
             "filename": "src/kafka/kafka-event-spec.ts",
-            "line": 59
+            "line": 60
           },
           "name": "fromYamlFile",
           "parameters": [
@@ -14603,7 +14643,7 @@
           },
           "locationInModule": {
             "filename": "src/kafka/kafka-event-spec.ts",
-            "line": 69
+            "line": 70
           },
           "name": "fromYamlString",
           "parameters": [
@@ -14631,7 +14671,7 @@
           },
           "locationInModule": {
             "filename": "src/kafka/kafka-event-spec.ts",
-            "line": 107
+            "line": 108
           },
           "name": "toSnsMessage",
           "returns": {
@@ -14651,7 +14691,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/kafka/kafka-event-spec.ts",
-            "line": 98
+            "line": 99
           },
           "name": "eventName",
           "type": {
@@ -15426,6 +15466,118 @@
       ],
       "symbolId": "src/kafka/rio-kafka-event-source:RioKafkaEventSourceProps"
     },
+    "@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Log error monitor props."
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/watchfulv2/watchful.ts",
+        "line": 11
+      },
+      "name": "LogErrorMonitorProps",
+      "namespace": "watchfulv2",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "{@link false }",
+            "remarks": "This property has been deprecated. The propery has been instead nested into logErrorMonitorConfig.\nThe functionality remains unchanged",
+            "stability": "stable",
+            "summary": "Enable error log monitors creating cases in Datadog."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/watchfulv2/watchful.ts",
+            "line": 31
+          },
+          "name": "createCasesFromErrorLogMonitors",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "remarks": "This option also sets the renotify interval to 2 hours",
+            "stability": "stable",
+            "summary": "Configure if monitor needs to be resolved manually every time."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/watchfulv2/watchful.ts",
+            "line": 16
+          },
+          "name": "disableAutoClose",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "3",
+            "stability": "stable",
+            "summary": "Set the priority of the log error monitor."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/watchfulv2/watchful.ts",
+            "line": 22
+          },
+          "name": "priority",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        }
+      ],
+      "symbolId": "src/watchfulv2/watchful:LogErrorMonitorProps"
+    },
+    "@rio-cloud/cdk-v2-constructs.watchfulv2.QueryErrorMonitorProps": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Query error monitor props."
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.watchfulv2.QueryErrorMonitorProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/watchfulv2/watchful.ts",
+        "line": 37
+      },
+      "name": "QueryErrorMonitorProps",
+      "namespace": "watchfulv2",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "3",
+            "stability": "stable",
+            "summary": "Set the priority of the log error monitor."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/watchfulv2/watchful.ts",
+            "line": 42
+          },
+          "name": "priority",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        }
+      ],
+      "symbolId": "src/watchfulv2/watchful:QueryErrorMonitorProps"
+    },
     "@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful": {
       "assembly": "@rio-cloud/cdk-v2-constructs",
       "base": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
@@ -15441,7 +15593,7 @@
         },
         "locationInModule": {
           "filename": "src/watchfulv2/watchful.ts",
-          "line": 51
+          "line": 102
         },
         "parameters": [
           {
@@ -15468,7 +15620,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/watchfulv2/watchful.ts",
-        "line": 46
+        "line": 95
       },
       "methods": [
         {
@@ -15478,7 +15630,7 @@
           },
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 64
+            "line": 126
           },
           "name": "createAlarm",
           "overrides": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
@@ -15513,7 +15665,7 @@
           },
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 83
+            "line": 146
           },
           "name": "createLogAlarm",
           "overrides": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
@@ -15545,7 +15697,7 @@
           },
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 108
+            "line": 172
           },
           "name": "watchScope",
           "parameters": [
@@ -15573,7 +15725,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/watchfulv2/watchful.ts",
-        "line": 11
+        "line": 48
       },
       "name": "WatchfulProps",
       "namespace": "watchfulv2",
@@ -15582,13 +15734,14 @@
           "abstract": true,
           "docs": {
             "default": "{@link false }",
-            "stability": "stable",
+            "deprecated": "This property has been deprecated. The propery has been instead nested into logErrorMonitorConfig. The functionality remains unchanged.",
+            "stability": "deprecated",
             "summary": "Enable error log monitors creating cases in Datadog."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 31
+            "line": 69
           },
           "name": "createCasesFromErrorLogMonitors",
           "optional": true,
@@ -15596,6 +15749,23 @@
             "primitive": "boolean"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "Configure log error monitor properties."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/watchfulv2/watchful.ts",
+            "line": 74
+          },
+          "name": "logErrorMonitorConfig",
+          "optional": true,
+          "type": {
+            "fqn": "@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -15606,7 +15776,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 24
+            "line": 61
           },
           "name": "notification",
           "optional": true,
@@ -15614,6 +15784,24 @@
             "fqn": "@rio-cloud/cdk-v2-constructs.datadogv2.INotification"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "All monitors created by watchful except for Log error monitor.\nConfigure property *logErrorMonitor* for Log error monitor.",
+            "stability": "stable",
+            "summary": "Configure query alert monitors."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/watchfulv2/watchful.ts",
+            "line": 80
+          },
+          "name": "queryErrorMonitorConfig",
+          "optional": true,
+          "type": {
+            "fqn": "@rio-cloud/cdk-v2-constructs.watchfulv2.QueryErrorMonitorProps"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -15624,7 +15812,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 17
+            "line": 54
           },
           "name": "serviceName",
           "optional": true,
@@ -15637,5 +15825,5 @@
     }
   },
   "version": "0.0.0",
-  "fingerprint": "H/ufZLVs0o4ILXI9qFPav7e6z2J6iAMeRxWCe3ORKn4="
+  "fingerprint": "014ybqZVCozAMQGNRvRgvDPo+YwtzYvNzLwLVL8klzA="
 }