log_monitor

An API and CLI for remote node server monitoring, includes text coloring capabilities.

Monitor stdout and stderr while highlighting important information remotely.

Installation

    npm install -g log_monitor			

Usage

Opening and closing a port for remote monitoring

 
    const logServer = require("log_monitor");
    
    logServer.openLog(8000)
    .then(()=>{
        //handle open
    })	
    .catch((err)=>{
        //handle error
    });
 
    logServer.closeLog()			
    .then(()=>{
        //handle close
    })
    .catch((err)=>{
        //handle error
    });
 

Connecting to an open port from command line

    log_monitor connect 8.8.8.8 8000	

Linking a color specification:

color.json

 
    {
        "ERROR:[0-9]" : {
            "fg" :"#343434",
            "bg" : "#FF4444",		
            "style" : "bold"
        },
        "CREDIT CARD READER" : {
            "fg" : "#808000",
            "style" : "underline"
        }
    }
 

invocation

    log_monitor connect 8.8.8.8 8000 --color color.json			

Events

socket_open
        socket : A net.Socket Object of connected TCP Socket socket docs

socket_closed
        socket : A net.Socket Object of connected TCP Socket socket docs

socket_data
        socket : A net.Socket Object of connected TCP Socket socket docs
        data: A byte buffer containing data sent by above socket

socket_error
        socket : A net.Socket Object of connected TCP Socket socket docs
        err: Some error

server_error.
        err : Some error

 
    const logServer = require("log_monitor");	
 
    logServer.on("socket_opened",(socket)=>{
        //handle connection
    });
 
    logServer.on("socket_closed",(socket)=>{
        //handle disconnect
    });
 
    logServer.on("socket_data",(socket,data)=>{
        //handle socket data
    });
 
    logServer.on("socket_error",(socket,err)=>{
        //handle error
    });
 
    logServer.on("server_error",(err)=>{
        //handle server error
    });
 
 

DOCS

require("log_monitor").openLog(port)
   Description:
        Opens a TCP server on the input port for API.
   Arguments:
        port : Desired port number for log server.
   Return:
        A promise that resolves when the TCP server is successfully instantiated.

require("log_monitor").closeLog()
   Description:
        Closes TCP server opened by call to openLog - fails if server has not been open.
   Arguments:
        N/A
   Return:
        A promise that resolves when the TCP server is successfully closed.