audit-service v1.0.0

audit-service

audit-service - Activity Saving library working as an interface to the audit-service(Node.js)

Installation

"dependencies": {
  "audit-service": "~1.0.0" // see the "releases" section
}

This package communicates with the audit-service in two ways.
1. Queue(RabbitMQ)
2. API //Not Available Yet

npm install audit-service

Requirements

• Using Queue
• Using API

AUDIT_SERVICE_URL=http://

Initialization

const audit = require('audit-service');

###Initialization

• To initialize without a queue instance

await audit.init({
     clientId: "client-id",
     queueUrl: "amqp://localhost",
     appName: "audit-trail-test",
 });

• To initialize using a queue Instance

const rabbitMQ = new RabbitMQ();
await rabbitMQ.init("amqp://localhost");
await audit.init({
     clientId: "client-id",
     appName: "audit-trail-test",
     queueName: "audit_queue", //default is "audits"
     queueInstance: rabbitMQ,
 });

Basic functionality

• To Save a trail

audit.trail("You signed in", "Login", {
    clientId: "override-client-id", //this will override the init clientId
    name: "User Name",
    data: "any other day"
})
.then(res => console.log(res))
.catch(err => console.log(err));
///res -     {"status":true,"mode":"queue","payload":{"service":"audits","message":"An Activity Occurred","action":"Activity","timestamp":1592910388535},"queueResponse":true}

or

const res = audit.trail("You signed in", "Login", {
    clientId: "override-client-id", //this will override the init clientId
    name: "User Name",
    data: "any other day",
});
console.log(res);
///res -     {"status":true,"mode":"queue","payload":{"service":"audits","message":"An Activity Occurred","action":"Activity","timestamp":1592910388535},"queueResponse":true}

Tests

Cli

npm install
npm test

Contributors

• Micheal Akinwonmi