lambda-error-sns-sender - npm Package Compare versions

Comparing version 0.0.35 to 0.0.36

.projenrc.ts

@@ -6,3 +6,3 @@ import { awscdk } from 'projen';
   authorAddress: '[e-mail]',
-  cdkVersion: '2.67.0',
+  cdkVersion: '2.91.0',
   defaultReleaseBranch: 'main',
@@ -52,3 +52,3 @@ jsiiVersion: '~5.0.0',
     javaPackage: 'io.github.serverlesslife.LambdaErrorSnsSender',
-    mavenArtifactId: 'LambdaErrorSnsSender`',
+    mavenArtifactId: 'LambdaErrorSnsSender',
     mavenEndpoint: 'https://s01.oss.sonatype.org',
@@ -55,0 +55,0 @@ },

API.md

@@ -1,2 +0,10 @@
-# replace this
+# Lambda Error SNS Sender
+
+## A simple solution to improve the CloudWatch alarm to receive Lambda error details by email. Available as CDK construct or as CloudFormation.
+
+How does it work:
+- Lambda is subscribed to the SNS topic where you receive your alarms. There is a message body subscription filter that limits errors based on the Lambda error metric. If you defied your metic in some other way, not the default one, you will have to change that filter.
+- Lambda analyzes the message, finds a log of the failed Lambda, and queries the log for the period that the metic was configured, plus some additional safety time, so we do not miss that error message. It extracts just a number of errors that can fit in one SNS message.
+ -Lambda sends errors to the same SNS you use for alerts. So apart from the common Alarm message, you will receive an additional one with error messages.
+
 # API Reference <a name="API Reference" id="api-reference"></a>
@@ -127,2 +135,3 @@
 | <code><a href="#lambda-error-sns-sender.LambdaErrorSnsSenderProps.property.stackName">stackName</a></code> | <code>string</code> | Name to deploy the stack with. |
+| <code><a href="#lambda-error-sns-sender.LambdaErrorSnsSenderProps.property.suppressTemplateIndentation">suppressTemplateIndentation</a></code> | <code>boolean</code> | Enable this flag to suppress indentation in generated CloudFormation templates. |
 | <code><a href="#lambda-error-sns-sender.LambdaErrorSnsSenderProps.property.synthesizer">synthesizer</a></code> | <code>aws-cdk-lib.IStackSynthesizer</code> | Synthesis method to use while deploying this stack. |
@@ -281,2 +290,19 @@ | <code><a href="#lambda-error-sns-sender.LambdaErrorSnsSenderProps.property.tags">tags</a></code> | <code>{[ key: string ]: string}</code> | Stack tags that will be applied to all the taggable resources and the stack itself. |
 
+##### `suppressTemplateIndentation`<sup>Optional</sup> <a name="suppressTemplateIndentation" id="lambda-error-sns-sender.LambdaErrorSnsSenderProps.property.suppressTemplateIndentation"></a>
+
+```typescript
+public readonly suppressTemplateIndentation: boolean;
+```
+
+- *Type:* boolean
+- *Default:* the value of `@aws-cdk/core:suppressTemplateIndentation`, or `false` if that is not set.
+
+Enable this flag to suppress indentation in generated CloudFormation templates.
+
+If not specified, the value of the `@aws-cdk/core:suppressTemplateIndentation`
+context key will be used. If that is not specified, then the
+default value `false` will be used.
+
+---
+
 ##### `synthesizer`<sup>Optional</sup> <a name="synthesizer" id="lambda-error-sns-sender.LambdaErrorSnsSenderProps.property.synthesizer"></a>
@@ -283,0 +309,0 @@

lib/index.js

@@ -58,4 +58,4 @@ "use strict";
 _a = JSII_RTTI_SYMBOL_1;
