Skip to content

Abadima/Logena

Repository files navigation

Logena I've made this simple logging system to help keep my logging consistent across projects. While unoriginal, it's a somewhat decent package for those looking for the same ideas I had in mind, since this one's a little different from others I've wanted to use.

Features

  • ✅ Customizable application name.
  • ✅ Customizable colors for everything.
  • ✅ No Dependencies, very demure.
  • ✅ Optional Debug mode.
  • ✅ Optional ASCII kitty meow on errors.

Installation

This can be made via your package manager of choice, here's npm as an example:

npm install logena

Functions

logena.set

Parameters

  • config: An object containing configuration options.
  • debug (optional): boolean - Enable or disable debug mode.
  • appName (optional): string - Set the application name.
  • useTimestamps (optional): boolean - Enable or disable timestamps in logs.
  • meowOnError (optional): boolean - When true, prints an ASCII kitty before error logs.
  • errorCatAscii (optional): string - Custom ASCII cat text shown when meowOnError is enabled.
  • colors (optional): object - Customize colors.
  • timestamp: string - Color for the timestamp.
  • appName: string - Color for the application name.
  • message: string - Color for the message.
  • levels: object - Customize colors for different log levels.
  • info: string - Color for info level logs.
  • warn: string - Color for warn level logs.
  • error: string - Color for error level logs.
  • debug: string - Color for debug level logs.

logena.info

Parameters

  • appName (optional): string - Set the application name (Overrides preset name).
  • message: string | object - The message to log.

logena.warn

Parameters

  • appName (optional): string - Set the application name (Overrides preset name).
  • message: string | object - The message to log.

logena.error

Parameters

  • appName (optional): string - Set the application name (Overrides preset name).
  • message: string | object - The message to log.

logena.debug (ONLY LOGS IF DEBUG MODE IS ENABLED VIA logena.set)

Parameters

  • appName (optional): string - Set the application name (Overrides preset name).
  • message: string | object - The message to log.

Note: If you set appName on any log level function (e.g., logena.info, logena.warn, etc.), it will override the preset application name only for that specific function call.

JS/TS Examples

Both default and named imports work in TypeScript. CommonJS supports destructuring or default require.

// TypeScript: default import
import Logena from "logena";
// TypeScript: named import (also works)
import { Logena } from "logena";
// JavaScript/CommonJS: destructured require
const { Logena } = require("logena");

Then configure and use:

Logena.set({
	debug: true,
	appName: "LOGENA",
	meowOnError: true,
	colors: {
		appName: "red",
		levels: {
			info: "green",
		},
	},
	useTimestamps: true,
});
Logena.info("Hello, world!"); // 2024-10-15 18:00:00Z [LOGENA] INFO: Hello, world!
Logena.warn("Hello, world!"); // 2024-10-15 18:00:00Z [LOGENA] WARN: Hello, world!
Logena.error("Hello, world!"); // 2024-10-15 18:00:00Z [LOGENA] ERROR: Hello, world!
Logena.debug("Hello, world!"); // 2024-10-15 18:00:00Z [LOGENA] DEBUG: Hello, world!

Performance

Benchmarked at 100,000 iterations per level with console I/O suppressed, on an AMD Ryzen 9 9950X3D running Ubuntu 25.10.

Level Median p95 p99 Mean Ops/sec
info 40 ns 60 ns 140 ns 54 ns 25,000,000
warn 110 ns 130 ns 230 ns 151 ns 9,090,909
error 60 ns 80 ns 90 ns 68 ns 16,666,667
debug 190 ns 220 ns 270 ns 211 ns 5,263,158

Total RSS growth across all levels: +11.695 MB

Benchmarks are measured with console I/O suppressed to isolate formatting overhead. Real-world numbers will vary depending on output destination and system load.

License

MIT :3

Contributing

Want to contribute? Feel free to fork and make a pull request! Every contribution will be reviewed and appreciated.

Hall of Contributors

  • None yet, be the first?

About

NodeJS Jena Logger (may expand?)

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors