Getting Started is Easy

First install Adze from npm.

# npm
npm install -S adze

# pnpm
pnpm add adze

Then import it and start writing logs! No other configuration is required.

import adze from 'adze';

adze.info('This is an info level log from AdzeJS!');
Example of an info log generated from the example code
An isometric illustration of a node server and a web browser among trees

Universal By Nature

Modern JavaScript frameworks like NextJS, NuxtJS, and SvelteKit combine your "back-end" and "front-end" code in the same location. Adze is universal which means it can be executed on the server side or the browser side without any extra considerations. Use it anywhere!

Works great with

NextJS
NuxtJS
SvelteKit
NodeJS
BunJS
DenoJS

Simple, Chainable API

Adze provides you with a means of writing logs that feels very natural. Writing highly-configured logs in place is a breeze with the chainable API. Want to add timestamps and emoji's? Just add the timestamp and withEmojimodifiers.

adze.withEmoji.timestamp.alert('Oh no! Something terrible happened!');
Example of an alert log generated from the example code

Choose Your Format

Adze supports multiple formatting options out-of-the-box. Use the pretty, human-readable default format, or generate machine-readable logs using the JSON format; or even mix and match both! How you use Adze is up to you.

Adze JSON logs are also compatible with the Bunyan CLI so you can take advantage of its formatting and filtering features!

This is an example of the same log printed two different ways by changing the format.

First Class TypeScript Support

Other logging libraries have bolted-on TypeScript support which feels unintuitive, whereas Adze is built with TypeScript from the ground up. Because of this, Adze provides a great TypeScript developer experience.

Easy Microfrontend Logging

Because Adze automatically comes with a global store that can have configuration applied that all logs will inherit from.

What this means for microfrontend's is that if you have multiple frontend applications generating Adze logs, you can easily control them centrally. Change the log level, filter out logs that aren't relevant, or even change the format for all logs regardless of the source.

For an in-depth tutorial, visit this article.

And Much More...

To learn more about Adze and how to use it in your project, take a look at the Getting Started guide for a guided tutorial, or visit the Reference Manual for more details about the API's.


Get Started

©Copyright 2024 - Andrew Stacy - Apache 2.0 License

github iconlinkedin icon