Gelf compatibility #5
Conversation
This commit introduces breaking changes to pino-gelf, hence the major version bump. The GELF spec at http://docs.graylog.org/en/3.0/pages/gelf.html#gelf-payload-specification specifies a flat JSON structure. Custom fields have to be prefixed with an underscore and can only contain string values. We do that now. All tests pass. Also, a passthrough mode is being added. That way we can pass pino messages to pino-gelf and then pipe pino-gelf's output to another tool. That way we can both send to a graylog server and pretty-print.
|
@mcollina Ping :) |
README.md
Outdated
| @@ -27,7 +27,7 @@ The recommended pipeline to run Pino GELF as a transform for Pino logs is as fol | |||
| node your-app.js | pino-gelf log | |||
| ``` | |||
|
|
|||
| The host, port and maximum chunk size of your Graylog server can be specified using options. Options can also be used to include standard fields logged by [express-pino-middleware](https://github.com/pinojs/express-pino-logger). Custom fields included with Pino requests based on your own configuration can also be specified, although at present only strings are handled. Finally, you can choose to enable verbose mode which outputs all GELF messages locally, this can be useful for initial configuration. | |||
| The host, port and maximum chunk size of your Graylog server can be specified using options. Fields logged by [express-pino-middleware](https://github.com/pinojs/express-pino-logger) 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`). | |||
There was a problem hiding this comment.
this has nothing to do with gelf correct? this is just an additional convenience feature? does anything else happen when passthough mode is enabled - e.g. is it still sending data somewhere?
There was a problem hiding this comment.
I think maybe passthrough should go in its own heading
There was a problem hiding this comment.
@davidmarkclements Yes, putting passthrough in its own heading is a good idea, I'll take care of it.
There was a problem hiding this comment.
@davidmarkclements I've decided not to put it into its own heading but into its own paragraph instead. It's still under "usage" where I believe it belongs. And I had already bumped the version up to 2.0.0.
|
Bump. Can this be merged? This also fixes #3 |
I think you are right, it could warrant a new major version because this PR changes the output which could potentially be a breaking change is some setups. I can go ahead and bump the version number. |
|
@jfahrenkrug would you say this is ready to go? |
@davidmarkclements I think so. The version in the package.json is currently set to ""2.0.0-beta.0". Do you want to leave it this way and release a beta first? I'm not sure how many people use this package. If it's a small number, we could probably skip the beta phase and go straight to "2.0.0". |
|
happy to skip beta |
@davidmarkclements Excellent! I just changed the version to "2.0.0", so it's ready to be merged now. |
|
@davidmarkclements I don't have write access, would you be able to merge it? |
This PR introduces breaking changes to pino-gelf, hence the major
version bump.
The GELF spec at http://docs.graylog.org/en/3.0/pages/gelf.html#gelf-payload-specification
specifies a flat JSON structure. Custom fields have to be prefixed with an underscore and can
only contain string values. We do that now. All tests pass.
Also, a passthrough mode is being added. That way we can pass pino messages to pino-gelf and then
pipe pino-gelf's output to another tool. That way we can both send to a graylog server and pretty-print.
This addresses #4
Any feedback is welcome!