-LambdaErrorSnsSender[_a] = { fqn: "lambda-error-sns-sender.LambdaErrorSnsSender", version: "0.0.35" };
+LambdaErrorSnsSender[_a] = { fqn: "lambda-error-sns-sender.LambdaErrorSnsSender", version: "0.0.36" };
 exports.LambdaErrorSnsSender = LambdaErrorSnsSender;
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw2QkFBNkI7QUFDN0IsbUNBQW1DO0FBQ25DLDJDQUEyQztBQUMzQyxpREFBaUQ7QUFDakQsMkNBQTJDO0FBRTNDLGtFQUFrRTtBQUNsRSwyQ0FBdUM7QUFVdkMsTUFBYSxvQkFBcUIsU0FBUSxzQkFBUztJQUNqRCxZQUFZLEtBQWdCLEVBQUUsRUFBVSxFQUFFLEtBQWdDO1FBQ3hFLEtBQUssQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFFakIsSUFBSSxDQUFDLEtBQUssQ0FBQyxTQUFTLElBQUksS0FBSyxFQUFFLFNBQVMsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFO1lBQ3JELE1BQU0sSUFBSSxLQUFLLENBQUMsd0JBQXdCLENBQUMsQ0FBQztTQUMzQztRQUVELE1BQU0sWUFBWSxHQUFHLElBQUksTUFBTSxDQUFDLFFBQVEsQ0FBQyxJQUFJLEVBQUUsZ0JBQWdCLEVBQUU7WUFDL0QsT0FBTyxFQUFFLGVBQWU7WUFDeEIsSUFBSSxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUN6QixJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxpQ0FBaUMsQ0FBQyxDQUN4RDtZQUNELE9BQU8sRUFBRSxNQUFNLENBQUMsT0FBTyxDQUFDLFdBQVc7WUFDbkMsV0FBVyxFQUFFO2dCQUNYLGtCQUFrQixFQUFFLEtBQUssRUFBRSxlQUFlLEVBQUUsUUFBUSxFQUFFLElBQUksS0FBSzthQUNoRTtZQUNELE9BQU8sRUFBRSxHQUFHLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7U0FDakMsQ0FBQyxDQUFDO1FBRUgsaUNBQWlDO1FBQ2pDLFlBQVksQ0FBQyxlQUFlLENBQzFCLElBQUksR0FBRyxDQUFDLGVBQWUsQ0FBQztZQUN0QixPQUFPLEVBQUUsQ0FBQyxzQkFBc0IsQ0FBQztZQUNqQyxTQUFTLEVBQUUsQ0FBQyxHQUFHLENBQUMsRUFBRSxzREFBc0Q7U0FDekUsQ0FBQyxDQUNILENBQUM7UUFDRixLQUFLLE1BQU0sUUFBUSxJQUFJLEtBQUssRUFBRSxTQUFTLEVBQUU7WUFDdkMsTUFBTSxhQUFhLEdBQUc7Z0JBQ3BCLFVBQVUsRUFBRSxHQUFHLENBQUMsY0FBYyxDQUFDLE1BQU0sQ0FDbkMsR0FBRyxDQUFDLGtCQUFrQixDQUFDLFlBQVksQ0FBQztvQkFDbEMsU0FBUyxFQUFFLENBQUMsUUFBUSxDQUFDO2lCQUN0QixDQUFDLENBQ0g7Z0JBQ0QsU0FBUyxFQUFFLEdBQUcsQ0FBQyxjQUFjLENBQUMsTUFBTSxDQUNsQyxHQUFHLENBQUMsa0JBQWtCLENBQUMsWUFBWSxDQUFDO29CQUNsQyxTQUFTLEVBQUUsQ0FBQyxZQUFZLENBQUM7aUJBQzFCLENBQUMsQ0FDSDtnQkFDRCxhQUFhLEVBQUUsR0FBRyxDQUFDLGNBQWMsQ0FBQyxNQUFNLENBQ3RDLEdBQUcsQ0FBQyxrQkFBa0IsQ0FBQyxZQUFZLENBQUM7b0JBQ2xDLFNBQVMsRUFBRSxDQUFDLFdBQVcsQ0FBQztpQkFDekIsQ0FBQyxDQUNIO2dCQUNELFNBQVMsRUFBRSxHQUFHLENBQUMsY0FBYyxDQUFDLE1BQU0sQ0FDbEMsR0FBRyxDQUFDLGtCQUFrQixDQUFDLFlBQVksQ0FBQztvQkFDbEMsU0FBUyxFQUFFLENBQUMsS0FBSyxDQUFDO2lCQUNuQixDQUFDLENBQ0g7YUFDRixDQUFDO1lBRUYsUUFBUSxDQUFDLGVBQWUsQ0FDdEIsSUFBSSxZQUFZLENBQUMsa0JBQWtCLENBQUMsWUFBWSxFQUFFO2dCQUNoRCwyQkFBMkIsRUFBRTtvQkFDM0IsT0FBTyxFQUFFLEdBQUcsQ0FBQyxjQUFjLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxNQUFNLElBQUksYUFBYSxDQUFDO2lCQUNsRTthQUNGLENBQUMsQ0FDSCxDQUFDO1lBRUYsUUFBUSxDQUFDLFlBQVksQ0FBQyxZQUFZLENBQUMsQ0FBQztTQUNyQztJQUNILENBQUM7Ozs7QUE3RFUsb0RBQW9CIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0ICogYXMgcGF0aCBmcm9tICdwYXRoJztcbmltcG9ydCAqIGFzIGNkayBmcm9tICdhd3MtY2RrLWxpYic7XG5pbXBvcnQgKiBhcyBpYW0gZnJvbSAnYXdzLWNkay1saWIvYXdzLWlhbSc7XG5pbXBvcnQgKiBhcyBsYW1iZGEgZnJvbSAnYXdzLWNkay1saWIvYXdzLWxhbWJkYSc7XG5pbXBvcnQgKiBhcyBzbnMgZnJvbSAnYXdzLWNkay1saWIvYXdzLXNucyc7XG5pbXBvcnQgeyBGaWx0ZXJPclBvbGljeSB9IGZyb20gJ2F3cy1jZGstbGliL2F3cy1zbnMnO1xuaW1wb3J0ICogYXMgc3Vic2NyaXB0aW9uIGZyb20gJ2F3cy1jZGstbGliL2F3cy1zbnMtc3Vic2NyaXB0aW9ucyc7XG5pbXBvcnQgeyBDb25zdHJ1Y3QgfSBmcm9tICdjb25zdHJ1Y3RzJztcblxuZXhwb3J0IGludGVyZmFjZSBMYW1iZGFFcnJvclNuc1NlbmRlclByb3BzIGV4dGVuZHMgY2RrLlN0YWNrUHJvcHMge1xuICByZWFkb25seSBzbnNUb3BpY3M6IHNucy5Ub3BpY1tdO1xuICByZWFkb25seSBtYXhOdW1iZXJPZkxvZ3M/OiBudW1iZXI7XG4gIHJlYWRvbmx5IGZpbHRlcj86IHtcbiAgICBbYXR0cmlidXRlOiBzdHJpbmddOiBGaWx0ZXJPclBvbGljeTtcbiAgfTtcbn1cblxuZXhwb3J0IGNsYXNzIExhbWJkYUVycm9yU25zU2VuZGVyIGV4dGVuZHMgQ29uc3RydWN0IHtcbiAgY29uc3RydWN0b3Ioc2NvcGU6IENvbnN0cnVjdCwgaWQ6IHN0cmluZywgcHJvcHM6IExhbWJkYUVycm9yU25zU2VuZGVyUHJvcHMpIHtcbiAgICBzdXBlcihzY29wZSwgaWQpO1xuXG4gICAgaWYgKCFwcm9wcy5zbnNUb3BpY3MgfHwgcHJvcHM/LnNuc1RvcGljcy5sZW5ndGggPT09IDApIHtcbiAgICAgIHRocm93IG5ldyBFcnJvcignTm8gU05TIFRvcGljcyBwcm92aWRlZCcpO1xuICAgIH1cblxuICAgIGNvbnN0IHNuc0Vycm9yRnVuYyA9IG5ldyBsYW1iZGEuRnVuY3Rpb24odGhpcywgJ2xhbWJkYVNuc0Vycm9yJywge1xuICAgICAgaGFuZGxlcjogJ2luZGV4LmhhbmRsZXInLFxuICAgICAgY29kZTogbGFtYmRhLkNvZGUuZnJvbUFzc2V0KFxuICAgICAgICBwYXRoLmpvaW4oX19kaXJuYW1lLCAnLi4vbGliL2Z1bmN0aW9ucy9sYW1iZGFTbnNFcnJvcicpLFxuICAgICAgKSxcbiAgICAgIHJ1bnRpbWU6IGxhbWJkYS5SdW50aW1lLk5PREVKU18xOF9YLFxuICAgICAgZW52aXJvbm1lbnQ6IHtcbiAgICAgICAgTUFYX05VTUJFUl9PRl9MT0dTOiBwcm9wcz8ubWF4TnVtYmVyT2ZMb2dzPy50b1N0cmluZygpID8/ICcxMDAnLFxuICAgICAgfSxcbiAgICAgIHRpbWVvdXQ6IGNkay5EdXJhdGlvbi5taW51dGVzKDEpLFxuICAgIH0pO1xuXG4gICAgLy9ncmFuZCBhY2Nlc3MgdG8gY2xvdWR3YXRjaCBsb2dzXG4gICAgc25zRXJyb3JGdW5jLmFkZFRvUm9sZVBvbGljeShcbiAgICAgIG5ldyBpYW0uUG9saWN5U3RhdGVtZW50KHtcbiAgICAgICAgYWN0aW9uczogWydsb2dzOkZpbHRlckxvZ0V2ZW50cyddLFxuICAgICAgICByZXNvdXJjZXM6IFsnKiddLCAvLyBJIGRvIG5vdCBrbm93IHdoaWNoIHJlc291cmNlcyBJIHdpbGwgbmVlZCB0byBhY2Nlc3NcbiAgICAgIH0pLFxuICAgICk7XG4gICAgZm9yIChjb25zdCBzbnNUb3BpYyBvZiBwcm9wcz8uc25zVG9waWNzKSB7XG4gICAgICBjb25zdCBkZWZhdWx0RmlsdGVyID0ge1xuICAgICAgICBNZXRyaWNOYW1lOiBzbnMuRmlsdGVyT3JQb2xpY3kuZmlsdGVyKFxuICAgICAgICAgIHNucy5TdWJzY3JpcHRpb25GaWx0ZXIuc3RyaW5nRmlsdGVyKHtcbiAgICAgICAgICAgIGFsbG93bGlzdDogWydFcnJvcnMnXSxcbiAgICAgICAgICB9KSxcbiAgICAgICAgKSxcbiAgICAgICAgTmFtZXNwYWNlOiBzbnMuRmlsdGVyT3JQb2xpY3kuZmlsdGVyKFxuICAgICAgICAgIHNucy5TdWJzY3JpcHRpb25GaWx0ZXIuc3RyaW5nRmlsdGVyKHtcbiAgICAgICAgICAgIGFsbG93bGlzdDogWydBV1MvTGFtYmRhJ10sXG4gICAgICAgICAgfSksXG4gICAgICAgICksXG4gICAgICAgIFN0YXRpc3RpY1R5cGU6IHNucy5GaWx0ZXJPclBvbGljeS5maWx0ZXIoXG4gICAgICAgICAgc25zLlN1YnNjcmlwdGlvbkZpbHRlci5zdHJpbmdGaWx0ZXIoe1xuICAgICAgICAgICAgYWxsb3dsaXN0OiBbJ1N0YXRpc3RpYyddLFxuICAgICAgICAgIH0pLFxuICAgICAgICApLFxuICAgICAgICBTdGF0aXN0aWM6IHNucy5GaWx0ZXJPclBvbGljeS5maWx0ZXIoXG4gICAgICAgICAgc25zLlN1YnNjcmlwdGlvbkZpbHRlci5zdHJpbmdGaWx0ZXIoe1xuICAgICAgICAgICAgYWxsb3dsaXN0OiBbJ1NVTSddLFxuICAgICAgICAgIH0pLFxuICAgICAgICApLFxuICAgICAgfTtcblxuICAgICAgc25zVG9waWMuYWRkU3Vic2NyaXB0aW9uKFxuICAgICAgICBuZXcgc3Vic2NyaXB0aW9uLkxhbWJkYVN1YnNjcmlwdGlvbihzbnNFcnJvckZ1bmMsIHtcbiAgICAgICAgICBmaWx0ZXJQb2xpY3lXaXRoTWVzc2FnZUJvZHk6IHtcbiAgICAgICAgICAgIFRyaWdnZXI6IHNucy5GaWx0ZXJPclBvbGljeS5wb2xpY3kocHJvcHMuZmlsdGVyID8/IGRlZmF1bHRGaWx0ZXIpLFxuICAgICAgICAgIH0sXG4gICAgICAgIH0pLFxuICAgICAgKTtcblxuICAgICAgc25zVG9waWMuZ3JhbnRQdWJsaXNoKHNuc0Vycm9yRnVuYyk7XG4gICAgfVxuICB9XG59XG4iXX0=

