Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 2.06 KB

README.md

File metadata and controls

63 lines (46 loc) · 2.06 KB
Raw

winston-hipchat

NPM

A Hipchat transport for winston.

Usage

  var winston = require('winston')
    , winstonHipchat = require('winston-hipchat').Hipchat

  winston.add(winstonHipchat, options)

Many options can be seen in the Hipchat API docs.

  • level: Level of messages that this transport should log.
  • silent: If true, will not log messages.
  • token: Hipchat authtoken. Only needs to be the "notification" type.
  • notify: If true, will notify the hipchat room.
  • color: One of "yellow", "red", "green", "purple", "gray", or "random". (default: yellow)
  • room: Required. ID or name of the room.
  • from: Required. Name the message will appear be sent from. Must be less than 15 characters long. May contain letters, numbers, -, _, and spaces.
  • messageFormat: text (default) or html.
  • message: lodash templates. Gets passed the {{message}}, {{level}}, and {{meta}} as a JSON string. If not specified, it will print a default of {{message}}\n\n{{meta}}

Installation

Installing npm (node package manager)

  $ curl http://npmjs.org/install.sh | sh

Installing winston-hipchat

  $ npm install winston
  $ npm install winston-hipchat

Run Tests

None yet.

Changelog

0.1.3 Changed package.json to still support winston v0.9

0.1.2 Changed package.json to reflect winston v0.8

0.1.0 Add message customizing via templates

  • now depends on lodash

0.0.0 Initial Release

Author: Joey Baker

Contributor: Joe Parrinello

Based on winston-loggly by Charlie Robbins

License: MIT