@alaka/logger v1.3.2

Logger

Logger service for LogDNA

Installation and configuration

npm install --save @alaka/logger

Import

NodeJS

const loggerService = require('@alaka/logger');

ES6

import loggerService from '@alaka/logger';

Initialization

/**
 * @param {string} apiKey LogDNA API Ingestion key
 * @param {object} [options]
 * @param {string} [options.endpoint] LogDNA API endpoint
 * @param {string} [options.hostname='alaka.work'] App hostname
 * @param {string} [options.app='Alaka'] App name
 * @param {boolean} [options.isDevelopment=false] If TRUE -> errors are logged in console
 * @param {string[]} [options.tags=[]] Helpful for filtering

 */
const logger = loggerService(apiKey, options);

Only apiKey option is required.

API

/**
 * Log exception
 * @param {object} error Exception error object
 * @param {object} [payload] Additional data for log
 */
logger.exception(error, payload);

/**
 * @param {string} msg Error message
 * @param {object} [payload] Additional data for log
 */
logger.log(msg, payload);

/**
 * @param {string} msg Error message
 * @param {object} [payload] Additional data for log
 */
logger.info(msg, payload);

/**
 * @param {string} msg Error message
 * @param {object} [payload] Additional data for log
 */
logger.warn(msg, payload);

/**
 * @param {string} msg Error message
 * @param {object} [payload] Additional data for log
 */
logger.debug(msg, payload);

/**
 * @param {string} msg Error message
 * @param {object} [payload] Additional data for log
 */
logger.error(msg, payload);

/**
 * @param {string} msg Error message
 * @param {object} [payload] Additional data for log
 */
logger.fatal(msg, payload);