package.json

@@ -46,3 +46,3 @@ {
     "@typescript-eslint/parser": "^5",
-    "aws-cdk-lib": "2.67.0",
+    "aws-cdk-lib": "2.91.0",
     "constructs": "10.0.5",
@@ -70,3 +70,3 @@ "esbuild": "^0.19.2",
   "peerDependencies": {
-    "aws-cdk-lib": "^2.67.0",
+    "aws-cdk-lib": "^2.91.0",
     "constructs": "^10.0.5"
@@ -89,3 +89,3 @@ },
   "license": "Apache-2.0",
-  "version": "0.0.35",
+  "version": "0.0.36",
   "types": "lib/index.d.ts",
@@ -100,3 +100,3 @@ "stability": "stable",
           "groupId": "io.github.serverlesslife",
-          "artifactId": "LambdaErrorSnsSender`"
+          "artifactId": "LambdaErrorSnsSender"
         }
@@ -103,0 +103,0 @@ },

README.md

@@ -1,1 +0,8 @@
-# replace this
+# Lambda Error SNS Sender
+
+## A simple solution to improve the CloudWatch alarm to receive Lambda error details by email. Available as CDK construct or as CloudFormation.
+
+How does it work:
+- Lambda is subscribed to the SNS topic where you receive your alarms. There is a message body subscription filter that limits errors based on the Lambda error metric. If you defied your metic in some other way, not the default one, you will have to change that filter.
+- Lambda analyzes the message, finds a log of the failed Lambda, and queries the log for the period that the metic was configured, plus some additional safety time, so we do not miss that error message. It extracts just a number of errors that can fit in one SNS message.
+ -Lambda sends errors to the same SNS you use for alerts. So apart from the common Alarm message, you will receive an additional one with error messages.

No alert changes

Improved metrics

Total package byte prevSize

206357

increased by17.25%

Number of package files

33

increased by50%

Lines of code

918

increased by45.25%

Number of lines in readme file

9

increased by800%

No dependency changes