Add more debug logging to the typescript client#4356
Merged
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 of Changes
This adds some logging utilities, that will probably be helpful for debugging issues.
stdbLoggercan now accept lazy messages. If you callsetGlobalLogLevel, that will set a log level globally. It is set toinfoby default, but when troubleshooting, we can ask people to runsetGlobalLogLevel('trace')and share more detailed logs.In this PR, it adds a new new logs at the
tracelevel:There are also some formatting niceties to truncate large arrays and redact fields that look like credentials.
We are also using
safe-stable-stringifyto handle some cases that would be errors inJSON.stringify.API and ABI breaking changes
This adds the
setGlobalLogLevelfunction, which is useful for debugging.Expected complexity level and risk
1.5 - the only real risk here is that
Testing
This has some tests of formatting in
logger.test.ts.