serverless-plugin-warmup 7.0.2 → 7.1.0

package/README.md

@@ -44,6 +44,7 @@ custom:
       events:
         - schedule: cron(0/5 8-17 ? * MON-FRI *)
       concurrency: 10
+      verbose: true
       logRetentionInDays: 10
     outOfOfficeHoursWarmer:
       enabled: true
@@ -52,6 +53,7 @@ custom:
         - schedule: cron(0/5 18-23 ? * MON-FRI *)
         - schedule: cron(0/5 * ? * SAT-SUN *)
       concurrency: 1
+      verbose: false
     testWarmer:
       enabled: false
 ```
@@ -70,6 +72,7 @@ The options are the same for all the warmers:
 * **timeout** How many seconds until the warmer lambda times out. (defaults to `10`)
 * **environment** Can be used to set environment variables in the warmer lambda. You can also unset variables configured at the provider by setting them to undefined. However, you should almost never have to change the default. (defaults to unset all package level environment variables. )
 * **tracing** Specify whether to enable/disable tracing at the function level. When tracing is enabled, warmer functions will use NPM to install the X-Ray client and use it to trace requests (It takes any of the values supported by serverless as `boolean`, `Active`or `PassThrough` and defaults to the provider-level setting)
+* **verbose** If set to false, it disables the console.logs placed on this warmer lambda (defaults to `true`)
 * **logRetentionInDays** Set the retention time in days for the log group associated to this warmer lamba
 * **prewarm** If set to true, it warms up your lambdas right after deploying (defaults to `false`)
 
@@ -106,6 +109,7 @@ custom:
           - ./**
       timeout: 20
       tracing: true
+      verbose: false # Disable the logs
       logRetentionInDays: 10
       prewarm: true # Run WarmUp immediately after a deploymentlambda
       clientContext:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-warmup",
-  "version": "7.0.2",
+  "version": "7.1.0",
   "description": "Keep your lambdas warm during winter.",
   "main": "src/index.js",
   "scripts": {

package/src/config.js

@@ -41,6 +41,7 @@ function getWarmerConfig(config, defaultOpts) {
       ? config.environment
       : defaultOpts.environment,
     tracing: (config.tracing !== undefined) ? config.tracing : defaultOpts.tracing,
+    verbose: (config.verbose !== undefined) ? config.verbose : defaultOpts.verbose,
     logRetentionInDays: (config.logRetentionInDays !== undefined)
       ? config.logRetentionInDays
       : defaultOpts.logRetentionInDays,
@@ -151,6 +152,7 @@ function getConfigsByWarmer({ service, classes }, stage) {
     timeout: 10,
     environment: Object.keys(service.provider.environment || [])
       .reduce((obj, k) => ({ ...obj, [k]: undefined }), {}),
+    verbose: true,
     prewarm: false,
   });
 

package/src/index.js

@@ -204,6 +204,7 @@ class WarmUp {
     await createWarmUpFunctionArtifact(
       warmerConfig.functions,
       warmerConfig.tracing,
+      warmerConfig.verbose,
       this.provider.getRegion(),
       handlerFolder,
     );

package/src/schema.js

@@ -107,6 +107,7 @@ function extendServerlessSchema(serverless) {
     timeout: { $ref: '#/definitions/awsLambdaTimeout' },
     environment: { $ref: '#/definitions/awsLambdaEnvironment' },
     tracing: { $ref: '#/definitions/awsLambdaTracing' },
+    verbose: { type: 'boolean' },
     logRetentionInDays: {
       type: 'number',
       enum: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653],

package/src/warmer.js

@@ -94,7 +94,7 @@ function addWarmUpFunctionRoleToResources(service, stage, warmerName, warmerConf
                   'lambda:InvokeFunction',
                 ],
                 Resource: warmerConfig.functions.map((fn) => ({
-                  'Fn::Sub': `arn:\${AWS::Partition}:lambda:\${AWS::Region}:\${AWS::AccountId}:function:${fn.name}`,
+                  'Fn::Sub': `arn:\${AWS::Partition}:lambda:\${AWS::Region}:\${AWS::AccountId}:function:${fn.name}*`,
                 })),
               },
               {
@@ -125,7 +125,7 @@ function addWarmUpFunctionRoleToResources(service, stage, warmerName, warmerConf
  *
  * @return {Promise}
  * */
-async function createWarmUpFunctionArtifact(functions, tracing, region, handlerFolder) {
+async function createWarmUpFunctionArtifact(functions, tracing, verbose, region, handlerFolder) {
   const warmUpFunction = `'use strict';
 
 /** Generated by Serverless WarmUp Plugin **/
@@ -143,28 +143,32 @@ const lambda = new AWS.Lambda({
 });
 const functions = ${JSON.stringify(functions, null, '  ')};
 
+function logVerbose(str) {
+  ${verbose ? 'console.log(str);' : ''}
+}
+
 function getConcurrency(func, envVars) {
   const functionConcurrency = envVars[\`WARMUP_CONCURRENCY_\${func.name.toUpperCase().replace(/-/g, '_')}\`];
 
   if (functionConcurrency) {
     const concurrency = parseInt(functionConcurrency);
-    console.log(\`Warming up function: \${func.name} with concurrency: \${concurrency} (from function-specific environment variable)\`);
+    logVerbose(\`Warming up function: \${func.name} with concurrency: \${concurrency} (from function-specific environment variable)\`);
     return concurrency;
   }
 
   if (envVars.WARMUP_CONCURRENCY) {
     const concurrency = parseInt(envVars.WARMUP_CONCURRENCY);
-    console.log(\`Warming up function: \${func.name} with concurrency: \${concurrency} (from global environment variable)\`);
+    logVerbose(\`Warming up function: \${func.name} with concurrency: \${concurrency} (from global environment variable)\`);
     return concurrency;
   }
 
   const concurrency = parseInt(func.config.concurrency);
-  console.log(\`Warming up function: \${func.name} with concurrency: \${concurrency}\`);
+  logVerbose(\`Warming up function: \${func.name} with concurrency: \${concurrency}\`);
   return concurrency;
 }
 
 module.exports.warmUp = async (event, context) => {
-  console.log('Warm Up Start');
+  logVerbose('Warm Up Start');
 
   const invokes = await Promise.all(functions.map(async (func) => {
     const concurrency = getConcurrency(func, process.env);
@@ -186,15 +190,15 @@ module.exports.warmUp = async (event, context) => {
 
     try {
       await Promise.all(Array(concurrency).fill(0).map(async () => await lambda.invoke(params).promise()));
-      console.log(\`Warm Up Invoke Success: \${func.name}\`);
+      logVerbose(\`Warm Up Invoke Success: \${func.name}\`);
       return true;
     } catch (e) {
-      console.log(\`Warm Up Invoke Error: \${func.name}\`, e);
+      console.error(\`Warm Up Invoke Error: \${func.name}\`, e);
       return false;
     }
   }));
 
-  console.log(\`Warm Up Finished with \${invokes.filter(r => !r).length} invoke errors\`);
+  logVerbose(\`Warm Up Finished with \${invokes.filter(r => !r).length} invoke errors\`);
 }`;
 
   /** Write warm up file */