@master4n/logger

@master4n/logger

Installation

npm install @master4n/logger

Usage

As a library

Quick Start (Node),

import { createLogger, FileTransport, HttpTransport } from '@master4n/logger';
import { fileTransport, httpTransport } from '@master4n/logger';

const logger = createLogger({ name: 'service-a', level: 'debug' });

logger.addTransport(fileTransport('./logs/service-a.log', 5 * 1024 * 1024));

// cloud transport example (server-side): secure with HMAC key stored on server
const http = httpTransport({
  url: 'https://logs.your-cloud.com/ingest',
  hmacKey: process.env.LOG_HMAC_KEY,
  batchSize: 50,
  flushIntervalMs: 2000,
});
logger.addTransport(http);

logger.info('Service started', { port: 3000, env: process.env.NODE_ENV });

Browser Usage,

import { createLogger, httpTransport } from '@master4n/logger';

const logger = createLogger({ name: 'frontend', level: 'info', json: false });
// Use server-issued bearer token for client -> cloud
const transport = httpTransport({
  url: '/api/logs',
  apiKey: 'short-lived-token',
  batchSize: 20,
});
logger.addTransport(transport);

logger.info('Page loaded', { route: window.location.href });

Framework adapters

Express (Node)

import express from 'express';
import {
  createLogger,
  expressMiddleware,
  fileTransport,
} from '@master4n/logger';

const logger = createLogger({ name: 'http', level: 'info' });
logger.addTransport(fileTransport('./logs/http.log'));

const app = express();
app.use(expressMiddleware(logger));

React

import { useLogger } from '@master4n/logger';
function MyComponent() {
  const log = useLogger('MyComponent');
  React.useEffect(() => log.info('mounted'), []);
}

Summary

This package contains logger for any application.

Credits

These definitions were written by Master4Novice.