Skip to content

Commit 78295b9

Browse files
philipphofmannphilipphofmann
authored
feat(apple): Remove 7.0.0 preview notes (#3471)
Remove the preview notes for sentry-cocoa 7.0.0.
1 parent fc3eda8 commit 78295b9

File tree

7 files changed

+51
-89
lines changed

7 files changed

+51
-89
lines changed

‎src/includes/grouping/in-app/apple.mdx

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,55 @@
1+
12
The sentry-cocoa SDK always marks public frameworks such as UIKitCore, CoreFoundation, GraphicsServices, and so forth as `not inApp`.
2-
All private frameworks and the main executable inside the application bundle are marked as `inApp`. The following marks
3-
frames from libdispatch starting with `_dispatch_` as `inApp`.
3+
Before version 7.0.0, the sentry-cocoa SDK marks all private frameworks and the main executable inside the application bundle as `inApp`. Since version 7.0.0,
4+
the sentry-cocoa SDK sets the `inApp` flag only for frames originating from the main executable by using the [CFBundleExecutable].
5+
For private frameworks, such as Sentry, dynamic and static frameworks differ. If you are not familiar with these terms, we recommend
6+
reading [Dynamic Library Programming Topics].
7+
8+
[CFBundleExecutable]: https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleexecutable
9+
[Dynamic Library Programming Topics]: https://developer.apple.com/library/archive/documentation/DeveloperTools/Conceptual/DynamicLibraries/000-Introduction/Introduction.html
10+
11+
##### Dynamic Frameworks
12+
13+
If you use dynamic frameworks, such as, for example, Sentry, the SDK marks these as `not inApp`. In case you have a private framework that should be `inApp`,
14+
you can use <PlatformLink to="/configuration/options/#in-app-include">inAppInclude</PlatformLink> or <PlatformLink to="/configuration/options/#in-app-exclude">inAppExclude</PlatformLink> of the SentryOptions.
15+
16+
```swift {tabTitle:Swift}
17+
import Sentry
18+
19+
SentrySDK.start { options in
20+
options.dsn = "___PUBLIC_DSN___"
21+
22+
// The SDK marks all frameworks starting with MyBusinessLogic as inApp
23+
options.add(inAppInclude: "MyBusinessLogic")
24+
25+
// The SDK marks all frameworks starting with MyFramework as not inApp
26+
options.add(inAppExclude: "MyFramework")
27+
}
28+
```
29+
30+
```objc {tabTitle:Objective-C}
31+
@import Sentry;
32+
33+
[SentrySDK startWithConfigureOptions:^(SentryOptions *options) {
34+
options.dsn = @"___PUBLIC_DSN___";
35+
36+
// The SDK marks all frameworks starting with MyBusinessLogic as inApp
37+
[options addInAppInclude:@"MyBusinessLogic"];
38+
39+
// The SDK marks all framework starting with MyFramework as not inApp
40+
[options addInAppExclude:@"MyFramework"];
41+
}];
42+
```
43+
44+
##### Static Frameworks
45+
46+
When using static frameworks, the frameworks end up in the main executable. Therefore, the SDK currently can't detect if a frame of the main executable
47+
originates from your application or a private framework and marks all of them as `inApp`. To improve your experience, use the below explained stack trace rules on the server to tell Sentry which should be marked as `not inApp`.
48+
49+
50+
#### Stack Trace Rules
51+
52+
The following marks frames from libdispatch starting with `_dispatch_` as `inApp`.
453
554
```discover {tabTitle:Enhancement Rules}
655
stack.function:_dispatch_* +app

‎src/includes/grouping/not-in-app/apple.mdx

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,3 @@ You can also achieve the same result by marking other frames `not inApp`. The fo
44
stack.function:DataRequest* -app
55
stack.function:DownloadRequest* -app
66
```
7-
8-
#### 7.0.0 Preview
9-
In the preview version 7.0.0, the sentry-cocoa SDK sets the `inApp` flag for frames originating from only the main executable by using the [CFBundleExecutable].
10-
Public frameworks such as UIKitCore, CoreFoundation, GraphicsServices, and so forth, are always marked as `not inApp`. For private frameworks, such
11-
as Sentry, dynamic and static frameworks differ. If you are not familiar with these terms, we recommend reading [Dynamic Library Programming Topics].
12-
13-
[CFBundleExecutable]: https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleexecutable
14-
[Dynamic Library Programming Topics]: https://developer.apple.com/library/archive/documentation/DeveloperTools/Conceptual/DynamicLibraries/000-Introduction/Introduction.html
15-
16-
##### Dynamic Frameworks
17-
18-
If you use dynamic frameworks, such as, for example, Sentry, the SDK marks these as `not inApp`. In case you have a private framework that should be `inApp`,
19-
you can use <PlatformLink to="/configuration/options/#in-app-include">inAppInclude</PlatformLink> or <PlatformLink to="/configuration/options/#in-app-exclude">inAppExclude</PlatformLink> of the SentryOptions.
20-
21-
```swift {tabTitle:Swift}
22-
import Sentry
23-
24-
SentrySDK.start { options in
25-
options.dsn = "___PUBLIC_DSN___"
26-
27-
// The SDK marks all frameworks starting with MyBusinessLogic as inApp
28-
options.add(inAppInclude: "MyBusinessLogic")
29-
30-
// The SDK marks all frameworks starting with MyFramework as not inApp
31-
options.add(inAppExclude: "MyFramework")
32-
}
33-
```
34-
35-
```objc {tabTitle:Objective-C}
36-
@import Sentry;
37-
38-
[SentrySDK startWithConfigureOptions:^(SentryOptions *options) {
39-
options.dsn = @"___PUBLIC_DSN___";
40-
41-
// The SDK marks all frameworks starting with MyBusinessLogic as inApp
42-
[options addInAppInclude:@"MyBusinessLogic"];
43-
44-
// The SDK marks all framework starting with MyFramework as not inApp
45-
[options addInAppExclude:@"MyFramework"];
46-
}];
47-
```
48-
49-
##### Static Frameworks
50-
51-
When using static frameworks, the frameworks end up in the main executable. Therefore, the SDK currently can't detect if a frame of the main executable
52-
originates from your application or a private framework and marks all of them as `inApp`. To improve your experience, use the above explained stack trace rules to tell Sentry which should be marked as `not inApp`.

‎src/platforms/apple/common/configuration/integrations/default.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,6 @@ This integration registers for lifecycle notifications and automatically starts
2121

2222
### SentryOutOfMemoryTrackingIntegration
2323

24-
<Note>
25-
26-
This is a preview API, available in 7.0.0-alpha.3. Features available in a preview API are still in-progress and may have bugs. We recognize the irony. The API may be renamed, changed, or removed in a future version.
27-
28-
</Note>
29-
3024
This integration tracks out-of-memory crashes based on heuristics. This feature is available for iOS, tvOS, and Mac Catalyst and works only if the application was in the foreground. Check out the <PlatformLink to="/configuration/out-of-memory/">configuration</PlatformLink> information for more details.
3125

3226
## Disable an Integration

‎src/platforms/apple/common/configuration/out-of-memory.mdx

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ sidebar_order: 10
44
description: "Learn how to turn off Out Of Memory"
55
---
66

7-
<Note>
8-
9-
This is a preview API, available in 7.0.0-alpha.3. Features available in a preview API are still in-progress and may have bugs. We recognize the irony. The API may be renamed, changed, or removed in a future version.
10-
We welcome your [feedback](https://github.com/getsentry/sentry-cocoa/discussions/1016).
11-
12-
</Note>
13-
147
This integration tracks out-of-memory (OOM) crashes based on heuristics. This feature is available for iOS, tvOS, and Mac Catalyst and works only if the application was in the foreground.
158

169
When your application uses too much RAM, the operating system kills your app without a normal termination process. Your process doesn't receive a signal or any other type of information to ensure an OOM occurred. As a result, in the Apple SDK, we track out-of-memory crashes during the app start based on heuristics. If your app runs in the background, we can't reliably detect OOMs and don't report them. If you're interested in the implementation details, you can check out [the code](https://github.com/getsentry/sentry-cocoa/blob/master/Sources/Sentry/SentryOutOfMemoryLogic.m) to find out more.

‎src/platforms/common/configuration/sampling.mdx

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,6 @@ redirect_from:
2323
- /performance/sampling/
2424
---
2525

26-
<PlatformSection supported={["apple"]}>
27-
<Note>
28-
29-
Attention: This is a preview API available since 7.0.0-alpha.2. This API is not in stable state yet. It may change in the future.
30-
31-
</Note>
32-
33-
</PlatformSection>
34-
3526
Adding Sentry to your app gives you a great deal of very valuable information about errors and performance you wouldn't otherwise get. And lots of information is good -- as long as it's the right information, at a reasonable volume.
3627

3728
## Sampling Error Events

‎src/platforms/common/performance/custom-instrumentation.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,6 @@ supported:
1717
description: "Learn how to capture performance data on any action in your app."
1818
---
1919

20-
<PlatformSection supported={["apple"]}>
21-
22-
<Note>
23-
24-
Attention: This is a preview API available since 7.0.0-alpha.2. This API is not in stable state yet. It may change in the future.
25-
26-
</Note>
27-
28-
</PlatformSection>
29-
3020
<Note>
3121

3222
To capture transactions customized to your organization's needs, you must first <PlatformLink to="/performance/">set up performance monitoring.</PlatformLink>

‎src/platforms/common/performance/index.mdx

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,6 @@ redirect_from:
2222
- /platforms/javascript/performance/apm-to-tracing/
2323
---
2424

25-
<PlatformSection supported={["apple"]}>
26-
27-
<Note>
28-
29-
Attention: This is a preview API available since 7.0.0-alpha.2. This API is not in stable state yet. It may change in the future.
30-
31-
</Note>
32-
33-
</PlatformSection>
3425

3526
<Alert level="info" title="Do you need to set up?">
3627

0 commit comments

Comments
 (0)