add option for lambda log retention period

mapbox · Jul 29, 2024 · 24e5bfa · 24e5bfa
1 parent 7d8096a
commit 24e5bfa
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 32 deletions.
diff --git a/lib/shortcuts/api.md b/lib/shortcuts/api.md
@@ -422,6 +422,7 @@ Log Group, a Role, an Alarm on function errors, and the Lambda Function itself.
 | [options.EvaluateLowSampleCountPercentile] | <code>String</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile). |
 | [options.ExtendedStatistic] | <code>String</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic)] |
 | [options.OKActions] | <code>Array.&lt;String&gt;</code> |  | See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions). |
+| [options.LogRetentionInDays] | <code>Number</code> | <code>14</code> | How long to retain CloudWatch logs for this Lambda function. See [AWS Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) for allowed values. |
 
 **Example**  
 ```js

diff --git a/lib/shortcuts/lambda.js b/lib/shortcuts/lambda.js
@@ -46,6 +46,7 @@ const ServiceRole = require('./service-role');
  * @param {String} [options.EvaluateLowSampleCountPercentile=undefined] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile).
  * @param {String} [options.ExtendedStatistic=undefined] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic)]
  * @param {Array<String>} [options.OKActions=undefined] - See [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions).
+ * @param {Number} [options.LogRetentionInDays=14] - How long to retain CloudWatch logs for this Lambda function. See [AWS Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) for allowed values.
  *
  * @example
  * const cf = require('@mapbox/cloudfriend');
@@ -104,7 +105,8 @@ class Lambda {
       TreatMissingData = 'notBreaching',
       EvaluateLowSampleCountPercentile,
       ExtendedStatistic,
-      OKActions
+      OKActions,
+      LogRetentionInDays = 14
     } = options;
 
     if (options.EvaluationPeriods < Math.ceil(Timeout / Period))
@@ -138,7 +140,7 @@ class Lambda {
           LogGroupName: {
             'Fn::Sub': ['/aws/lambda/${name}', { name: FunctionName }]
           },
-          RetentionInDays: 14
+          RetentionInDays: LogRetentionInDays
         }
       },
 

diff --git a/test/fixtures/shortcuts/lambda-full.json b/test/fixtures/shortcuts/lambda-full.json
@@ -6,10 +6,7 @@
   "Mappings": {},
   "Conditions": {
     "Always": {
-      "Fn::Equals": [
-        "1",
-        "1"
-      ]
+      "Fn::Equals": ["1", "1"]
     }
   },
   "Resources": {
@@ -28,7 +25,7 @@
             }
           ]
         },
-        "RetentionInDays": 14
+        "RetentionInDays": 30
       }
     },
     "MyLambda": {
@@ -52,9 +49,7 @@
         "FunctionName": "my-function",
         "Handler": "index.something",
         "KmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/fake",
-        "Layers": [
-          "arn:aws:fake:layer/abc"
-        ],
+        "Layers": ["arn:aws:fake:layer/abc"],
         "MemorySize": 512,
         "ReservedConcurrentExecutions": 10,
         "Runtime": "nodejs18.x",
@@ -63,12 +58,8 @@
           "Mode": "Active"
         },
         "VpcConfig": {
-          "SecurityGroupIds": [
-            "sg-12345"
-          ],
-          "SubnetIds": [
-            "fake"
-          ]
+          "SecurityGroupIds": ["sg-12345"],
+          "SubnetIds": ["fake"]
         },
         "Tags": [
           {
@@ -77,10 +68,7 @@
           }
         ],
         "Role": {
-          "Fn::GetAtt": [
-            "MyLambdaRole",
-            "Arn"
-          ]
+          "Fn::GetAtt": ["MyLambdaRole", "Arn"]
         }
       }
     },
@@ -90,9 +78,7 @@
       "Properties": {
         "AlarmName": "my-alarm",
         "AlarmDescription": "some alarm",
-        "AlarmActions": [
-          "[email protected]"
-        ],
+        "AlarmActions": ["[email protected]"],
         "Period": 120,
         "EvaluationPeriods": 2,
         "DatapointsToAlarm": 1,
@@ -101,9 +87,7 @@
         "ComparisonOperator": "LessThanThreshold",
         "TreatMissingData": "breaching",
         "EvaluateLowSampleCountPercentile": "ignore",
-        "OKActions": [
-          "[email protected]"
-        ],
+        "OKActions": ["[email protected]"],
         "Namespace": "AWS/Lambda",
         "Dimensions": [
           {
@@ -134,10 +118,7 @@
               "Effect": "Allow",
               "Action": "logs:*",
               "Resource": {
-                "Fn::GetAtt": [
-                  "MyLambdaLogs",
-                  "Arn"
-                ]
+                "Fn::GetAtt": ["MyLambdaLogs", "Arn"]
               }
             }
           ]
@@ -180,4 +161,4 @@
     }
   },
   "Outputs": {}
-}
+}
diff --git a/test/shortcuts.test.js b/test/shortcuts.test.js
@@ -190,7 +190,8 @@ test('[shortcuts] lambda', (assert) => {
     TreatMissingData: 'breaching',
     EvaluateLowSampleCountPercentile: 'ignore',
     ExtendedStatistics: 'p100',
-    OKActions: ['[email protected]']
+    OKActions: ['[email protected]'],
+    LogRetentionInDays: 30
   });
 
   template = cf.merge(