Pino GELF (pino-gelf) is a transport for the Pino logger. Pino GELF receives Pino logs from stdin and transforms them into GELF format before sending them to a remote Graylog server via UDP.
Pino GELF should be installed globally so it can be used as a utility:
npm i -g pino-gelf
Usage
The recommended pipeline to run Pino GELF as a transform for Pino logs is as follows:
node your-app.js | pino-gelf log
The host, port and maximum chunk size of your Graylog server can be specified using options. Fields logged by express-pino-middleware or any other custom fields included with Pino requests will be converted into strings (if they aren't already) and their keys will be prefixed with an underscore, according to the GELF spec. Also, you can choose to enable verbose mode which outputs all GELF messages locally, this can be useful for initial configuration.
Finally, you can enable passthrough mode which will output the original input back to stdout. That enables you to make pino-gelf part of a chain of commands and use the original input for further processing (for example pino-pretty).
// Set Graylog hostnode your-app.js | pino-gelf log -h graylog.server.com// Set Graylog portnode your-app.js | pino-gelf log -p 12202// Use HTTP protocolnode your-app.js | pino-gelf log -P http// Use HTTPS protocolnode your-app.js | pino-gelf log -P https// Use keep alive for HTTP/TCPnode your-app.js | pino-gelf log -P http -k true// Use TCP protocolnode your-app.js | pino-gelf log -P tcp// Use TLS protocolnode your-app.js | pino-gelf log -P tls// Retry TCP connection for 10 times every 3 secondsnode your-app.js | pino-gelf log -P tcp -r 10 -d 3000// Set Graylog maximum chunk sizenode your-app.js | pino-gelf log -m 8192// Enable local outputnode your-app.js | pino-gelf log -v// Enable passthrough modenode your-app.js | pino-gelf log -t
Note: The defaults for these options are:
Property
Environment Variable
Default
Host
PINO_GELF_HOST
127.0.0.1
Port
PINO_GELF_PORT
12201
Protocol
PINO_GELF_PROTOCOL
udp
Maximum Chunk Size
PINO_GELF_MAX_CHUNK_SIZE
1420
Keep Alive
PINO_GELF_KEEP_ALIVE
true
Reconnection limit
PINO_GELF_RECONNECTION_LIMIT
-1 (no limit)
Reconnection delay
PINO_GELF_RECONNECTION_DELAY
Example
Given the Pino log message (formatted as JSON for readability):
{ "pid":16699, "hostname":"han", "name":"pino-gelf-test-app", "level":30, "time":1481840140708, "msg":"request completed", "res":{ "statusCode":304, "header":"HTTP/1.1 304 Not Modified\r\nX-Powered-By: Express\r\nETag: W/\"d-bNNVbesNpUvKBgtMOUeYOQ\"\r\nDate: Thu, 15 Dec 2016 22:15:40 GMT\r\nConnection: keep-alive\r\n\r\n" }, "responseTime":8, "environment":"dev", "colour":"black", "req":{ "id":1, "method":"GET", "url":"/", "headers":{ "host":"localhost:3000", "connection":"keep-alive", "if-none-match":"W/\"d-bNNVbesNpUvKBgtMOUeYOQ\"", "upgrade-insecure-requests":"1", "accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", "user-agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/602.2.14 (KHTML, like Gecko) Version/10.0.1 Safari/602.2.14", "accept-language":"en-gb", "dnt":"1", "accept-encoding":"gzip, deflate" }, "remoteAddress":"::1", "remotePort":52829 }, "v":1
And the usage:
node server.js | pino-gelf log
Pino GELF will send the following message to your Graylog server (formatted here as JSON for readability):
Formatted JSON Data{ "version":"1.1", "host":"han", "short_message":"request completed", "full_message":"request completed", "timestamp":1481840140.708, "level":6, "_name":"pino-gelf-test-app", "_res":"{\"statusCode\":304,\"header\":\"HTTP/1.1 304 Not Modified\\r\\nX-Powered-By: Express\\r\\nETag: W/\\\"d-bNNVbesNpUvKBgtMOUeYOQ\\\"\\r\\nDate: Thu, 15 Dec 2016 22:15:40 GMT\\r\\nConnection: keep-alive\\r\\n\\r\\n\"}", "_responseTime":"8", "_environment":"dev", "_colour":"black", "_req":"{\"id\":1,\"method\":\"GET\",\"url\":\"/\",\"headers\":{\"host\":\"localhost:3000\",\"connection\":\"keep-alive\",\"if-none-match\":\"W/\\\"d-bNNVbesNpUvKBgtMOUeYOQ\\\"\",\"upgrade-insecure-requests\":\"1\",\"accept\":\"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\"user-agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_1) AppleWebKit/602.2.14 (KHTML, like Gecko) Version/10.0.1 Safari/602.2.14\",\"accept-language\":\"en-gb\",\"dnt\":\"1\",\"accept-encoding\":\"gzip, deflate\"},\"remoteAddress\":\"::1\",\"remotePort\":52829}"}
GELF
At present the mapping from standard Pino log messages to GELF messages is as follows: