RUM-3060 Add docs for RUM iOS SDK Integrated Libraries #24253
Conversation
Preview links (active after the
|
ncreated
changed the title
| import Alamofire | ||
| import DatadogRUM | ||
|
|
||
| URLSessionInstrumentation.enable(with: .init(delegateClass: SessionDelegate.self)) |
There was a problem hiding this comment.
/improvement
have seen some customer asking where is SessionDelegate type.
We should make sure from docs that it clearly states that SessionDelegate is a customer type and implemented in their app.
There was a problem hiding this comment.
It is Alamofire's type 🤔 💭. Which is already covered in:
- Enable
URLSessionInstrumentationforAlamofire.SessionDelegate:
I can make it cleaner by:
| URLSessionInstrumentation.enable(with: .init(delegateClass: SessionDelegate.self)) | |
| URLSessionInstrumentation.enable(with: .init(delegateClass: Alamofire.SessionDelegate.self)) |
WDYT @ganeshnj ?
There was a problem hiding this comment.
Ultimately, I decided to add Alamofire. namespace, same as for Apollo. I also considered linking to Alamofire.SessionDelegate doc, but decided to not do it as external links are likely to change making our docs out-of-sync.
content/en/real_user_monitoring/mobile_and_tv_monitoring/integrated_libraries/ios.md
Outdated
Show resolved
Hide resolved
| import Apollo | ||
| import DatadogRUM | ||
|
|
||
| URLSessionInstrumentation.enable(with: .init(delegateClass: URLSessionClient.self)) |
There was a problem hiding this comment.
/improvement
URLSessionClient is very common name, let's namespace it/
| URLSessionInstrumentation.enable(with: .init(delegateClass: URLSessionClient.self)) | |
| URLSessionInstrumentation.enable(with: .init(delegateClass: Apollo.URLSessionClient.self)) |
There was a problem hiding this comment.
Done 👍. I also considered linking Apollo.URLSessionClient doc but decided to not do it as external links are likely to change making our docs out-of-sync.
|
Small doc improvement comments, nothing blocking. |
content/en/real_user_monitoring/mobile_and_tv_monitoring/integrated_libraries/ios.md
Outdated
Show resolved
Hide resolved
…rated_libraries/ios.md
content/en/real_user_monitoring/mobile_and_tv_monitoring/integrated_libraries/ios.md
Outdated
Show resolved
Hide resolved
cswatt
deleted the
maciek.grzybowski/RUM-3060-add-docs-for-ios-integrations
branch
* RUM-3060 Add iOS entry in rum-mobile-integrated-libraries.html * RUM-3060 Create itegrated_libraries/ios.md * RUM-3060 Explain Alamofire and GrapQL integration * RUM-3060 Fix links * RUM-3060 Add namespace to instrumented delegate class * Update content/en/real_user_monitoring/mobile_and_tv_monitoring/integrated_libraries/ios.md * Update doc link for consistency --------- Co-authored-by: cecilia saixue watt <[email protected]>
What does this PR do? What is the motivation?
Adding "Integrated Libraries" to guide users on how to instrument Alamofire and Apollo GraphQL with the RUM iOS SDK.
Merge instructions
Additional notes
Relates to changes in
dd-sdk-ios: DataDog/dd-sdk-ios#1966