Skip to content

fix(apple): UIViewController wording #4899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 5, 2022
Merged

fix(apple): UIViewController wording #4899

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion ...latforms/apple/common/performance/instrumentation/automatic-instrumentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Capturing transactions requires that you first <PlatformLink to="/performance/">

This feature is available for iOS, tvOS, and Mac Catalyst, and only works for UIViewControllers.

The UIViewController Instrumentation, once enabled, captures transactions whenever your app loads an in-app UIViewController, meaning it doesn't capture transactions of UIKits UIViewControllers, other third-party libraries, or SwiftUI. The SDK sets the transaction name to the name of the ViewController, including the module — for example, `Your_App.MainViewController` — and the transaction operation to `ui.load`.
The UIViewController Instrumentation, once enabled, captures transactions when your app loads an [UIViewController][UIViewController], which is in-app and a subclass of UIViewController. Nevertheless, the SDK doesn't capture transactions for UIViewControllers of third-party libraries or SwiftUI.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The UIViewController Instrumentation, once enabled, captures transactions when your app loads an [UIViewController][UIViewController], which is in-app and a subclass of UIViewController. Nevertheless, the SDK doesn't capture transactions for UIViewControllers of third-party libraries or SwiftUI.
The UIViewController Instrumentation, once enabled, captures transactions when your app loads an [UIViewController](https://developer.apple.com/documentation/uikit/uiviewcontroller), which is in-app and a subclass of UIViewController. Nevertheless, the SDK doesn't capture transactions for UIViewControllers of third-party libraries or SwiftUI.

The SDK sets the transaction name to the name of the ViewController, including the module — for example, `Your_App.MainViewController` — and the transaction operation to `ui.load`.

The SDK creates spans to provide insight into the time consumed by each of the methods shown in the screenshot below. Due to implementation limitations, the SDK only adds a span for loadView if the instrumented view controller implements it. The SDK adds spans for all other methods, whether you implement them in your view controller or not.

Expand All @@ -40,6 +41,8 @@ SentrySDK.start { options in
}];
```

[UIViewController]: https://developer.apple.com/documentation/uikit/uiviewcontroller

## App Start Instrumentation

This feature is available for iOS, tvOS, and Mac Catalyst.
Expand Down