@janiscommerce/log

log

A package for creating logs in Firehose

Installation

npm install @janiscommerce/log

Configuration

ENV variables

JANIS_SERVICE_NAME (required): The name of the service that will create the log.
JANIS_ENV (required): The name stage that will used as suffix for janis-trace-service bucket.

API

add(clientCode, log)

Parameters: clientCode [String], log [Object]
Puts the recieved log into the janis-trace-firehose

Log structure

The log [Object] parameter have the following structure:

• id [String] (optional): The ID of the log in UUID V4 format. Default will be auto-generated.
• service [String] (optional): The service name, if this field not exists, will be obtained from the ENV (JANIS_SERVICE_NAME)
• type [String] (required): The log type
• entity [String] (required): The name of the entity that is creating the log
• entityId [String] (optional): The ID of the entity that is creating the log
• message [String] (optional): A general message about the log
• log [Object|Array] (optional): This property is a JSON that includes all the technical data about your log.

Log example

{
  id: '0acefd5e-cb90-4531-b27a-e4d236f07539',
  type: 'new',
  entity: 'api',
  entity_id: 'log',
  service: 'trace',
  message: '[GET] Request from 12.345.67.89 to /log',
  date_created: 1559103066,
  log: {
    verb: 'GET',
    headers: {
      'x-forwarded-for': '12.345.67.89',
      'x-forwarded-proto': 'https',
      'x-forwarded-port': '443'
    },
    responseHttpCode: 200
  }
}

on(event, callback)

Parameters: event [String], callback [Function] Calls a callback when the specified event is emitted.

Errors

The errors are informed with a LogError.
This object has a code that can be useful for a correct error handling.
The codes are the following:

Code	Description
1	Invalid log
2	Firehose Error
3	Unknown stage name

In case of error while creating your log into S3, this package will emit an event called create-error, you can handle it using the on() method.

Usage

const Log = require('@janiscommerce/log');

Log.add('some-client', {
	type: 1,
	entity: 'api',
	entityId: 'product',
	message: '[GET] Request from 0.0.0.0 of custom_data'
	// ...
});

Log.on('create-error', (log, err) => {
	console.error(`An error occurred while creating the log ${err.message}`);
});

Changelog

[3.0.0] - 2020-01-14

Added

• Log struct and formatting

Changed

• Uploading logs to Firehose instead S3
• Log type field now can be only a string, not a number
• Snake_case fields deprecated, only camelCase