feat(replay): Add a replay-specific logger #13256
Merged
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
size-limit report 📦
|
Removes the old `logInfo` function and replaces it with a new replay-specific logger. Configuration is done when the replay integration is first initialized to avoid needing to pass around configuration options. This also means that we cannot select individual log statements to be added as breadcrumbs with `traceInternals` options. This also adds a `logger.exception` that wraps `captureException`. Note that only the following logging levels are supported: * info * log * warn * error With two additions: * exception * infoTick (needs a better name) - same as `info` but adds the breadcrumb in the next tick due to some pre-existing race conditions There are two configuration options: * enable(/disable)CaptureInternalExceptions * enable(/disable)TraceInternals
billyvg
force-pushed
the
feat-replay-replay-logger
branch
from
701d3ca to
11415f5
Compare
mydea
reviewed
Aug 8, 2024
| @@ -192,7 +193,8 @@ function getResponseData( | |||
|
|
|||
| return buildNetworkRequestOrResponse(headers, size, undefined); | |||
| } catch (error) { | |||
| DEBUG_BUILD && logger.warn('[Replay] Failed to serialize response body', error); | |||
| DEBUG_BUILD && logger.warn('Failed to serialize response body'); | |||
There was a problem hiding this comment.
I think the one improvement we can do here more is to avoid having to double-call this in so many places. Instead, what about we make this something like this:
DEBUG_BUILD && logger.exception(error, 'Failed to serialize response body');where the second argument is optional, and if defined will just logger.error this string? This may safe a few more bytes, and IMHO is also nicer from a usage experience...?
There was a problem hiding this comment.
Updated, though it didn't seem to help bundle size too much
mydea
reviewed
Aug 12, 2024
| traceInternals: boolean; | ||
| } | ||
|
|
||
| /** JSDoc */ |
mydea
reviewed
Aug 12, 2024
|
|
||
| function _addBreadcrumb(message: unknown, level: SeverityLevel = 'info'): void { | ||
| // Only support strings for breadcrumbs | ||
| if (typeof message !== 'string') { |
There was a problem hiding this comment.
l: Do we need this check? IMHO we generally use this ourselves, worst case ${message} will convert whatever it is to a string anyhow, which I guess is OK here...?
mydea
reviewed
Aug 12, 2024
| }); | ||
|
|
||
| _logger.exception = (error: unknown, ...message: unknown[]) => { | ||
| if (message && _logger.error) { |
There was a problem hiding this comment.
can message be empty here? I guess this always is at least an empty array, or is this not the case?
mydea
reviewed
Aug 12, 2024
| } else if (_trace) { | ||
| // No need for a breadcrumb is `_capture` is enabled since it should be | ||
| // captured as an exception | ||
| _addBreadcrumb(error instanceof Error ? error.message : 'Unknown error'); |
There was a problem hiding this comment.
possibly we can skip this check, as Error should be casted to a reasonable string automatically when we do ${message}?
mydea
approved these changes
Aug 12, 2024
This was referenced Sep 4, 2024
This was referenced Sep 24, 2024
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.
Removes the old
logInfofunction and replaces it with a new replay-specificlogger. Configuration is done when the replay integration is first initialized
to avoid needing to pass around configuration options. This also means
that we cannot select individual log statements to be added as breadcrumbs with
traceInternalsoptions.This also adds a
logger.exceptionthat wrapscaptureException.Note that only the following logging levels are supported:
infologwarnerrorWith two additions:
exceptioninfoTick(needs a better name) - same asinfobut adds the breadcrumb in the next tick due to some pre-existing race conditionsThere is one method to configure the logger:
setConfig({ traceInternals, captureExceptions })