fix(apple): Docs for enableMetricKitRawPayload (#10334)

* fix(apple): Docs for enableMetricKitAttachments Add docs for enableMetricKitAttachments available on Cocoa 8.29.0 and above. * rename to enableMetricKitRawPayload * Update docs/platforms/apple/common/configuration/metric-kit.mdx Co-authored-by: Karl Heinz Struggl <[email protected]> * Update docs/platforms/apple/common/configuration/metric-kit.mdx Co-authored-by: Karl Heinz Struggl <[email protected]> --------- Co-authored-by: Karl Heinz Struggl <[email protected]>
getsentry · Jun 14, 2024 · b356998 · b356998
1 parent 68cadb8
commit b356998
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/docs/platforms/apple/common/configuration/metric-kit.mdx b/docs/platforms/apple/common/configuration/metric-kit.mdx
@@ -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;
+}];
+```