Package Exports

@isacrodriguesdev/logger
@isacrodriguesdev/logger/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@isacrodriguesdev/logger) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Logger

Logger is a logging library for handling log messages and notifying logger targets.

Features

Logging messages to multiple targets
Customizable logger targets
Flexible payload structure

Installation

npm install @isacrodriguesdev/logger

Usage

Import the necessary classes and interfaces from the @isacrodriguesdev/logger package:

import { Logger, ILoggerTarget, ILogger } from "@isacrodriguesdev/logger";

Create a class that implements the ILoggerTarget interface to define a logger target. For example, here's an implementation using Kafka as the target:

class KafkaLog implements ILoggerTarget {
  private kafka: any; // Import the correct Kafka library here

  constructor() {
    // Initialize the connection to Kafka
    this.kafka = /* Initialize the connection to Kafka */;
  }

  notify(data: ILogger.Payload): void {
    // Send the log message to the Kafka queue
    this.kafka.sendMessage(data);
  }
}

Create an instance of the Logger class and register your logger targets:

// Create an instance of the Logger class
const logger = new Logger();

// Create instances of the logger targets you want to use
const consoleLog = new ConsoleLog(); // Example using ConsoleLog
const kafkaLog = new KafkaLog(); // Example using KafkaLog

// Register the logger targets in the Logger instance
logger.register("console", consoleLog);
logger.register("kafka", kafkaLog);

Use the notify method to send log messages to the registered logger targets:

// Create an example log payload
const payload = {
  level: "info",
  message: "This is an informational log message.",
  additionalInfo: "Some additional information",
  timestamp: Date.now(),
};

// Notify the logger to send the payload to the registered logger targets
logger.notify(["console", "kafka"], payload);

Note

The ConsoleLog target is included by default and does not need to be explicitly registered. You can simply call logger.notify(["console"], payload) to log messages to the console.

API

Logger Class

`constructor()`

Creates a new instance of the Logger class.

`notify(targets: string[], data: ILogger.Payload): void`

Notifies the specified logger targets with the log data.

targets: An array of target names to notify.
data: The log data object with the following properties:
- level: The log level, e.g., 'error', 'info', 'debug'.
- message: The log message.
- additionalInfo (optional): Additional information to include in the log.

`register(type: string, logger: ILoggerTarget): void`

Registers a logger target with the specified type.

type: The type name for the logger target.
logger: An instance of a logger target implementation.

ILogger Interface

export declare abstract class ILogger {
  public abstract notify(targets: string[], data: ILogger.Payload): void;
  public abstract register(type: string, logger: ILoggerTarget): void;
}