RUM-3060 Add docs for RUM iOS SDK Integrated Libraries #24253
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,52 @@ | ||||||
| --- | ||||||
| title: iOS and tvOS Libraries for RUM | ||||||
| code_lang: ios | ||||||
| type: multi-code-lang | ||||||
| code_lang_weight: 10 | ||||||
| aliases: | ||||||
| - /real_user_monitoring/ios/integrated_libraries/ | ||||||
| further_reading: | ||||||
| - link: https://github.com/DataDog/dd-sdk-ios | ||||||
| tag: "Source Code" | ||||||
| text: Source code for dd-sdk-ios | ||||||
| - link: /real_user_monitoring/mobile_and_tv_monitoring/integrated_libraries | ||||||
| tag: Documentation | ||||||
| text: Integrated Libraries | ||||||
| --- | ||||||
|
|
||||||
| This page lists integrated libraries you can use for iOS and tvOS applications. | ||||||
|
|
||||||
| ## Alamofire | ||||||
|
|
||||||
| Starting from version `2.5.0`, the RUM iOS SDK can automatically track [Alamofire][1] requests. | ||||||
|
|
||||||
| 1. Configure RUM monitoring by following the [Setup][2] guide. | ||||||
| 2. Enable `URLSessionInstrumentation` for `Alamofire.SessionDelegate`: | ||||||
|
|
||||||
| ```swift | ||||||
| import Alamofire | ||||||
| import DatadogRUM | ||||||
|
|
||||||
| URLSessionInstrumentation.enable(with: .init(delegateClass: SessionDelegate.self)) | ||||||
| ``` | ||||||
| For additional information on sampling rate, distributed tracing, and adding custom attributes to tracked RUM resources, refer to "Automatically track network requests" in the [Advanced Configuration][4] documentation. | ||||||
ncreated marked this conversation as resolved.
Show resolved
Hide resolved
ncreated marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ## Apollo GraphQL | ||||||
|
|
||||||
| Starting from version `2.5.0`, the RUM iOS SDK can automatically track [Apollo GraphQL][3] requests. | ||||||
|
|
||||||
| 1. Configure RUM monitoring by following the [Setup][2] guide. | ||||||
| 2. Enable `URLSessionInstrumentation` for `Apollo.URLSessionClient`: | ||||||
|
|
||||||
| ```swift | ||||||
| import Apollo | ||||||
| import DatadogRUM | ||||||
|
|
||||||
| URLSessionInstrumentation.enable(with: .init(delegateClass: URLSessionClient.self)) | ||||||
|
There was a problem hiding this comment. /improvement
Suggested change
There was a problem hiding this comment. Done 👍. I also considered linking |
||||||
| ``` | ||||||
| For additional information on sampling rate, distributed tracing, and adding custom attributes to tracked RUM resources, refer to "Automatically track network requests" in the [Advanced Configuration][4] documentation. | ||||||
cswatt marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| [1]: https://github.com/Alamofire/Alamofire | ||||||
| [2]: https://docs.datadoghq.com/real_user_monitoring/mobile_and_tv_monitoring/setup/ios/ | ||||||
| [3]: https://github.com/apollographql/apollo-ios | ||||||
| [4]: https://docs.datadoghq.com/real_user_monitoring/mobile_and_tv_monitoring/advanced_configuration/ios/#automatically-track-network-requests | ||||||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/improvement
have seen some customer asking where is
SessionDelegatetype.We should make sure from docs that it clearly states that
SessionDelegateis a customer type and implemented in their app.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is Alamofire's type 🤔 💭. Which is already covered in:
I can make it cleaner by:
WDYT @ganeshnj ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ultimately, I decided to add
Alamofire.namespace, same as for Apollo. I also considered linking toAlamofire.SessionDelegatedoc, but decided to not do it as external links are likely to change making our docs out-of-sync.