Skip to content

fix(apple): Docs for enableMetricKitRawPayload #10334

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 4 commits into from
Jun 14, 2024
Merged

fix(apple): Docs for enableMetricKitRawPayload #10334

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a6cebc6
fix(apple): Docs for enableMetricKitAttachments
philipphofmann Jun 10, 2024
b53bee8
rename to enableMetricKitRawPayload
philipphofmann Jun 10, 2024
834b3e0
Update docs/platforms/apple/common/configuration/metric-kit.mdx
philipphofmann Jun 10, 2024
ed857cf
Update docs/platforms/apple/common/configuration/metric-kit.mdx
philipphofmann Jun 10, 2024
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
22 changes: 22 additions & 0 deletions docs/platforms/apple/common/configuration/metric-kit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,25 @@ SentrySDK.start { options in
options.enableMetricKit = YES;
}];
```

You can enable `enableMetricKitRawPayload` to view the raw MetricKit diagnostic payload in JSON format as an attachment on the converted event in Sentry. This feature is available on Cocoa 8.29.0 and up.

```swift {tabTitle:Swift}
import Sentry

SentrySDK.start { options in
options.dsn = "___PUBLIC_DSN___"
options.enableMetricKit = true
options.enableMetricKitRawPayload = true
}
```

```objc {tabTitle:Objective-C}
@import Sentry;

[SentrySDK startWithConfigureOptions:^(SentryOptions *options) {
options.dsn = @"___PUBLIC_DSN___";
options.enableMetricKit = YES;
options.enableMetricKitRawPayload = YES;
}];
```
Loading