feat: initial web vitals instrumentation #84
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
pkanal
changed the title
pkanal
commented
Feb 26, 2024
|
|
||
| if (this.vitalsToTrack.includes('LCP')) { | ||
| onLCP((vital) => { | ||
| this.onReportLCP(vital); |
There was a problem hiding this comment.
I went back and forth a lot on whether to make these separate onReport functions, or whether to make a single generic one. I found that the types and tests worked out a lot better with them all being more specific.
There was a problem hiding this comment.
i ❤️ the separate functions
pkanal
commented
Feb 26, 2024
| SimpleSpanProcessor, | ||
| } from '@opentelemetry/sdk-trace-base'; | ||
|
|
||
| describe('Web Vitals Instrumentation Tests', () => { |
There was a problem hiding this comment.
For tests, decided to focus on the spans being generated instead of whether the web vitals functions fire when they're supposed to since that's covered in the tests for the web-vitals library. Will eventually want to write smoke tests for this but will make that a separate PR.
| }, | ||
| ) { | ||
| super('@honeycombio/instrumentation-web-vitals', '0.0.1', { | ||
| // NOTE: this is an unfortunate necessity to initially set |
There was a problem hiding this comment.
Thank you for adding a detailed note here!
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.
Which problem is this PR solving?
Adds basic web vitals span based auto-instrumentation. Heavily based on what will be available upstream, with the main difference being that the upstream instrumentation will be based on events, we'll have to support that down the line as well.
Should align very closely with the spec laid out in #61
Short description of the changes
Out of scope for this PR
This PR is really aimed at getting the base instrumentation into the package so there will be follow up work to:
How to verify that this has the expected result