feat(client): add logPrefix option to SorokitClientConfig #257 - #346
Open
gitGolf wants to merge 1 commit into
Open
feat(client): add logPrefix option to SorokitClientConfig #257#346gitGolf wants to merge 1 commit into
gitGolf wants to merge 1 commit into
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.
Overview
This PR adds a
logPrefixoption toSorokitClientConfigso consumers running multiple client instances (e.g. one per network) can distinguish which client emitted each log line.Related Issue
Closes #257
Changes
🔏
logPrefixConfig Option[ADD]
logPrefix?: stringtoSorokitClientConfiginsrc/client/createSorokitClient.tsprefixtocreateLoggerwhen no custom logger is provided.loggeris supplied.[ADD]
prefix?: stringtoLoggerOptionsinsrc/shared/logger.tsconsole.debug/info/warn/error(default:"[sorokit]").[app:testnet]or[sorokit:mainnet].[ADD] Tests in
src/tests/logger.test.tscreateLogger({ prefix: "[sorokit:testnet]" })emits with the custom prefix.createSorokitClient({ debug: true, logPrefix: "[app:testnet]" })logs with the custom prefix.Verification Results
SorokitClientConfighaslogPrefix?: stringcreateLoggeraccepts an optional prefixLoggerOptions.prefixcreateSorokitClient({ network: "testnet", debug: true, logPrefix: "[app:testnet]" })logs with custom prefix