Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/log4js-node/hipchat
Hipchat Appender for Log4JS
https://github.com/log4js-node/hipchat
hipchat hipchat-appender hipchat-notifier
Last synced: 20 days ago
JSON representation
Hipchat Appender for Log4JS
- Host: GitHub
- URL: https://github.com/log4js-node/hipchat
- Owner: log4js-node
- License: apache-2.0
- Created: 2018-02-28T20:39:15.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-21T01:37:52.000Z (about 1 year ago)
- Last Synced: 2024-12-05T12:49:29.916Z (about 1 month ago)
- Topics: hipchat, hipchat-appender, hipchat-notifier
- Language: JavaScript
- Size: 225 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hipchat Appender for Log4JS
This is an optional appender for [log4js](https://log4js-node.github.io/log4js-node/).
```bash
npm install @log4js-node/hipchat
```
The hipchat appender will send every log message it receives to a [hipchat](http://www.hipchat.com) server, over HTTP. It uses the [hipchat-notifier](https://www.npmjs.com/package/hipchat-notifier) library. If you're not sure what some of the configuration options below mean, then check the documentation for hipchat-notifier, and the hipchat docs themselves.
## Configuration
* `type` - `@log4js-node/hipchat`
* `hipchat_token` - `string` - User token with notification privileges
* `hipchat_room` - `string` - Room ID or name
* `hipchat_from` - `string` (optional, defaults to empty string) - a label to say where the message is from
* `hipchat_notify` - `boolean` (optional, defaults to `false`) - make hipchat annoy people
* `hipchat_host` - `string` (optional, defaults to `api.hipchat.com`) - set this if you have your own hipchat server
* `hipchat_response_callback` - `function` (optional, defaults to only throwing errors) - implement this function if you want intercept the responses from hipchat
* `layout` - (optional, defaults to `messagePassThroughLayout`) - see [layouts](https://log4js-node.github.io/log4js-node/layouts.html)
## Example (default config)
```javascript
log4js.configure({
appenders: {
squawk: { type: '@log4js-node/hipchat', hipchat_token: 'abc123', hipchat_room: 'ops' }
},
categories: {
default: { appenders: ['squawk'], level: 'error'}
}
});
```
This will result in all error (and above) messages being sent to the hipchat room "ops".
# Example (use all the options!)
```javascript
log4js.configure({
appenders: {
squawk: {
type: '@log4js-node/hipchat',
hipchat_token: 'abc123',
hipchat_room: 'things_are_on_fire',
hipchat_from: 'Hal9000',
hipchat_notify: true,
hipchat_host: 'hipchat.yourorganisation.com',
hipchat_response_callback: function(err, response) {
console.log("I got a response from hipchat: ", response);
}
}
},
categories: {
default: { appenders: ['squawk'], level: 'info' }
}
});
```