Merge pull request #9 from interisti/feature/stage-filter

add stage filter option

Author: aoskotsky-amplify

README.md

@@ -34,7 +34,10 @@ custom:
   logForwarding:
     destinationARN: '[ARN of Lambda Function to forward logs to]'
     # optional:
-    filterPattern: `[filter pattern for logs that are sent to Lambda function]'
+    filterPattern: '[filter pattern for logs that are sent to Lambda function]'
+    stages:
+      - '[name of the stage to apply log forwarding]'
+      - '[another stage name to filter]'
 ```
 
 ## Running Tests

index.js

@@ -18,6 +18,15 @@ class LogForwardingPlugin {
    * Updates CloudFormation resources with log forwarding
    */
   updateResources() {
+    // check if stage is specified in config
+    const service = this.serverless.service;
+    const stage = this.options.stage;
+    if (service.custom.logForwarding.stages &&
+      service.custom.logForwarding.stages.indexOf(stage) === -1) {
+      this.serverless.cli.log(`Log Forwarding is ignored for ${stage} stage`);
+      return;
+    }
+
     this.serverless.cli.log('Updating Log Forwarding Resources...');
     const resourceObj = this.createResourcesObj();
     if (this.serverless.service.resources === undefined) {
@@ -46,8 +55,8 @@ class LogForwardingPlugin {
     const serviceName = service.service;
     const arn = service.custom.logForwarding.destinationARN;
     const stage = options.stage && options.stage.length > 0
-                  ? options.stage
-                  : service.provider.stage;
+      ? options.stage
+      : service.provider.stage;
     // Get list of all functions in this lambda
     const functions = _.keys(service.functions);
     const principal = `logs.${service.provider.region}.amazonaws.com`;

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-log-forwarding",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "a serverless plugin to forward logs to given lambda function",
   "main": "index.js",
   "directories": {

package.json

@@ -13,6 +13,11 @@ const correctConfigWithFilterPattern = {
   destinationARN: 'arn:aws:lambda:us-moon-1:314159265358:function:testforward-test-forward',
   filterPattern: 'Test Pattern',
 };
+const correctConfigWithStageFilter = {
+  destinationARN: 'arn:aws:lambda:us-moon-1:314159265358:function:testforward-test-forward',
+  filterPattern: 'Test Pattern',
+  stages: ['production'],
+};
 const constructPluginResources = (logForwarding) => {
   const serverless = {
     service: {
@@ -279,6 +284,18 @@ describe('Given a serverless config', () => {
     plugin.updateResources();
     expect(plugin.serverless.service.resources).to.eql(expectedResources);
   });
+  it('uses stage filter if set', () => {
+    const plugin = constructPluginResources(correctConfigWithStageFilter);
+    const expectedResources = {
+      Resources: {
+        TestExistingFilter: {
+          Type: 'AWS:Test:Filter',
+        },
+      },
+    };
+    plugin.updateResources();
+    expect(plugin.serverless.service.resources).to.eql(expectedResources);
+  });
 });
 
 describe('Catching errors in serverless config ', () => {