@rio-cloud/cdk-v2-constructs 4.33.0 → 4.33.2

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 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    ```"
+    "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## Constructs overview (Under construction...)\n\n### Watchful\n\nWatchful constructs help generate some default monitors based on the resouces defined in your stack. Eg - If your stack contains a lambda function and you configure watchful construct, then it will create out of box metric monitors for Throttling, Lambda error and Log error monitors. The ever growing list of resources that watchful creates monitors for as of today are:\n\n- Application load balancer\n- Cloudfront\n- Documentdb\n- Dynamodb\n- Fargate\n- Lambda\n- RDS\n\nSimply add the following to your CDK stack to get started.\n```\n  import * as rio from '@rio-cloud/cdk-v2-constructs';\n    ...\n    const dw = new rio.watchfulv2.Watchful(this, 'Watchful', {\n      serviceName,\n    });\n    dw.watchScope(this); // Generates alarms for all supported resources\n    ...\n```\n\nThere are options to override some defaults too. Please be aware that the library is very opinionated and is written with the most general use cases in mind. It is necessary to keep the use of the library simple enough, which means that there is only limited flexibility regarding the configuration options. Having said that, feel free to reach out to team CLAID over slack #rio-platform-support in case of feature requests.\n\nThe broad classification of the monitors created by watchful are\n- Log error monitors\n- Metrics Query monitors: Basically everything other than log error monitors\n\nFor Metrics query monitors, you can configure the priority (defaults as 3). For log error monitors, you can cpnfigure priority, renototification interval and can configure if the auto close of the monitor is disabled.\n```\n    ...\n    const dw = new Watchful(stack, 'Watchful2', {\n      logErrorMonitorConfig: {\n        disableAutoClose: true,\n        renotifyInterval: 150,\n        priority: 4,\n      },\n      queryErrorMonitorConfig: {\n        priority: 4\n      }\n    });\n    dw.watchScope(stack);\n```\n\nThere 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.\nEg -\n```\n...\nconst dw = new Watchful(stack, 'Watchful', {});\ndw.overrideAlarmThreshold({\n  monitoredResourceScope: lambdaA,\n  monitorType: MonitorType.ERRORS,\n  threshold: 5,\n});\ndw.watchScope(stack);\n```"
   },
   "repository": {
     "type": "git",
@@ -7474,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": {
@@ -10963,7 +10979,7 @@
           },
           "locationInModule": {
             "filename": "src/watchful/watchful.ts",
-            "line": 317
+            "line": 318
           },
           "name": "createLogAlarm",
           "overrides": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
@@ -10995,7 +11011,7 @@
           },
           "locationInModule": {
             "filename": "src/watchful/watchful.ts",
-            "line": 341
+            "line": 342
           },
           "name": "watchScope",
           "parameters": [
@@ -15450,6 +15466,135 @@
       ],
       "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"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "Renotification interval for log error monitor in minutes."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/watchfulv2/watchful.ts",
+            "line": 36
+          },
+          "name": "renotifyInterval",
+          "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": 42
+      },
+      "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": 47
+          },
+          "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",
@@ -15465,7 +15610,7 @@
         },
         "locationInModule": {
           "filename": "src/watchfulv2/watchful.ts",
-          "line": 51
+          "line": 107
         },
         "parameters": [
           {
@@ -15492,7 +15637,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/watchfulv2/watchful.ts",
-        "line": 46
+        "line": 100
       },
       "methods": [
         {
@@ -15502,7 +15647,7 @@
           },
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 64
+            "line": 131
           },
           "name": "createAlarm",
           "overrides": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
@@ -15537,7 +15682,7 @@
           },
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 83
+            "line": 151
           },
           "name": "createLogAlarm",
           "overrides": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
@@ -15569,7 +15714,7 @@
           },
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 108
+            "line": 178
           },
           "name": "watchScope",
           "parameters": [
@@ -15597,7 +15742,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/watchfulv2/watchful.ts",
-        "line": 11
+        "line": 53
       },
       "name": "WatchfulProps",
       "namespace": "watchfulv2",
