feat(server/errors): error messages can use message template format #3160
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.
Description & motivation
Errors derived from vError can attach properties to
info
parameter of theoptions
object when constructed.These
info
properties can now be used to populate a string template in the error's message. The message template follows pino pretty format.This reduces the cardinality of errors, enabling similar errors to be simply searchable using the template string.
The code is modified from pino-pretty repository, licensed under an MIT license.
Changes:
Additional minor changes:
To-do before merge:
Validation of changes:
The server logs the template and properties separately:
The client sees the formatted message, with the template populated with the data:
Checklist:
References