feat(instrumentation): Add allowUrls config option to web instrumentation #4938
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
jairo-mendoza
changed the title
jairo-mendoza
changed the title
MSNev
reviewed
Aug 28, 2024
| * @param url | ||
| * @param allowedUrls | ||
| */ | ||
| export function isUrlAllowed( |
There was a problem hiding this comment.
nit / fyi: as your introducing a new function to core, technically the xhr and fetch WILL require that they depend on this new version being released before they can consume this new function.
Generally, all versions are bumped together, but it might be worth calling out (somewhere)
There was a problem hiding this comment.
Called out the new function in core in the main changelog, but I'm not 100% sure if it's the right spot for the call out
MSNev
approved these changes
Sep 10, 2024
jairo-mendoza
commented
Sep 10, 2024
martinkuba
approved these changes
Sep 17, 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.
Which problem is this PR solving?
This change provides easier control over which urls should have spans created for it. It can also be used with
ignoreUrlsfor more granular control.Fixes #4899
Short description of the changes
Added
allowUrlsas a config option to both theXMLHttpRequestInstrumentationandFetchInstrumentationclasses.Addition of the
isUrlAllowedfunction in the core package that both the fetch and xhr instrumentation will depend on.Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
opentelemetry-webexamples (fetchandxml-http-request) to accept multiple URLs. Then I added theallowUrlsconfig option on the instrumentation set up and verified that traces were being created (or not created).Checklist: