feat(perf): Requests module SDK instrumentation documentation #9963
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
Instead of repeating ourselves, link to the full documentation.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Bundle ReportChanges will increase total bundle size by 527 bytes ⬆️
|
bcoe
approved these changes
May 9, 2024
| span?.setAttribute('server.address', parsedURL.hostname); | ||
| span?.setAttribute('server.port', parsedURL.port || undefined); | ||
|
|
||
| span?.setAttribute('http.response.status_code', response.status); |
There was a problem hiding this comment.
I like the use of optional chaining 👍 makes me question why I used an if statement in my docs.
| @@ -21,24 +21,15 @@ On the [**Requests** page](#requests-page), you get an overview of the domains t | |||
| ></iframe> | |||
| </div> | |||
|
|
|||
| ## Prerequisites | |||
| ## Prerequisites and Limitations | |||
|
|
|||
| <Note> | |||
| Network requests using non-HTTP protocols (FTP, WebSocket, etc.) are not supported at this time. | |||
| </Note> | |||
|
|
|||
| Availability of HTTP request monitoring depends on the SDK your application uses. In most cases, Sentry's SDKs automatically enable HTTP request tracking. You can check your SDK's <PlatformLink to="/performance/instrumentation/automatic-instrumentation">automatic instrumentation documentation</PlatformLink> to see if it includes tracking HTTP requests. | |||
|
|
|||
There was a problem hiding this comment.
NIt, I might add a heading "Custom Instrumentation" to draw people's attention to this option.
Also, worth a discussion about whether we should suggest setting network.protoco.name, network.protocol.version, if people try to instrument an HTTP/2 connection?
There was a problem hiding this comment.
🤔 I can add this to our span data conventions!
lizokm
approved these changes
May 9, 2024
docs/platforms/javascript/common/performance/instrumentation/requests-module.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/javascript/common/performance/instrumentation/requests-module.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/python/performance/instrumentation/requests-module.mdx
Outdated
Show resolved
Hide resolved
docs/platforms/python/performance/instrumentation/requests-module.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
antonpirker
pushed a commit
that referenced
this pull request
May 14, 2024
* Link to custom instrumentation docs * Add JavaScript platform docs * Add Python platform docs --------- Co-authored-by: Liza Mock <liza.mock@sentry.io>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I'm following the template set up for the Caches documentation! Adding manual instrumentation docs for JavaScript and Python, and linking to the snippets from the module documentation. Very similar to #9926