@itentialopensource/adapter-winston_syslog 1.0.1

package/adapter.js

@@ -0,0 +1,250 @@
+/* @copyright Itential, LLC 2019 (pre-modifications) */
+
+/* eslint import/no-dynamic-require: warn */
+/* eslint object-curly-newline: warn */
+/* eslint no-unused-expressions: warn */
+
+// Set globals
+/* global log */
+
+/* Required libraries.  */
+const path = require('path');
+
+/* Fetch in the other needed components for the this Adaptor */
+const AdapterBaseCl = require(path.join(__dirname, 'adapterBase.js'));
+
+/* Require winston_syslog from dependencies. */
+const winston = require('winston');
+require('winston-syslog').Syslog;
+
+/**
+ * This is the adapter/interface into Winston_syslog
+ */
+
+/* GENERAL ADAPTER FUNCTIONS */
+class WinstonSyslog extends AdapterBaseCl {
+  /**
+   * WinstonSyslog Adapter
+   * @constructor
+   */
+  /* Working on changing the way we do Emit methods due to size and time constrainsts
+  constructor(prongid, properties) {
+    // Instantiate the AdapterBase super class
+    super(prongid, properties);
+
+    const restFunctionNames = this.iapGetAdapterWorkflowFunctions();
+
+    // Dynamically bind emit functions
+    for (let i = 0; i < restFunctionNames.length; i += 1) {
+      // Bind function to have name fnNameEmit for fnName
+      const version = restFunctionNames[i].match(/__v[0-9]+/);
+      const baseFnName = restFunctionNames[i].replace(/__v[0-9]+/, '');
+      const fnNameEmit = version ? `${baseFnName}Emit${version}` : `${baseFnName}Emit`;
+      this[fnNameEmit] = function (...args) {
+        // extract the callback
+        const callback = args[args.length - 1];
+        // slice the callback from args so we can insert our own
+        const functionArgs = args.slice(0, args.length - 1);
+        // create a random name for the listener
+        const eventName = `${restFunctionNames[i]}:${Math.random().toString(36)}`;
+        // tell the calling class to start listening
+        callback({ event: eventName, status: 'received' });
+        // store parent for use of this context later
+        const parent = this;
+        // store emission function
+        const func = function (val, err) {
+          parent.removeListener(eventName, func);
+          parent.emit(eventName, val, err);
+        };
+        // Use apply to call the function in a specific context
+        this[restFunctionNames[i]].apply(this, functionArgs.concat([func])); // eslint-disable-line prefer-spread
+      };
+    }
+
+    // Uncomment if you have things to add to the constructor like using your own properties.
+    // Otherwise the constructor in the adapterBase will be used.
+    // Capture my own properties - they need to be defined in propertiesSchema.json
+    // if (this.allProps && this.allProps.myownproperty) {
+    //   mypropvariable = this.allProps.myownproperty;
+    // }
+  }
+  */
+
+  /**
+   * @callback healthCallback
+   * @param {Object} reqObj - the request to send into the healthcheck
+   * @param {Callback} callback - The results of the call
+   */
+  healthCheck(reqObj, callback) {
+    // you can modify what is passed into the healthcheck by changing things in the newReq
+    let newReq = null;
+    if (reqObj) {
+      newReq = Object.assign(...reqObj);
+    }
+    super.healthCheck(newReq, callback);
+  }
+
+  /**
+   * @callback healthCallback
+   * @param {Object} result - the result of the get request (contains an id and a status)
+   */
+  /**
+   * @callback getCallback
+   * @param {Object} result - the result of the get request (entity/ies)
+   * @param {String} error - any error that occurred
+   */
+  /**
+   * @callback createCallback
+   * @param {Object} item - the newly created entity
+   * @param {String} error - any error that occurred
+   */
+  /**
+   * @callback updateCallback
+   * @param {String} status - the status of the update action
+   * @param {String} error - any error that occurred
+   */
+  /**
+   * @callback deleteCallback
+   * @param {String} status - the status of the delete action
+   * @param {String} error - any error that occurred
+   */
+
+  /**
+   * @function postLog
+   * @pronghornType method
+   * @name postLog
+   * @summary Post a log message
+   *
+   * @param {string} severity - The log level of the message. One of: (
+   *        debug, info, notice, warning, err, crit, alert, emerg)
+   * @param {string} facility - Where to send the log message
+   * @param {string} message - The text body of the log message
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} result - A JSON Object containing status, code, and the result
+   *
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  postLog(severity, facility, message, callback) {
+    const meth = 'adapter-postLog';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (severity === undefined || severity === null || severity === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['severity'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    if (facility === undefined || facility === null || facility === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['facility'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    if (message === undefined || message === null || message === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['message'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    const validSev = [
+      'debug',
+      'info',
+      'notice',
+      'warning',
+      'error',
+      'crit',
+      'alert',
+      'emerg'
+    ];
+
+    if (!validSev.includes(severity)) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid input: invalid severity', ['postLog'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    const validFacilities = [
+      'local0',
+      'local1',
+      'local2',
+      'local3',
+      'local4',
+      'local5',
+      'local6',
+      'local7'
+    ];
+
+    if (!validFacilities.includes(facility)) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid input: invalid facility', ['postLog'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    if (typeof message !== 'string') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid input: message must be a string', ['postLog'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    try {
+      // Make the call -
+      log.debug(`${origin} - Inside winston_syslog try`);
+      const {
+        host,
+        port,
+        logProtocol,
+        type,
+        minLogLevel
+      } = this.allProps;
+
+      log.debug(`${origin} - Got winston_syslog props`);
+
+      const transport = new winston.transports.Syslog({
+        host,
+        port,
+        type,
+        facility,
+        protocol: logProtocol,
+        localhost: 'Itential'
+      });
+      log.debug(`${origin} - Created winston_syslog transport`);
+
+      const logger = winston.createLogger({
+        levels: winston.config.syslog.levels,
+        level: minLogLevel || 'info',
+        transports: [transport]
+      });
+
+      log.debug(`${origin} - Created winston_syslog logger`);
+
+      logger[severity](message);
+      log.debug(`${origin} - Sent winston log message`);
+      const successObj = {
+        status: 'success',
+        code: 200,
+        facility
+      };
+      transport.close();
+      log.debug(`${origin} - Closed winston_syslog transport`);
+      // return the response
+      return callback(successObj, null);
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.stack}`);
+      return callback(null, errorObj);
+    }
+  }
+}
+
+module.exports = WinstonSyslog;