TheThing/node-bunyan-lite
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Wiki Activity

update notes on req_id for restify 2.x changes

Browse source
This commit is contained in:
Trent Mick 2013-06-05 23:31:13 -07:00
parent 8f7aff09b2
commit d10f9ec53b
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -224,12 +224,13 @@ And with the `bunyan` CLI (using the "short" output mode):
A more practical example is in the A more practical example is in the
[node-restify](https://github.com/mcavage/node-restify) web framework. [node-restify](https://github.com/mcavage/node-restify) web framework.
Restify uses Bunyan for its logging. One feature of its integration, is that Restify uses Bunyan for its logging. One feature of its integration, is that
each restify request handler includes a `req.log` logger that is: if `server.use(restify.requestLogger())` is used, each restify request handler
includes a `req.log` logger that is:
log.child({req_id: <unique request id>}, true) log.child({req_id: <unique request id>}, true)
Apps using restify can then use `req.log` and have all such log records Apps using restify can then use `req.log` and have all such log records
include the unique request id (as "req_id"). Handy. include the unique request id (as "req\_id"). Handy.
## Serializers ## Serializers
@ -447,7 +448,7 @@ Recommended/Best Practice Fields:
for a request. This really shines when you have a SOA with multiple services for a request. This really shines when you have a SOA with multiple services
and you carry a single request ID from the top API down through all APIs and you carry a single request ID from the top API down through all APIs
(as [node-restify](https://github.com/mcavage/node-restify) facilitates (as [node-restify](https://github.com/mcavage/node-restify) facilitates
with its 'X-Request-Id' header). with its 'Request-Id' header).
- `req`: An HTTP server request. Bunyan provides `bunyan.stdSerializers.req` - `req`: An HTTP server request. Bunyan provides `bunyan.stdSerializers.req`
to serialize a request with a suggested set of keys. Example: to serialize a request with a suggested set of keys. Example: