node-lib-logging v1.0.0

node-lib-logging

This is a general log wrapper that support multiple log providers and keep normal console as standard.

Example to consume this lib

Pass in an array of credentials according to example below, if remain empty, no log will be captured.

import Logger from '@scientiacloud/node-lib-logging';

const credentials = { provider: { logProvider: 'LogEntries', token: 'xxxxx-xxxxx-xxxxx-xxxxx-xxxxx', region: 'us', useConsole: true }, { logProvider: 'LogStash', url: 'http://localhost:9600/_bulk', } }

const logger = new Logger(credentials); logger.info('Message for testing');

- LogEntries
  1. Support flag for sending logs back to Node console.
  2. logProvider, token & region field is mandatory.
  3. region field is naming convention of sub-domain or ingestion endpoint.
    ex. us.data.logs.insight.rapid7.com

- LogStash
  1. url field is mandatory.

- log4js

## Versioning
- v1.0.0
  1. Initial commit


## NPM Package included
- r7insight_node @ 1.8.2 
- log4js @ 5.0.0
- @log4js-node/logstash-http @ 1.0.0

## Remark
###### Differences between r7insight_node and le_node

- when consuming r7insight_node, the default endpoint is point to *us/eu.data.logs.insight.rapid7.com* with ingestion endpoint.
  > both token & region is mandatory field.
- while consuming le_node, the default endpoint is point to host, *data.logentries.com*
  > only token is mandatory field.

###### Note

le_node is a deprecated npm package previously support by logEntries, while r7insight_node is fork from le_node and continue support by the team known as rapid7.

- The current library send these log to logEntries for logging purpose, and send back to core console to display locally.
- logEntries service will remain supported by rapid7.