nodejs-svs-auditlog v1.0.1

NodeJS SVS Auditlog

NodeJS package for logging .

Installation

Use the package manager npm to install logger.

npm install nodejs-svs-auditlog

Usage

var logger = require("nodejs-svs-auditlog");

// Config example
const loggerConfig = {
	entities: {
		// key - name of an entity, value (string) - main field of an entity (to get entity_name). Default - {}
		trip: "name",
		user: "email",
		place: "name",
	},
	writeToFile: true, // (boolean) true - write to log file, false - write to stdout. Default - false
	field: "name", // (string) field to get from a response object to save as 'event_description'. Default "name | email"
	user: currentUser, // (string) currentUser name. Example - "ae.sypchenko". Default - " " or request.user.email if its not undefined
	file: "./src/debug.log", // (string) file you want your logs to be added to. If omitted, system will create 'debug.log' file in your root directory.
};

// add to Express.js
app.all("*", (req, res, next) => {
	logger(req, res, loggerConfig);
	next();
});

// add to NestJS
app.use("*", (req, res, next) => {
	logger(req, res, loggerConfig);
	next();
});

Log Format

{
	"timestamp": "2020-07-30T06:57:35.629Z",
	"log_type": "audit",
	"client_ip": "1",
	"username": "ae.sypchenko",
	"entity_type": "card",
	"entity_name": "Some Card",
	"event_type": "create",
	"event_message": "Some card created",
	"event_success": "true"
}