Socket
Socket
Sign inDemoInstall

logmagic

Package Overview
Dependencies
2
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

logmagic


Version published
Maintainers
1
Created

Readme

Source

Welcome to Log Magic.

This project is usable. It doesn't do everything it should, yet.

The goal is to have a fast and easy to use logging subsystem that can be dynamically reconfigured to provide insight into production systems.

Logmagic does its magic by generating objects with generated functions that are only modified when the logging system is reconfigured, thus your entire logging path is contained within long-lived functions that V8 is able to JIT.

Getting Started

If you had a file named like, "lib/foo/bar.js", at the top of it, you would put the following:

var log = require('logmagic').local('mylib.foo.bar');

Then inside bar.js, you would just use the logger like any normal logger:

log.info("Hello!")
log.error("By default, format strings are not used.", {SOME_VAR: "myvalue"})
log.errorf("Just add 'f' to any log method, and you get format strings too: ${SOME_VAR}", {SOME_VAR: "myvalue"})

In any other part of your application, you can reconfigure the logging subsystem at runtime, making it easy to change log levels for specific modules dynamically.

var logmagic = require('logmagic');
logmagic.registerSink("mysink", function(module, level, message) { console.log(message); });

/* Send Info an higher in the root logger to stdout */
logmagic.route("__root__", logmagic.INFO, "stdout")

/* Reconfigure all children of mylib to log all debug messages to your custom sink */
logmagic.route("mylib.*", logmagic.DEBUG, "mysink")

Builtin sinks include:

  • stderr
  • Graylog2-style JSON to stderr

Future features:

  • Standard Out
  • Facebook Scribe: https://github.com/facebook/scribe
  • File
  • Unix Socket
  • Syslog

Keywords

FAQs

Last updated on 01 Jul 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc