Skip to content

belbis/scribe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

a stream logging module for node.js

               _ _          
              (_) |         
 ___  ___ _ __ _| |__   ___ 
/ __|/ __| '__| | '_ \ / _ \
\__ \ (__| |  | | |_) |  __/
|___/\___|_|  |_|_.__/ \___|

NPM Version

Gitter chat Inline docs

Build Status Coverage Status Dependency Status

Installing

To install the latest release with npm run:

npm install scribe

to install the development version from github run:

npm install "git+https://github.com/belbis/scribe"

Introduction

Scribe is a logging library for node.js that utilizes writeStreams.

Scripta

Scripta is just plural of Scriptum which are the writeStreams implemented for Scribe. Currently these scripta are supported:

  • SQS - AWS SQS scriptum write stream
  • Stream - generic write scriptum stream scripta
  • File - write to file
  • STDOut - write to stdout
  • DevNull -- write to /dev/null (currently only linux supported)

usage

stdout example:

var scribe = require("scribe");

var logger = scribe.getLogger();
var scr = new scribe.scripta.STDOut({addNewLine: true});
logger.open();
logger.add(scr);
logger.log("shaken, not stirred.");
logger.close();

file example:

var scribe = require("scribe");

var logger = scribe.getLogger();
var scr = new scribe.scripta.File({addNewLine: true});
logger.open();
logger.add(scr);
logger.log("shaken, not stirred.");
logger.close();

AWS SQS example:

var scribe = require("scribe");

var logger = scribe.getLogger();
var scr = new scribe.scripta.SQS();
logger.open();
logger.add(scr);
logger.log("shaken, not stirred.");

disclaimer

this project is currently in development

future

allow for read as duplex stream

get devnull working on windows

About

node.js logging module

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published