iot-monitoring-log-lib-node v1.0.4

IronOne Monitoring Logger Node JS

This repository contains Node JS logger library that can be used to write logs entries to Amazon DynamoDB. The logs can be viewed and searched using IronOne monitoring tool.

How do I get set up?

This is a Node JS library. You can easily configure it to use it in your application. Please go through the following setup and examples.

Install the required Node packages

Run the following command to install required node packages in your project working directory.

npm install

Config section

{
  environment: "Development",
  module: "TestModule",
  useAWSCredentials: true,
  awsCredentials: {
    idKey: "<KeyIdHere>",
    accessKey: "<AccessKeyHere>",
    region: "us-east-1"
  },
  minimumLogLevel: "Trace",
  tableName: "theXchange-Monitoring"
}

Using the logger

  //Importing the IronOne logger
  const IronOneLogger = require('./ironone-logger');

  //create Config file
  const logConfig = {
    environment: "Development",
    module: "TestModule",
    useAWSCredentials: true,
    awsCredentials: {
      idKey: "<KeyIdHere>",
      accessKey: "<AccessKeyHere>",
      region: "us-east-1"
    },
    minimumLogLevel: "Trace",
    tableName: "theXchange-Monitoring"
  };

  //Creating a logger instance
  const logger = new IronOneLogger("ironone-logger-test",logConfig);

  async function loggetTestFunction() {
    // or use logger.logTraceSync for none async calls.
    await logger.logTrace({functionName: "loggetTestFunction",
                    userID: "1",
                    message: "node log message suresh",
                    description: "mesg description",
                    metaData: "node meta data"});

    await logger.logDebug({functionName: "loggetTestFunction",
                    userID: "2",
                    message: "node log message suresh",
                    description: "mesg description",
                    metaData: "node meta data"});

    await logger.logInformation({functionName: "loggetTestFunction",
                    userID: "3",
                    message: "node log message suresh",
                    description: "mesg description",
                    metaData: "node meta data"});

    await logger.logWarning({functionName: "loggetTestFunction",
                    userID: "4",
                    message: "node log message suresh",
                    description: "mesg description",
                    metaData: "node meta data"});

    await logger.logError({functionName: "loggetTestFunction",
                    userID: "5",
                    message: "node log message suresh",
                    description: "mesg description",
                    metaData: "node meta data"});

    await logger.logCritical({functionName: "loggetTestFunction",
                    userID: "6",
                    message: "node log message suresh",
                    description: "mesg description",
                    metaData: "node meta data"});

    try {
      throw new Error('iot manual error')
    } catch (e) {

      await logger.logError({functionName: "loggetTestFunction",
                      userID: "345",
                      description: "mesg description",
                      metaData: "exception will occour",
                      error: e});
    } finally {

    }
  }