@@ -15606,13 +15751,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": 74
           },
           "name": "createCasesFromErrorLogMonitors",
           "optional": true,
@@ -15620,6 +15766,23 @@
             "primitive": "boolean"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "Configure log error monitor properties."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/watchfulv2/watchful.ts",
+            "line": 79
+          },
+          "name": "logErrorMonitorConfig",
+          "optional": true,
+          "type": {
+            "fqn": "@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -15630,7 +15793,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 24
+            "line": 66
           },
           "name": "notification",
           "optional": true,
@@ -15638,6 +15801,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": 85
+          },
+          "name": "queryErrorMonitorConfig",
+          "optional": true,
+          "type": {
+            "fqn": "@rio-cloud/cdk-v2-constructs.watchfulv2.QueryErrorMonitorProps"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -15648,7 +15829,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/watchfulv2/watchful.ts",
-            "line": 17
+            "line": 59
           },
           "name": "serviceName",
           "optional": true,
@@ -15661,5 +15842,5 @@
     }
   },
   "version": "0.0.0",
-  "fingerprint": "x/mTlwg21suih9TKv6Gaich+3UlQM+14pu4VqnR83KM="
+  "fingerprint": "70LvXJLOYza4edFMgTMby4XdszbhVdPZbcsTqf4VOOE="
 }

package/API.md

@@ -8002,6 +8002,7 @@ const dataDogMetricAlarmProps: DataDogMetricAlarmProps = { ... }
 | <code><a href="#@rio-cloud/cdk-v2-constructs.DataDogMetricAlarmProps.property.comparisonOperator">comparisonOperator</a></code> | <code>aws-cdk-lib.aws_cloudwatch.ComparisonOperator</code> | Comparison to use to check if metric is breaching. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.DataDogMetricAlarmProps.property.evaluationPeriods">evaluationPeriods</a></code> | <code>number</code> | The number of periods over which data is compared to the specified threshold. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.DataDogMetricAlarmProps.property.metric">metric</a></code> | <code>aws-cdk-lib.aws_cloudwatch.Metric</code> | The CloudWatch metric used as source for the alarm. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.DataDogMetricAlarmProps.property.priority">priority</a></code> | <code>number</code> | priority. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.DataDogMetricAlarmProps.property.threshold">threshold</a></code> | <code>number</code> | The value against which the specified statistic is compared. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.DataDogMetricAlarmProps.property.treatMissingData">treatMissingData</a></code> | <code>aws-cdk-lib.aws_cloudwatch.TreatMissingData</code> | Sets how this alarm is to handle missing data points. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.DataDogMetricAlarmProps.property.dataDogOpsGenieIntegrationName">dataDogOpsGenieIntegrationName</a></code> | <code>string</code> | The name of DataDog's OpsGenie integration. |
@@ -8059,6 +8060,18 @@ The CloudWatch metric used as source for the alarm.
 
 ---
 
