https://github.com/opentable/hapi-ot-logger
[DEPRECATED] hapi logging compliant to ot-logging standards
https://github.com/opentable/hapi-ot-logger
Last synced: 3 months ago
JSON representation
[DEPRECATED] hapi logging compliant to ot-logging standards
- Host: GitHub
- URL: https://github.com/opentable/hapi-ot-logger
- Owner: opentable
- License: mit
- Created: 2014-10-17T17:30:38.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-07-30T12:11:45.000Z (almost 6 years ago)
- Last Synced: 2025-03-12T22:03:07.400Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 45.9 KB
- Stars: 0
- Watchers: 18
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [DEPRECATED] hapi-ot-logger
> OpenTable standard-compliant logging plugin for Hapi.
[](https://travis-ci.org/opentable/hapi-ot-logger)
[](https://david-dm.org/opentable/hapi-ot-logger)
[](https://david-dm.org/opentable/hapi-ot-logger#info=devDependencies)
[](https://badge.fury.io/js/hapi-ot-logger)
## Usage
```bash
$ npm i hapi-ot-logger --save
```
```javascript
var server = new (require('hapi').Server)();
server.connection({ port: 3000 });
server.register([
{
register: require('hapi-ot-logger'),
options: {
servicetype: "myservice",
versions: {
request: 'v2',
log: 'v3',
error: 'v2'
},
redis: {
host: '127.0.0.1',
port: 6379,
listname: 'logs'
},
console: true,
payload: false,
validate: function(log) {
return log.logname === 'request' && log.headers['user-agent'] !== 'noisy-spider';
},
preSend: function(req, log) {
log.customAttribute = req.context.someAttribute;
}
}
}
], function (err) {
if (err) {
console.error('Failed to load plugin:', err);
}
server.start();
});
```
## Configuration
- **servicetype** - unique service type
- **versions** -
- **request** - request log version
- **log** - diagnostic log version
- **error** - error log version
- **redis**
- **host** - redis server hostname or IP address
- **port** - redis server port
- **listname** - redis list name
- **console** - *(optional)* enable console output for debugging
- **payload** - *(optional)* include request payload
- **validate** - *(optional)* validates that a message should be logged
- **preSend** - *(optional)* enables modification of log message
## Release History
- **v3.2.2** (2019-07-29)
- update packages
- **v3.2.1** (2016-08-19)
- disable plugin option validation as it is a breaking change
- **v3.2.0** (2016-08-18)
- added optional `preSend(req, log)` function to enable modification of log message
- **v3.1.0** (2015-11-14)
- ???