chore(logging): log all headers but truncate or redact sensitive values

[iainsproat]

Description & motivation

Addresses #1644

Previously we would remove headers which may contain sensitive content. This was frustrating as we could not determine if a header was correctly included, or we could not determine if the value was as expected. While we do not wish to log the entire value it is appropriate in many cases to log the length of the value or a truncated portion of the value.

Changes:

• uses pino's redact property with a custom censor function
• all censored tokens have their original length printed
• authorization bearer tokens have the first 10 digits printed, to allow for identifying token IDs when debugging

To-do before merge:

Screenshots:

Validation of changes:

Checklist:

• My pull request follows the guidelines in the Contributing guide?
• My pull request does not duplicate any other open Pull Requests for the same update/change?
• My commits are related to the pull request and do not amend unrelated code or documentation.
• My code follows a similar style to existing code.
• I have added appropriate tests.
• I have updated or added relevant documentation.

References

[iainsproat]

Amendments have been tested and will follow the following pattern:

INFO: graphql response {"req":{"id":"d61f77b0-cd1a-44fb-810c-e931c7eaa016","method":"POST","headers":{"host":"127.0.0.1:59666","accept-encoding":"gzip, deflate","user-agent":"node-superagent/3.8.3","authorization":"Bearer 99e6a3d89e[TRUNCATED(original_length:48)]","content-type":"application/json","content-length":"98","connection":"close","x-request-id":"d61f77b0-cd1a-44fb-810c-e931c7eaa016"}},"authContext":{"auth":true,"userId":"33a3913421","role":"server:admin","scopes":["server:setup","streams:read","streams:write","users:read","users:email","tokens:write","tokens:read","profile:read","profile:email"]},"component":"graphql","graphql_operation_kind":"query","graphql_query":"query { stream(id:\"b340641aca\") { branch( name: \"main\" ) { name description } } } ","graphql_operation_value":"GQL query stream","grqphql_operation_name":"GQL stream","actionName":"query stream"}
INFO: request completed {"req":{"id":"d61f77b0-cd1a-44fb-810c-e931c7eaa016","method":"POST","path":"/graphql","headers":{"host":"127.0.0.1:59666","accept-encoding":"gzip, deflate","user-agent":"node-superagent/3.8.3","authorization":"Bearer 99e6a3d89e[TRUNCATED(original_length:49)]","content-type":"application/json","content-length":"98","connection":"close","x-request-id":"d61f77b0-cd1a-44fb-810c-e931c7eaa016"}},"res":{"statusCode":200},"responseTime":71}

[iainsproat]

Superseded