feat(develop): Add docs about integrations in the SDK #11405
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
cleptric
approved these changes
Sep 20, 2024
sentrivana
approved these changes
Sep 20, 2024
|
|
||
| /** | ||
| * This hook is only called once, even if multiple clients are created. | ||
| * It does not receives any arguments, and should only use for e.g. global monkey patching and similar things. |
There was a problem hiding this comment.
Suggested change
| * It does not receives any arguments, and should only use for e.g. global monkey patching and similar things. | |
| * It does not receive any arguments, and should only use for e.g. global monkey patching and similar things. |
|
|
||
| In addition, default integrations should be well-tested. If a new integration is default, it should be tested in all supported environments and configurations to ensure it doesn't cause issues. We should not be adding new default integrations without proper testing. | ||
|
|
||
| If an default integration creates a high volume of new data (for example a lot spans or transactions), it should be opt-in and only made default in a new major version of the SDK. This is to prevent users from being surprised by the new data and to prevent potential performance issues. In the case of spans we especially have to take care to ensure that the spans generated by a new integration don't make traces too noisy, which hurts their usefulness. |
There was a problem hiding this comment.
Suggested change
| If an default integration creates a high volume of new data (for example a lot spans or transactions), it should be opt-in and only made default in a new major version of the SDK. This is to prevent users from being surprised by the new data and to prevent potential performance issues. In the case of spans we especially have to take care to ensure that the spans generated by a new integration don't make traces too noisy, which hurts their usefulness. | |
| If a default integration creates a high volume of new data (for example a lot spans or transactions), it should be opt-in and only made default in a new major version of the SDK. This is to prevent users from being surprised by the new data and to prevent potential performance issues. In the case of spans we especially have to take care to ensure that the spans generated by a new integration don't make traces too noisy, which hurts their usefulness. |
Comment on lines
+364
to
+366
| - Does the integration add significant overhead to the SDK? | ||
| - Does the integration create a high volume of new data? | ||
| - Does the integration have potential compatibility issues with other integrations or the SDK itself? |
There was a problem hiding this comment.
I'd add:
Suggested change
| - Does the integration add significant overhead to the SDK? | |
| - Does the integration create a high volume of new data? | |
| - Does the integration have potential compatibility issues with other integrations or the SDK itself? | |
| - Does the integration add significant overhead to the SDK? | |
| - Does the integration create a high volume of new data? | |
| - Is the potential for issues in the integration low? | |
| - Does the integration have potential compatibility issues with other integrations or the SDK itself? |
Lms24
approved these changes
Sep 20, 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.
The diff is a bit noisy because of prettier formatting, but the main additions are at the very bottom, starting from
## Integrations.This patch adds documentation around how integrations work in the SDKs. It gives some guidelines on how the public API should work, and how we approach looking at default integrations.