Skip to content

Commit 076ab90

Browse files
authored
fix(Apple): Updates in-app frames page to reflect reality (#13918)
1 parent ce43aa6 commit 076ab90

File tree

1 file changed

+8
-2
lines changed
  • docs/platforms/apple/common/usage/in-app-frames

1 file changed

+8
-2
lines changed

docs/platforms/apple/common/usage/in-app-frames/index.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@ description: "Learn about how your SDK marks frames as in-app."
44
sidebar_order: 40
55
---
66

7-
The `sentry-cocoa` SDK always marks public frameworks such as UIKitCore, CoreFoundation, GraphicsServices, and so forth as `not inApp`. If you're using a version of our SDK that's older than 7.0.0, all private frameworks and the main executable inside the application bundle will be marked as `inApp`. If you're using version 7.0.0 and up, the SDK will only set the `inApp` flag for frames originating from the main executable by using the [CFBundleExecutable](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleexecutable). For private frameworks such as Sentry, dynamic and static frameworks will differ.
7+
The main executable and frameworks inside the application bundle will be marked as `inApp`, while well known and public frameworks such as UIKitCore, CoreFoundation, GraphicsServices, and so forth will be marked as `not inApp`.
8+
9+
To fine-tune this behaviour, define [Stack Trace Rules](/concepts/data-management/event-grouping/stack-trace-rules/#stack-trace-rules) for your project. This will alow you to mark specific frameworks as `inApp` or `not inApp`, depending on whether you consider them part of your business logic, or third party dependencies. For reference, you can read up on the [default stack trace rules](https://github.com/getsentry/sentry/blob/20b05fc91a4ad6783bff1875327f4570bcfb5d00/src/sentry/grouping/enhancer/enhancement-configs/newstyle%402023-01-11.txt#L4).
10+
11+
{/*
12+
13+
NOTE: commenting out the below for easier reference: once we tackle a more mid-/long term solution discussed in https://github.com/getsentry/sentry-cocoa/issues/5252 this will become relevant/correct again
814
915
If you're not familiar with these terms, you can learn more:
1016
@@ -47,4 +53,4 @@ SentrySDK.start { options in
4753
## Static Frameworks
4854
4955
Because static frameworks end up in the main executable, if you're using one, the Sentry SDK won't be able to detect if a frame of the main executable
50-
originates from your application or a private framework and will mark all frames as `inApp`. To work around this, tell Sentry which frames should be marked as `not inApp`, using [Stack Trace Rules](/concepts/data-management/event-grouping/stack-trace-rules/#stack-trace-rules) on the server.
56+
originates from your application or a private framework and will mark all frames as `inApp`. To work around this, tell Sentry which frames should be marked as `not inApp`, using [Stack Trace Rules](/concepts/data-management/event-grouping/stack-trace-rules/#stack-trace-rules) on the server. */}

0 commit comments

Comments
 (0)