+##### `priority`<sup>Required</sup> <a name="priority" id="@rio-cloud/cdk-v2-constructs.DataDogMetricAlarmProps.property.priority"></a>
+
+```typescript
+public readonly priority: number;
+```
+
+- *Type:* number
+
+priority.
+
+---
+
 ##### `threshold`<sup>Required</sup> <a name="threshold" id="@rio-cloud/cdk-v2-constructs.DataDogMetricAlarmProps.property.threshold"></a>
 
 ```typescript
@@ -10349,6 +10362,85 @@ The soft limit is 10 days but can be increased upon requests.
 
 ---
 
+### LogErrorMonitorProps <a name="LogErrorMonitorProps" id="@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps"></a>
+
+Log error monitor props.
+
+#### Initializer <a name="Initializer" id="@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps.Initializer"></a>
+
+```typescript
+import { watchfulv2 } from '@rio-cloud/cdk-v2-constructs'
+
+const logErrorMonitorProps: watchfulv2.LogErrorMonitorProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps.property.createCasesFromErrorLogMonitors">createCasesFromErrorLogMonitors</a></code> | <code>boolean</code> | Enable error log monitors creating cases in Datadog. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps.property.disableAutoClose">disableAutoClose</a></code> | <code>boolean</code> | Configure if monitor needs to be resolved manually every time. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps.property.priority">priority</a></code> | <code>number</code> | Set the priority of the log error monitor. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps.property.renotifyInterval">renotifyInterval</a></code> | <code>number</code> | Renotification interval for log error monitor in minutes. |
+
+---
+
+##### `createCasesFromErrorLogMonitors`<sup>Optional</sup> <a name="createCasesFromErrorLogMonitors" id="@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps.property.createCasesFromErrorLogMonitors"></a>
+
+```typescript
+public readonly createCasesFromErrorLogMonitors: boolean;
+```
+
+- *Type:* boolean
+- *Default:* {@link false }
+
+Enable error log monitors creating cases in Datadog.
+
+This property has been deprecated. The propery has been instead nested into logErrorMonitorConfig.
+The functionality remains unchanged
+
+---
+
+##### `disableAutoClose`<sup>Optional</sup> <a name="disableAutoClose" id="@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps.property.disableAutoClose"></a>
+
+```typescript
+public readonly disableAutoClose: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+Configure if monitor needs to be resolved manually every time.
+
+This option also sets the renotify interval to 2 hours
+
+---
+
+##### `priority`<sup>Optional</sup> <a name="priority" id="@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps.property.priority"></a>
+
+```typescript
+public readonly priority: number;
+```
+
+- *Type:* number
+- *Default:* 3
+
+Set the priority of the log error monitor.
+
+---
+
+##### `renotifyInterval`<sup>Optional</sup> <a name="renotifyInterval" id="@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps.property.renotifyInterval"></a>
+
+```typescript
+public readonly renotifyInterval: number;
+```
+
+- *Type:* number
+
+Renotification interval for log error monitor in minutes.
+
+---
+
 ### MetricAlarmProps <a name="MetricAlarmProps" id="@rio-cloud/cdk-v2-constructs.MetricAlarmProps"></a>
 
 An interface to define a generic alarm that can be used in DataDog as well as in CloudWatch.
@@ -10369,6 +10461,7 @@ const metricAlarmProps: MetricAlarmProps = { ... }
 | <code><a href="#@rio-cloud/cdk-v2-constructs.MetricAlarmProps.property.comparisonOperator">comparisonOperator</a></code> | <code>aws-cdk-lib.aws_cloudwatch.ComparisonOperator</code> | Comparison to use to check if metric is breaching. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.MetricAlarmProps.property.evaluationPeriods">evaluationPeriods</a></code> | <code>number</code> | The number of periods over which data is compared to the specified threshold. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.MetricAlarmProps.property.metric">metric</a></code> | <code>aws-cdk-lib.aws_cloudwatch.Metric</code> | The CloudWatch metric used as source for the alarm. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.MetricAlarmProps.property.priority">priority</a></code> | <code>number</code> | priority. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.MetricAlarmProps.property.threshold">threshold</a></code> | <code>number</code> | The value against which the specified statistic is compared. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.MetricAlarmProps.property.treatMissingData">treatMissingData</a></code> | <code>aws-cdk-lib.aws_cloudwatch.TreatMissingData</code> | Sets how this alarm is to handle missing data points. |
 
@@ -10423,6 +10516,18 @@ The CloudWatch metric used as source for the alarm.
 
 ---
 
+##### `priority`<sup>Required</sup> <a name="priority" id="@rio-cloud/cdk-v2-constructs.MetricAlarmProps.property.priority"></a>
+
+```typescript
+public readonly priority: number;
+```
+
+- *Type:* number
+
+priority.
+
+---
+
 ##### `threshold`<sup>Required</sup> <a name="threshold" id="@rio-cloud/cdk-v2-constructs.MetricAlarmProps.property.threshold"></a>
 
 ```typescript
@@ -10980,6 +11085,39 @@ public readonly secretsFilePath: string;
 
 ---
 
