diagnostics

What is diagnostics?

The 'diagnostics' npm package is designed to provide a comprehensive set of utilities for debugging and diagnostic purposes. It allows developers to output debug information, create diagnostic channels, and manage the verbosity of logging.

What are diagnostics's main functionalities?

Debugging

This feature allows developers to create namespaced debug logs. The code sample demonstrates how to create a debug instance for a specific namespace and log a message.

const debug = require('diagnostics')('my-namespace');
debug('doing some work');

Enabling Namespaces

This feature enables specific namespaces for logging. By setting the DEBUG environment variable, you can control which debug instances output logs. The code sample shows how to enable a namespace and log a message that will be output.

process.env.DEBUG = 'my-namespace';
const debug = require('diagnostics')('my-namespace');
debug('this will be logged');

Diagnostic Channels

This feature allows the creation of diagnostic channels for emitting and listening to custom events. The code sample creates a channel, listens for 'data' events, and emits a message.

const diagnostics = require('diagnostics');
const channel = diagnostics.channel('my-channel');
channel.on('data', (message) => {
  console.log('Received message:', message);
});
channel.write('Hello, diagnostics!');

Other packages similar to diagnostics

debug

The 'debug' package is similar to 'diagnostics' in that it allows developers to create small debugging utilities. It is widely used and focuses on simplicity and minimalism. Unlike 'diagnostics', it does not provide channels but is very popular for its ease of use and integration.

winston

The 'winston' package is a multi-transport async logging library for Node.js. It is more feature-rich than 'diagnostics', providing support for multiple storage options, custom log levels, and transports for logging to various outputs such as files, consoles, or remote services.

bunyan

The 'bunyan' package is a simple and fast JSON logging library for Node.js services. It provides features like log rotation, streams, and serializers. It is similar to 'diagnostics' in providing structured logging but differs in its focus on JSON format and log management features.

README

Diagnostics

Diagnostics is a small debugging library which allows you to output your debug logs by setting an environment variable. The library works for server-side and client-size applications so it's great for writing isomorphic JavaScript.

The debug output can be triggered using environment variables on the server and using localStorage, hashtags and window.name on the browser. If the debug output is not enabled this module will result in an empty function causing the JavaScript compiler engines to remove it completely from your code so there is absolutely no performance overhead or excuses left to not use logging in your code!

Installation

The module is released in the public npm registry and can easily be installed by running.

npm install --save diagnostics

For client-side/front-end facing application we assume that you're using browserify as your build tool as the client code is bundled as the browser.js file in the root of this repository.

Usage

When you require the module it returns a function that expect a name or prefix for the debug messages. This prefix is what you use to enable specific debug messages.

The exported function of the module accepts 2 arguments:

1. name The namespace of the debug logger.
2. options These options can only be applied to the server, not client code:

• colors: Enable or disable colors. Defaults to true if your stdout is a tty.
• stream: The stream instance we should write our logs to. We default to process.stdout (unless you change the default using the .to method).

var debug = require('diagnostics')('foo');
debug('hello world %d', 12);

In the example above you can see that we've created a new diagnostics function called debug. It's name is set to foo. So when we run this in Node.js using:

node index.js

We will see nothing in the console as the log messages are disabled by default. But when set the DEBUG or DIAGNOSTICS environment variables to the name of the debug function it will show up:

DIAGNOSTICS=foo node index.js

hello world 12

You can enable or disable specific diagnostic instances in the ENV variables by separating them using a space or comma:

DEBUG=foo,-bar,primus:*

In the example above you also see an example of a wild card *. This ensures that anything after it or before it will be allowed.

To make it easier to see where the log messages are coming from they are colored automatically based on the namespace you provide them. The deeper the namespace, the lighter name will be toned as seen in the following output.

Browser

The usage for browser is exactly the same as for node. You require the diagnostics method and supply it with a name argument. The big difference is that no longer can use environment variables as these only work on the server. So to go around that you can use:

• hashtag The hashtag will be parsed using query string decoding. So if you have an hash #debug=foo it will trigger all foo lines to be dumped to your browser console.
• localStorage We will search for a query string in either the env or debug key of localStorage. We again assume that the value has query string encode value which contains either debug or diagnostics. localStorage.env = 'diagnostics=foo'.
• window.name As localStorage is not available in all browsers, we provide a fallback to window.name which can contain the same values as the localStorage's env/debug keys.

Unlike the server, the output of the browser is not colored. The reason for this that it would take a considerable amount of code. Which is not worth the benefit as you usually want your front-end code to be as small as possible.

Multiple streams

Please note that this feature is server-side only as in the browser we can only output to the console

The beauty of this logger is that it allows a custom stream where you can write the data to. So you can just log it all to a separate server, database and what not. But we don't just allow one stream we allow multiple streams so you might want to log to disk AND just output it in your terminal. The only thing you need to do is either use:

require('diagnostics').to([
  stream1,
  stream2
]);

To set multiple streams as the default streams or supply an array for the logger it self:

var debug = require('diagnostics')('example', { stream: [
  stream1,
  stream2
]});

debug('foo');

License

MIT