@ui5/logger

What is @ui5/logger?

@ui5/logger is a logging library designed for use with the UI5 framework. It provides a simple and flexible way to log messages at different levels (e.g., error, warn, info, verbose, silly) and supports custom loggers and transports.

What are @ui5/logger's main functionalities?

Basic Logging

This feature allows you to create a logger instance and log messages at different levels such as info and error.

const { getLogger } = require('@ui5/logger');
const log = getLogger('myLogger');
log.info('This is an info message');
log.error('This is an error message');

Custom Log Levels

This feature allows you to define custom log levels and use them in your application.

const { getLogger, createLogger } = require('@ui5/logger');
const customLogger = createLogger({
  transports: [
    new (require('@ui5/logger').transports.Console)({
      level: 'custom'
    })
  ]
});
const log = getLogger('customLogger');
log.custom('This is a custom log level message');

Custom Transports

This feature allows you to create custom transports for logging, such as logging to the console with a specific format.

const { getLogger, createLogger, transports } = require('@ui5/logger');
const customTransport = new transports.Console({
  level: 'info',
  format: require('@ui5/logger').formats.simple()
});
const customLogger = createLogger({
  transports: [customTransport]
});
const log = getLogger('customLogger');
log.info('This is an info message with a custom transport');

Other packages similar to @ui5/logger

winston

Winston is a versatile logging library for Node.js that supports multiple transports, log levels, and formats. It is highly configurable and widely used in the Node.js community. Compared to @ui5/logger, Winston offers more flexibility and a larger ecosystem of plugins and extensions.

bunyan

Bunyan is a simple and fast JSON logging library for Node.js. It is designed for high-performance logging and provides features like log streams and serializers. Bunyan is more focused on JSON logging compared to @ui5/logger, which offers a more general-purpose logging solution.

pino

Pino is a low-overhead logging library for Node.js that focuses on performance. It provides fast logging with minimal impact on application performance. Pino is suitable for applications where performance is critical, whereas @ui5/logger provides a more feature-rich logging experience.

README

ui5-logger

Internal logging module
Part of the UI5 Tooling

Documentation

General documentation can of the UI5 Tooling can be found here: sap.github.io/ui5-tooling

UI5 Logger

Used for logging purposes across the UI5 Tooling and plugins. Features log levels and progress logging. Basically, it is a wrapper of npmlog.

Contributing

Please check our Contribution Guidelines.

Support

Please follow our Contribution Guidelines on how to report an issue.

Please report issues in the main UI5 Tooling repository.

Release History

See CHANGELOG.md.