@volumax/logger

With this simple Logger-Module, it is easy as nothing to create perfect Log-Messages

Installation

To use this simple Logger you need to include the npm package into your development projekt. To do so you can use following commands:

cd <yourProjectFolder>
npm install @volumax/logger

Getting Started

When the node-module is installed you can import the Log into your project.

import { Log } from '@volumax/log'

After that you need to initialise the logger by creating a new instance of it.

const log = new Log(logConfig)

The log requires a config-object. In this object you need to specify weather you like to run the Log in 'development' mode where logs are also logged to the console. When you choose 'production' mode, nothing is logged to the console and every log message is only keept in the log itself. The second parameter you can specify is the maximum number of logMessages which should be stored. This is an optional parameter. If you do not specify the maximum number of LogMessages all log messages stay stored. However if you choose to limit the log-size to a certain number (e.g. for storage size reason) only the last x log messages will be stored and every time you push another message in the log the oldest one gets deleted.

const logConfig = {
    environment: 'development' | 'production',
    maxLogCount: number //optional
}

Methods

When the Log is instantiated you have a few methods to interact with the Log.

trace(message: string)

A method to get a new log entry with an log level of trace into the log. When successfully logged the method returns the internal id of the log.

debug(message: string)

A method to get a new log entry with an log level of debug into the log. When successfully logged the method returns the internal id of the log.

info(message: string)

A method to get a new log entry with an log level of info into the log. When successfully logged the method returns the internal id of the log.

warn(message: string)

A method to get a new log entry with an log level of warn into the log. When successfully logged the method returns the internal id of the log.

error(message: string)

A method to get a new log entry with an log level of error into the log. When successfully logged the method returns the internal id of the log.

fatal(message: string)

A method to get a new log entry with an log level of fatal into the log. When successfully logged the method returns the internal id of the log.

messageById(id: number)

This method returns on specific log entry based on the id of the log.

messageByTimeSlot(timeSlot: object)

This method returns an array of log entries where the timestamp of the log entry is between the specified startDate and endDate.

timeSlot = {
   startDate: Date
   endDate: Date
}

messageByLogLevel(logLevel: string)

This method returns all the log entries which are at a specific log level.

messageAboveLogLevel(logLevel: string)

This method returns all the log entries which are above a specific log level.

messageBelowLogLevel(logLevel: string)

This method returns all the log entries which are below a specific log level.

Getter

allMessages

Returns the complete log journal with all logged messages.

The Log Object

One entry in the log consist of a bunch of values. Most of them (exept for the actual message and level) are added by the log without some additional code. All the parameters can be accessed via getters. Here is an example of the Interface of the acual log object:

interface LogObject {
    id: number
    date: Date
    level: LogLevel
    message: string
    userAgent: string
    displayRatio: number
    viewportHeight: number
    viewportWidth: number
    orientation: ScreenOrientationType
}

License

Copyright 2022 Volumax Veranstaltungstechnik UG (haftungsbeschränkt)

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.