@studiowebux/deno-minilog@0.4.1

Built and signed on GitHub Actions

Built and signed on GitHub Actions

About

• A minimalistic logging tool designed specifically for use with Deno, supporting essential log levels such as info, warn, error, debug, verbose, trace.
• This logger outputs to the terminal in either text or json format, displaying messages with a prefix that includes the current local date and time.
• It allows users to easily toggle the enabled log level and change the output format, providing flexibility based on their preference or application needs.
• Introducing fork to isolate and manage logs within specific application segments for pinpoint troubleshooting and future reference.
• Added support of loggerInstance to use a singleton pattern and centralize the logger configuration.
• Optional Integration of OpenTelemetry to send logs to Loki.
• Configurable error format using withErrorTrace.

Installation and Usage

1. Install deno: https://deno.com
2. deno add jsr:@studiowebux/deno-minilog

const logger = new Logger(); // Logs everything by default
logger.info("This is an info log");
logger.info({ foo: "bar" });
logger.error(new Error("Oops"));
logger.warn("You should check the logs...");
logger.debug("Debug message.");
logger.verbose("Verbose message.");
logger.trace("Message with trace.");

const logger = new Logger({ info: false });
logger.info("This info wont be showed.");
logger.error(new Error("Oops"));
logger.warn("You should check the logs...");

You can set the format to json, usually required with observability tools.

const jsonLogger = new Logger({ format: "json" });

// Prints
{"message":"...","level":"...","timestamp":"...","id":"..."}

Trace option

This output will spread on multiple lines, so might not be the best in production environment where each line is an entry.

see tests/test.ts for other examples.

Forks

This feature is useful to sort and isolate logs when wanting to troubleshoot part of the application. And to let the logs there (even in production) the Logger instance can isolate and hide those forked logger instance.

• forkToPrint: A list of the id to show, anything else is hidden.
• hideFork: Hide all forks and show only the "normal" logs.

See tests/flow.ts for the examples.

const logger = new Logger({ forkToPrint: ["my_fn_logs"] });

Prints:

9/13/2024, 4:37:22 PM DEBUG [my_fn_logs]:   myFn
9/13/2024, 4:37:22 PM DEBUG [my_fn_logs]:   My Function
9/13/2024, 4:37:22 PM INFO [my_fn_logs]:   i'm doing stuff
9/13/2024, 4:37:22 PM WARN [my_fn_logs]:   Oops, stuff is now weird
9/13/2024, 4:37:22 PM VERBOSE [my_fn_logs]:   {"foo":"bar"}
9/13/2024, 4:37:22 PM DEBUG [my_fn_logs]:   I'm done.

const logger = new Logger();

Prints:

9/13/2024, 4:36:43 PM INFO:   Application is starting...
9/13/2024, 4:36:43 PM DEBUG [my_fn_logs]:   myFn
9/13/2024, 4:36:43 PM DEBUG [my_fn_logs]:   My Function
9/13/2024, 4:36:43 PM INFO [my_fn_logs]:   i'm doing stuff
9/13/2024, 4:36:43 PM WARN [my_fn_logs]:   Oops, stuff is now weird
9/13/2024, 4:36:43 PM VERBOSE [my_fn_logs]:   {"foo":"bar"}
9/13/2024, 4:36:43 PM DEBUG [my_fn_logs]:   I'm done.
9/13/2024, 4:36:43 PM DEBUG [my_second_fn]:   mySecondFn
9/13/2024, 4:36:43 PM DEBUG [my_second_fn]:   My Second Function
9/13/2024, 4:36:43 PM DEBUG [my_second_fn]:   I'm done.
9/13/2024, 4:36:43 PM INFO:   Application has ended.

const logger = new Logger({ forkToPrint: [], hideForks: true });

Prints:

9/13/2024, 4:35:07 PM INFO:   Application is starting...
9/13/2024, 4:35:07 PM INFO:   Application has ended.

See the tests/ directory for more examples.

Singleton

See tests/instance for an example.

import { loggerInstance } from "../../src/mod.ts";

loggerInstance.setConfig({ debug: false });
loggerInstance.info("Application is starting");

Releases and Github Actions

git tag -a X.Y.Z -m "Version X.Y.Z"
git push origin tags/X.Y.Z

Contributing

1. Fork the project
2. Create a Feature Branch
3. Commit your changes
4. Push your changes
5. Create a PR

git checkout -b <feature|fix|release|chore|hotfix>/prefix-name

git fetch origin
git rebase origin/master

git add .
git commit -m "<feat|ci|test|docs|build|chore|style|refactor|perf|BREAKING CHANGE>: commit message"

git push origin <feature|fix|release|chore|hotfix>/prefix-name

git checkout -b release/v1.15.5
git checkout -b feature/abc-123-something-awesome
git checkout -b hotfix/abc-432-something-bad-to-fix

git commit -m "docs: added awesome documentation"
git commit -m "feat: added new feature"
git commit -m "test: added tests"

License

Distributed under the MIT License. See LICENSE for more information.

Contact

• Tommy Gingras @ tommy@studiowebux.com | Studio Webux

| | Webux Lab |