+### QueryErrorMonitorProps <a name="QueryErrorMonitorProps" id="@rio-cloud/cdk-v2-constructs.watchfulv2.QueryErrorMonitorProps"></a>
+
+Query error monitor props.
+
+#### Initializer <a name="Initializer" id="@rio-cloud/cdk-v2-constructs.watchfulv2.QueryErrorMonitorProps.Initializer"></a>
+
+```typescript
+import { watchfulv2 } from '@rio-cloud/cdk-v2-constructs'
+
+const queryErrorMonitorProps: watchfulv2.QueryErrorMonitorProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.watchfulv2.QueryErrorMonitorProps.property.priority">priority</a></code> | <code>number</code> | Set the priority of the log error monitor. |
+
+---
+
+##### `priority`<sup>Optional</sup> <a name="priority" id="@rio-cloud/cdk-v2-constructs.watchfulv2.QueryErrorMonitorProps.property.priority"></a>
+
+```typescript
+public readonly priority: number;
+```
+
+- *Type:* number
+- *Default:* 3
+
+Set the priority of the log error monitor.
+
+---
+
 ### RioBitBucketSourceActionProps <a name="RioBitBucketSourceActionProps" id="@rio-cloud/cdk-v2-constructs.RioBitBucketSourceActionProps"></a>
 
 #### Initializer <a name="Initializer" id="@rio-cloud/cdk-v2-constructs.RioBitBucketSourceActionProps.Initializer"></a>
@@ -13016,12 +13154,16 @@ const watchfulProps: watchfulv2.WatchfulProps = { ... }
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.createCasesFromErrorLogMonitors">createCasesFromErrorLogMonitors</a></code> | <code>boolean</code> | Enable error log monitors creating cases in Datadog. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.logErrorMonitorConfig">logErrorMonitorConfig</a></code> | <code>@rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps</code> | Configure log error monitor properties. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.notification">notification</a></code> | <code>@rio-cloud/cdk-v2-constructs.datadogv2.INotification</code> | Set the way how monitors should notify in case of an alert. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.queryErrorMonitorConfig">queryErrorMonitorConfig</a></code> | <code>@rio-cloud/cdk-v2-constructs.watchfulv2.QueryErrorMonitorProps</code> | Configure query alert monitors. |
 | <code><a href="#@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.serviceName">serviceName</a></code> | <code>string</code> | The service name. |
 
 ---
 
-##### `createCasesFromErrorLogMonitors`<sup>Optional</sup> <a name="createCasesFromErrorLogMonitors" id="@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.createCasesFromErrorLogMonitors"></a>
+##### ~~`createCasesFromErrorLogMonitors`~~<sup>Optional</sup> <a name="createCasesFromErrorLogMonitors" id="@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.createCasesFromErrorLogMonitors"></a>
+
+- *Deprecated:* This property has been deprecated. The propery has been instead nested into logErrorMonitorConfig. The functionality remains unchanged.
 
 ```typescript
 public readonly createCasesFromErrorLogMonitors: boolean;
@@ -13034,6 +13176,18 @@ Enable error log monitors creating cases in Datadog.
 
 ---
 
+##### `logErrorMonitorConfig`<sup>Optional</sup> <a name="logErrorMonitorConfig" id="@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.logErrorMonitorConfig"></a>
+
+```typescript
+public readonly logErrorMonitorConfig: LogErrorMonitorProps;
+```
+
+- *Type:* @rio-cloud/cdk-v2-constructs.watchfulv2.LogErrorMonitorProps
+
+Configure log error monitor properties.
+
+---
+
 ##### `notification`<sup>Optional</sup> <a name="notification" id="@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.notification"></a>
 
 ```typescript
@@ -13047,6 +13201,21 @@ Set the way how monitors should notify in case of an alert.
 
 ---
 
+##### `queryErrorMonitorConfig`<sup>Optional</sup> <a name="queryErrorMonitorConfig" id="@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.queryErrorMonitorConfig"></a>
+
+```typescript
+public readonly queryErrorMonitorConfig: QueryErrorMonitorProps;
+```
+
+- *Type:* @rio-cloud/cdk-v2-constructs.watchfulv2.QueryErrorMonitorProps
+
+Configure query alert monitors.
+
+All monitors created by watchful except for Log error monitor.
+Configure property *logErrorMonitor* for Log error monitor.
+
+---
+
 ##### `serviceName`<sup>Optional</sup> <a name="serviceName" id="@rio-cloud/cdk-v2-constructs.watchfulv2.WatchfulProps.property.serviceName"></a>
 
 ```typescript

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [4.33.2](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv4.33.1&sourceBranch=refs%2Ftags%2Fv4.33.2) (2024-04-25)
+
+## [4.33.1](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv4.33.0&sourceBranch=refs%2Ftags%2Fv4.33.1) (2024-04-24)
+
+
+### Bug Fixes
+
+* :boom: * The default threshold for watchful v2 alatams has been changed. Priotiy override and disabling of auto close of error monitor has also been added. ([eda81da](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/commits/eda81da35a70f78e0bc6b34fda0c0e9ccaaff072))
+
 ## [4.33.0](https://bitbucket.collaboration-man.com/projects/RIODEV/repos/cdk-v2-constructs/compare/commits?targetBranch=refs%2Ftags%2Fv4.32.0&sourceBranch=refs%2Ftags%2Fv4.33.0) (2024-04-17)
 
 

package/README.md

@@ -25,18 +25,62 @@ $ npm install --save @rio-cloud/cdk-v2-constructs
 ## Internal documentation for library devs
 [Documentation](./developers-readme.md)
 
-## FAQ's
-- How can I update the thresholds of monitors created by watchful?
-    
-    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.
-    Eg -
-    ```
+## Constructs overview (Under construction...)
+
+### Watchful
+
+Watchful constructs help generate some default monitors based on the resouces defined in your stack. Eg - If your stack contains a lambda function and you configure watchful construct, then it will create out of box metric monitors for Throttling, Lambda error and Log error monitors. The ever growing list of resources that watchful creates monitors for as of today are:
+
+- Application load balancer
+- Cloudfront
+- Documentdb
+- Dynamodb
+- Fargate
+- Lambda
+- RDS
+
+Simply add the following to your CDK stack to get started.
+```
+  import * as rio from '@rio-cloud/cdk-v2-constructs';
+    ...
+    const dw = new rio.watchfulv2.Watchful(this, 'Watchful', {
+      serviceName,
+    });
+    dw.watchScope(this); // Generates alarms for all supported resources
+    ...
+```
+
+There are options to override some defaults too. Please be aware that the library is very opinionated and is written with the most general use cases in mind. It is necessary to keep the use of the library simple enough, which means that there is only limited flexibility regarding the configuration options. Having said that, feel free to reach out to team CLAID over slack #rio-platform-support in case of feature requests.
+
+The broad classification of the monitors created by watchful are
+- Log error monitors
+- Metrics Query monitors: Basically everything other than log error monitors
+
+For Metrics query monitors, you can configure the priority (defaults as 3). For log error monitors, you can cpnfigure priority, renototification interval and can configure if the auto close of the monitor is disabled.
+```
     ...
-    const dw = new Watchful(stack, 'Watchful', {});
-    dw.overrideAlarmThreshold({
-      monitoredResourceScope: lambdaA,
-      monitorType: MonitorType.ERRORS,
-      threshold: 5,
+    const dw = new Watchful(stack, 'Watchful2', { 
+      logErrorMonitorConfig: {
+        disableAutoClose: true, 
+        renotifyInterval: 150,
+        priority: 4,
+      },
+      queryErrorMonitorConfig: {
+        priority: 4
+      }
     });
     dw.watchScope(stack);
-    ```
+```
+
+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.
+Eg -
+```
+...
+const dw = new Watchful(stack, 'Watchful', {});
+dw.overrideAlarmThreshold({
+  monitoredResourceScope: lambdaA,
+  monitorType: MonitorType.ERRORS,
+  threshold: 5,
+});
+dw.watchScope(stack);
+```