fix: Fix timestamp drift due to using instanceof typeguard #827
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
product-auto-label
bot
added
size: xs
cindy-peng
commented
Nov 13, 2023
| @@ -253,7 +253,7 @@ export class LoggingCommon { | |||
| // metadata. As Winston 3 buffers logs when a transport (such as this one) | |||
| // invokes its log callback asynchronously, a timestamp assigned at log time | |||
| // is more accurate than one assigned in a transport. | |||
| if (metadata.timestamp instanceof Date) { | |||
There was a problem hiding this comment.
This typeguard is preventing customer metadata timestamp to be properly assigned to entry metadata. Considering entryMetadata is expecting a union type Timestamp | null | undefined, I think it is not necessary for us to force a Date type to be checked and assigned.
|
Can you add any tests around this? Try to make one that would fail before the change, but passes after |
Good suggestion. Will do! |
product-auto-label
bot
added
the
stale: old
product-auto-label
bot
added
stale: extraold
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.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #802 🦕
This is to fix timestamp drift issue which may cause timestamp inaccuracy while using OpenTelemetry and view trace timespans. Since timestamp within metadata is defined as a union-types including null and undefined, the type guard is not necessary here.