Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add support for showing request and response payload #184

Merged
merged 2 commits into from
Sep 3, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ set `options` to an object with the following optional settings:
into the subscribers "console" configuration.
- `extraFields` - an object containing extra fields to be included on the broadcast log message.
- `logRequestHeaders` - determines if all request headers will be logged. Defaults to _false_
- `logRequestPayload` - determines if the request payload will be logged. Defaults to _false_
- `logResponsePayload` - determines if the response payload will be logged. Defaults to _false_

For example:

Expand Down
12 changes: 11 additions & 1 deletion lib/monitor.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ internals.defaults = {
maxLogSize: 0, // Max bytes allowed to be written to each log file
requestTimeout: 60000, // Number of ms to set timeout for http request to
extraFields: {}, // extra fields to include in the envelope
logRequestHeaders: false // log all headers on request
logRequestHeaders: false, // log all headers on request
logRequestPayload: false, // log payload of request
logResponsePayload: false // log payload of response
};


Expand Down Expand Up @@ -503,6 +505,14 @@ internals.Monitor.prototype._request = function () {
if (self.settings.logRequestHeaders) {
event.headers = req.headers;
}

if (self.settings.logRequestPayload) {
event.requestPayload = req.payload;
}

if (self.settings.logResponsePayload) {
event.responsePayload = res.payload;
}

return event;
};
Expand Down
4 changes: 3 additions & 1 deletion lib/schema.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ internals.monitorOptions = Joi.object().keys({
schemaName: Joi.string(),
subscribers: Joi.object().required(),
extraFields: Joi.object(),
logRequestHeaders: Joi.boolean()
logRequestHeaders: Joi.boolean(),
logRequestPayload: Joi.boolean(),
logResponsePayload: Joi.boolean()
});

internals.monitorSubscribers = Joi.object()
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "good",
"description": "Server and process monitoring plugin",
"version": "2.2.4",
"version": "2.3.0",
"repository": "git://github.com/hapijs/good",
"main": "index",
"keywords": [
Expand Down
40 changes: 40 additions & 0 deletions test/monitor.js
Original file line number Diff line number Diff line change
Expand Up @@ -1735,6 +1735,46 @@ describe('Monitor', function () {
done();
});
});

it('logs request payload when option is set', function (done) {

var options = {
subscribers: {},
logRequestPayload: true,
logResponsePayload: true
};

makePack(function (pack, server) {

var request = {
raw: {
req: {
headers: {
'user-agent': 'test'
},
payload: {
'foo': 'bar'
}
},
res: {
payload: {
'bar': 'foo'
}
}
},
info: {},
server: server,
getLog: function () {}
};

var monitor = new Monitor(pack, options);

var event = monitor._request()(request);
expect(event.requestPayload.foo).to.equal('bar');
expect(event.responsePayload.bar).to.equal('foo');
done();
});
});
});

describe('#_display', function () {
Expand Down