express-loggly

Express middleware to send JSON formatted logs to Loggly from an Express application. Use this logger to send all web traffic to Loggly for capture and analysis. It uses node-loggly by nodejitsu.

Why JSON Logs? See:

https://journal.paul.querna.org/articles/2011/12/26/log-for-machines-in-json/

http://blog.nodejs.org/2012/03/28/service-logging-in-json-with-bunyan/

Install

npm install express-loggly --save

Usage

var express = require('express')
var logger  = require('express-loggly')

var app = express()

// Setup Loggly configuration
var config = {
    token: 'your-really-long-input-token',
    subdomain: 'your-loggly-subdomain',
    tags: ['tag1', 'tag2', ... 'tagN'] 
};

// Sequence of use() matters!
// Put this *after* session and bodyParser

app.use(logger({ loggly: config }));

Options

immediate

Write logs on request instead of response. This means that a requests will be logged even if the server crashes, but data from the response cannot be logged (like the response code). Use like this:

app.use(logger({
  immediate: true,
  loggly: config
}));

Release Notes

Creating a release: (When everything is tested and ready for a new npm release)

• Bump the version in your package.json file.
• Commit that change with a message like "Release 0.0.5".
• Push commit to Github
• Create a new release tag:
  • Listing Tags: type git tag
  • Creating Tags: Use annotated tags - they’re checksummed; contain the tagger name, e-mail, and date; have a tagging message; and can be signed and verified with GNU Privacy Guard (GPG). git tag -a v0.0.5 -m 'Release 0.0.5'
  • Pushing Tags to Github: By default the git push command doesn’t transfer tags to remote servers. You have to explicitly push tags. You run git push origin [tagname]. git push origin v0.0.5
• Use the Github GUI to create a release from the tag. Confusing, yes? Not sure why Github separates tags from releases but they do and using the web site is easy: https://github.com/dstroot/express-loggly/releases
• Make sure you are logged into npm: npm login
• Publish the new version to npm: npm publish https://github.com/dstroot/express-loggly/archive/0.0.5.tar.gz --tag 0.0.5

License

The MIT License (MIT)

Copyright (c) 2014 Daniel Stroot dan@thestroots.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.