Report error status if invocation fails (#44)

* Report error status if invocation fails

* Change package version

Author: kkuzmin

al_aws_collector.js

@@ -4,7 +4,7 @@
  *
  * Base class for AWS Lambda based collectors.
  *
- * Last message ID: AWSC0010
+ * Last message ID: AWSC0011
  * @end
  * -----------------------------------------------------------------------------
  */
@@ -120,31 +120,46 @@ class AlAwsCollector {
     done(error) {
         let context = this._invokeContext;
         if (error) {
-            // The lambda context tires to stringify errors, so we should check if they can be stringified before we pass them to the context
+            // The lambda context tries to stringify errors, 
+            // so we should check if they can be stringified before we pass them to the context
+            let errorString;
             try{
-                const stringifiedError = JSON.stringify(error);
-                return context.fail(error);
+                errorString = JSON.stringify(error);
             }
             catch (stringifyError){
                 // Can't stringify the whole error, so lets try and get some useful info from it
-                let errorString;
-
-                if (error.toJSON){
-                    errorString = error.toJSON();
-                } else if (error.message){
-                    errorString = error.message;
-                } else {
-                    // when all else fails, stringify it the gross way with inspect
-                    errorString = util.inspect(error);
-                }
-
-                return context.fail(errorString);
+                errorString = error.toJSON ? error.toJSON() :
+                    error.message ? error.message :
+                        // when all else fails, stringify it the gross way with inspect
+                        util.inspect(error);
             }
+            const status = this.prepareErrorStatus(errorString);
+            this.sendStatus(status, (sendError) => {
+                console.warn('AWSC0011 Collector status send failed', sendError);
+                context.fail(errorString);
+            });
         } else {
             return context.succeed();
         }
     }
 
+    prepareErrorStatus(errorString, streamName = 'error', collectionType) {
+        let cType = collectionType ? collectionType : this._ingestType;
+        return {
+            stream_name: streamName,
+            status_type: 'error',
+            stream_type: 'collector',
+            message_type: 'collector_status',
+            host_uuid: this._collectorId,
+            data: [
+                {error: errorString}
+            ],
+            agent_type: this._collectorType,
+            collection_type: cType,
+            timestamp: moment().unix()
+        };
+    }
+    
     getProperties() {
         return {
             awsAccountId : m_alAws.arnToAccId(this._arn),
@@ -353,6 +368,28 @@ class AlAwsCollector {
             });
     }
 
+    sendStatus(status, callback) {
+        let collector = this;
+        
+        if(!status){
+            return callback(null);
+        } else {
+            zlib.deflate(JSON.stringify([status]), function(compressionErr, compressed) {
+                if (compressionErr) {
+                    return callback(compressionErr);
+                } else {
+                    collector._ingestc.sendAgentstatus(compressed)
+                    .then(resp => {
+                        return callback(null, resp);
+                    })
+                    .catch(exception => {
+                        return callback(exception);
+                    });
+                }
+            });
+        }
+    }
+    
     send(data, compress = true, callback) {
         var collector = this;
 
@@ -416,7 +453,7 @@ class AlAwsCollector {
                 collector._formatFun(event, context, asyncCallback);
             },
             function(formattedData, compress, asyncCallback) {
-                if(arguments.length === 2 && typeof compress === "function"){
+                if(arguments.length === 2 && typeof compress === 'function'){
                     asyncCallback = compress;
                     compress = true;
                 } 
@@ -427,7 +464,7 @@ class AlAwsCollector {
     }
 
     processLog(messages, formatFun, hostmetaElems, callback) {
-        if(arguments.length === 3 && typeof hostmetaElems === "function"){
+        if(arguments.length === 3 && typeof hostmetaElems === 'function'){
             callback = hostmetaElems;
             hostmetaElems = this._defaultHostmetaElems();
         } 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alertlogic/al-aws-collector-js",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "license": "MIT",
   "description": "Alert Logic AWS Collector Common Library",
   "repository": {
@@ -33,7 +33,7 @@
     "sinon": "^7.5.0"
   },
   "dependencies": {
-    "@alertlogic/al-collector-js": "1.4.3",
+    "@alertlogic/al-collector-js": "1.4.4",
     "cfn-response": "1.0.1",
     "async": "3.0.1",
     "moment": "2.24.0",

test/al_aws_collector_test.js

@@ -399,6 +399,8 @@ describe('al_aws_collector tests', function() {
         var ingestCSecmsgsStub;
         var ingestCVpcFlowStub;
         var ingestCLogmsgsStub;
+        var ingestCAgentstatusStub;
+        
         beforeEach(function() {
             ingestCSecmsgsStub = sinon.stub(m_alCollector.IngestC.prototype, 'sendSecmsgs').callsFake(
                 function fakeFn(data, callback) {
@@ -420,12 +422,20 @@ describe('al_aws_collector tests', function() {
                             resolve(null);
                         });
                     });
+            
+            ingestCAgentstatusStub = sinon.stub(m_alCollector.IngestC.prototype, 'sendAgentstatus').callsFake(
+                    function fakeFn(data, callback) {
+                        return new Promise (function(resolve, reject) {
+                            resolve(null);
+                        });
+                    });
         });
 
         afterEach(function() {
             ingestCSecmsgsStub.restore();
             ingestCVpcFlowStub.restore();
             ingestCLogmsgsStub.restore();
+            ingestCAgentstatusStub.restore();
         });
 
         it('dont send if data is falsey', function(done) {
@@ -625,13 +635,17 @@ describe('al_aws_collector tests', function() {
             assert.ok(doneResult);
         });
 
-        it('returns errors that can be stringified in their raw state', () => {
+        it('returns errors that can be stringified in their raw state', (done) => {
             const stringifialbleError = {
                 foo: "bar"
             };
             const testContext = {
                 succeed: () => true,
-                fail: (error) => error
+                fail: (error) => {
+                    assert.equal(error, JSON.stringify(stringifialbleError));
+                    done();
+                }
+
             };
 
             collector = new AlAwsCollector(
@@ -642,16 +656,19 @@ describe('al_aws_collector tests', function() {
                 colMock.AIMS_TEST_CREDS
             );
 
-            const doneResult = collector.done(stringifialbleError);
-            assert.ok(doneResult === stringifialbleError);
+            collector.done(stringifialbleError);
         });
 
         it('returns errors that cannot be JSON stringified as a string', () => {
             const circRefError = {};
             circRefError.foo = circRefError;
             const testContext = {
                 succeed: () => true,
-                fail: (error) => error
+                fail: (error) => {
+                    assert.notEqual(error, circRefError);
+                    assert.ok(typeof error === 'string');
+                    assert.equal(error, '{ foo: [Circular] }');
+                }
             };
 
             collector = new AlAwsCollector(
@@ -662,9 +679,7 @@ describe('al_aws_collector tests', function() {
                 colMock.AIMS_TEST_CREDS
             );
 
-            const doneResult = collector.done(circRefError);
-            assert.ok(doneResult !== circRefError);
-            assert.ok(typeof doneResult === 'string');
+            collector.done(circRefError);
         });
     });