From a6cebc6588b82b0a934a823a96878c2f8884acb1 Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Mon, 10 Jun 2024 10:41:01 +0200 Subject: [PATCH] fix(apple): Docs for enableMetricKitAttachments Add docs for enableMetricKitAttachments available on Cocoa 8.29.0 and above. --- .../apple/common/configuration/metric-kit.mdx | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/platforms/apple/common/configuration/metric-kit.mdx b/docs/platforms/apple/common/configuration/metric-kit.mdx index a6c9875c46479..0fc00e09e7c57 100644 --- a/docs/platforms/apple/common/configuration/metric-kit.mdx +++ b/docs/platforms/apple/common/configuration/metric-kit.mdx @@ -34,3 +34,23 @@ SentrySDK.start { options in options.enableMetricKit = YES; }]; ``` + +You can enable `enableMetricKitAttachments` 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.enableMetricKitAttachments = true +} +``` + +```objc {tabTitle:Objective-C} +@import Sentry; + +[SentrySDK startWithConfigureOptions:^(SentryOptions *options) { + options.dsn = @"___PUBLIC_DSN___"; + options.enableMetricKitAttachments = YES; +}]; +```