Document log redaction #1255
Merged
Document log redaction #1255
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
StarpTech
reviewed
Nov 16, 2018
test/logger.test.js
Outdated
| stream.once('data', listenAtLogLine => { | ||
| t.ok(listenAtLogLine, 'listen at log message is ok') | ||
| stream.once('data', line => { | ||
| t.equal(line.req.headers.authorization, '[Redacted]', 'authoriztion is redacted') |
StarpTech
reviewed
Nov 16, 2018
docs/Logging.md
Outdated
|
|
||
| [Pino](https://getpino.io) supports low-overhead log redaction, to | ||
| filter out some of properties. As an example, if logging all the HTTP | ||
| headers is needed, we must redact and filter out the `Authorization` |
There was a problem hiding this comment.
I think the sentence is wrong because if we want to log all headers we do nothing.
jsumners
requested changes
Nov 17, 2018
|
@StarpTech @jsumners updated. |
cemremengu
reviewed
Nov 20, 2018
docs/Logging.md
Outdated
|
|
||
| ## Log Redaction | ||
|
|
||
| [Pino](https://getpino.io) supports low-overhead log redaction, to |
There was a problem hiding this comment.
log redaction, to obscure -> log redaction for obscuring
|
PTAL |
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Log redaction is a key new feature of pino v5, and it's better to highligh it.
Checklist
npm run testandnpm run benchmark