From 828d362a87a11d602f27c9f59737971fc47341a4 Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Thu, 12 Oct 2023 13:21:58 +0200 Subject: [PATCH 1/9] feat(apple): MetricKit GA Remove experimental note and add some info on MetricKit events. --- src/platforms/apple/common/configuration/metric-kit.mdx | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/platforms/apple/common/configuration/metric-kit.mdx b/src/platforms/apple/common/configuration/metric-kit.mdx index 820e62b719a99..2d0f0eb182d0e 100644 --- a/src/platforms/apple/common/configuration/metric-kit.mdx +++ b/src/platforms/apple/common/configuration/metric-kit.mdx @@ -4,9 +4,7 @@ sidebar_order: 20 description: "This feature, once enabled, subscribes to MXDiagnosticPayload data of MetricKit and it to Sentry." --- - - -Once enabled, this feature subscribes to [MetricKit's](https://developer.apple.com/documentation/metrickit) [MXDiagnosticPayload](https://developer.apple.com/documentation/metrickit/mxdiagnosticpayload) data, converts it to events, and sends it to Sentry. This feature is available on Cocoa 8.0.0 and up. +Once enabled, this feature subscribes to [MetricKit's](https://developer.apple.com/documentation/metrickit) [MXDiagnosticPayload](https://developer.apple.com/documentation/metrickit/mxdiagnosticpayload) data, converts it to events, and sends it to Sentry. This feature is available on Cocoa 8.14.0 and up. The MetricKit integration subscribes to: @@ -15,8 +13,9 @@ The MetricKit integration subscribes to: - [MXCPUExceptionDiagnostic](https://developer.apple.com/documentation/metrickit/mxcpuexceptiondiagnostic) The SDK supports this feature from iOS 15 and up and macOS 12 and up because in these versions, MetricKit delivers diagnostic reports immediately, which allows the Sentry SDK to apply current data from the scope. +It is worth noting that the Cocoa SDK has no control over the stacktraces MetricKit provides. Some stacktraces from MetricKit only offer a couple of frames. You can drop such events in `beforeSend` and identify MetricKit events by looking at the `mechanism.type` of the `exception`, which are `mx_hang_diagnostic`, `mx_cpu_exception`, and `mx_disk_write_exception`. -This is an experimental feature requiring opt-in, and can be enabled by setting the `enableMetricKit` option to `true`: +This feature requires opt-in, and can be enabled by setting the `enableMetricKit` option to `true`: From f0f1b5fed03cccbebd4706179087240f3c37ec05 Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Thu, 12 Oct 2023 15:33:28 +0200 Subject: [PATCH 2/9] Update src/platforms/apple/common/configuration/metric-kit.mdx Co-authored-by: Karl Heinz Struggl --- src/platforms/apple/common/configuration/metric-kit.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/apple/common/configuration/metric-kit.mdx b/src/platforms/apple/common/configuration/metric-kit.mdx index 2d0f0eb182d0e..55b7db45c7f27 100644 --- a/src/platforms/apple/common/configuration/metric-kit.mdx +++ b/src/platforms/apple/common/configuration/metric-kit.mdx @@ -13,7 +13,7 @@ The MetricKit integration subscribes to: - [MXCPUExceptionDiagnostic](https://developer.apple.com/documentation/metrickit/mxcpuexceptiondiagnostic) The SDK supports this feature from iOS 15 and up and macOS 12 and up because in these versions, MetricKit delivers diagnostic reports immediately, which allows the Sentry SDK to apply current data from the scope. -It is worth noting that the Cocoa SDK has no control over the stacktraces MetricKit provides. Some stacktraces from MetricKit only offer a couple of frames. You can drop such events in `beforeSend` and identify MetricKit events by looking at the `mechanism.type` of the `exception`, which are `mx_hang_diagnostic`, `mx_cpu_exception`, and `mx_disk_write_exception`. +Note that the Cocoa SDK has no control over the stacktraces provided by MetricKit. Some stacktraces from MetricKit only offer a couple of frames. If these are not useful to you, you can drop such events in `beforeSend`. You can identify MetricKit events by looking at the `mechanism.type` of the `exception`, which are `mx_hang_diagnostic`, `mx_cpu_exception`, and `mx_disk_write_exception`. This feature requires opt-in, and can be enabled by setting the `enableMetricKit` option to `true`: From 4f9820590efa648fdba383d9ef6e28d09f4d11d1 Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Thu, 12 Oct 2023 15:33:33 +0200 Subject: [PATCH 3/9] Update src/platforms/apple/common/configuration/metric-kit.mdx Co-authored-by: Karl Heinz Struggl --- src/platforms/apple/common/configuration/metric-kit.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/apple/common/configuration/metric-kit.mdx b/src/platforms/apple/common/configuration/metric-kit.mdx index 55b7db45c7f27..883717fc2536b 100644 --- a/src/platforms/apple/common/configuration/metric-kit.mdx +++ b/src/platforms/apple/common/configuration/metric-kit.mdx @@ -15,7 +15,7 @@ The MetricKit integration subscribes to: The SDK supports this feature from iOS 15 and up and macOS 12 and up because in these versions, MetricKit delivers diagnostic reports immediately, which allows the Sentry SDK to apply current data from the scope. Note that the Cocoa SDK has no control over the stacktraces provided by MetricKit. Some stacktraces from MetricKit only offer a couple of frames. If these are not useful to you, you can drop such events in `beforeSend`. You can identify MetricKit events by looking at the `mechanism.type` of the `exception`, which are `mx_hang_diagnostic`, `mx_cpu_exception`, and `mx_disk_write_exception`. -This feature requires opt-in, and can be enabled by setting the `enableMetricKit` option to `true`: +To use this feature, enable it by setting the `enableMetricKit` option to `true`: From 0c044a93cd631112156ba62a2eddf547517d6f5a Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Fri, 13 Oct 2023 14:05:08 +0200 Subject: [PATCH 4/9] Update src/platforms/apple/common/configuration/metric-kit.mdx Co-authored-by: Liza Mock --- src/platforms/apple/common/configuration/metric-kit.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/apple/common/configuration/metric-kit.mdx b/src/platforms/apple/common/configuration/metric-kit.mdx index 883717fc2536b..3a04c237e72bc 100644 --- a/src/platforms/apple/common/configuration/metric-kit.mdx +++ b/src/platforms/apple/common/configuration/metric-kit.mdx @@ -15,7 +15,7 @@ The MetricKit integration subscribes to: The SDK supports this feature from iOS 15 and up and macOS 12 and up because in these versions, MetricKit delivers diagnostic reports immediately, which allows the Sentry SDK to apply current data from the scope. Note that the Cocoa SDK has no control over the stacktraces provided by MetricKit. Some stacktraces from MetricKit only offer a couple of frames. If these are not useful to you, you can drop such events in `beforeSend`. You can identify MetricKit events by looking at the `mechanism.type` of the `exception`, which are `mx_hang_diagnostic`, `mx_cpu_exception`, and `mx_disk_write_exception`. -To use this feature, enable it by setting the `enableMetricKit` option to `true`: +Enable this feature by setting the `enableMetricKit` option to `true`: From 873af23e86274ad256e1503d1ee7be0a3f3a5a1b Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Fri, 13 Oct 2023 14:06:30 +0200 Subject: [PATCH 5/9] Update src/platforms/apple/common/configuration/metric-kit.mdx Co-authored-by: Liza Mock --- src/platforms/apple/common/configuration/metric-kit.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/platforms/apple/common/configuration/metric-kit.mdx b/src/platforms/apple/common/configuration/metric-kit.mdx index 3a04c237e72bc..d012bee4b3103 100644 --- a/src/platforms/apple/common/configuration/metric-kit.mdx +++ b/src/platforms/apple/common/configuration/metric-kit.mdx @@ -13,7 +13,10 @@ The MetricKit integration subscribes to: - [MXCPUExceptionDiagnostic](https://developer.apple.com/documentation/metrickit/mxcpuexceptiondiagnostic) The SDK supports this feature from iOS 15 and up and macOS 12 and up because in these versions, MetricKit delivers diagnostic reports immediately, which allows the Sentry SDK to apply current data from the scope. -Note that the Cocoa SDK has no control over the stacktraces provided by MetricKit. Some stacktraces from MetricKit only offer a couple of frames. If these are not useful to you, you can drop such events in `beforeSend`. You can identify MetricKit events by looking at the `mechanism.type` of the `exception`, which are `mx_hang_diagnostic`, `mx_cpu_exception`, and `mx_disk_write_exception`. + +Note that the Cocoa SDK has no control over the stacktraces provided by MetricKit. Some only offer a couple of frames. If these aren't useful to you, you can drop them in `beforeSend`. + +You can identify MetricKit events by looking at the `mx_hang_diagnostic`, `mx_cpu_exception`, and `mx_disk_write_exception` `mechanism.type`. Enable this feature by setting the `enableMetricKit` option to `true`: From 7d491f99b6504e84609de5a0db35264b746d793f Mon Sep 17 00:00:00 2001 From: "getsantry[bot]" <66042841+getsantry[bot]@users.noreply.github.com> Date: Fri, 13 Oct 2023 12:08:06 +0000 Subject: [PATCH 6/9] style(lint): Auto commit lint changes --- src/platforms/apple/common/configuration/metric-kit.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/apple/common/configuration/metric-kit.mdx b/src/platforms/apple/common/configuration/metric-kit.mdx index d012bee4b3103..91651dcab3520 100644 --- a/src/platforms/apple/common/configuration/metric-kit.mdx +++ b/src/platforms/apple/common/configuration/metric-kit.mdx @@ -14,7 +14,7 @@ The MetricKit integration subscribes to: The SDK supports this feature from iOS 15 and up and macOS 12 and up because in these versions, MetricKit delivers diagnostic reports immediately, which allows the Sentry SDK to apply current data from the scope. -Note that the Cocoa SDK has no control over the stacktraces provided by MetricKit. Some only offer a couple of frames. If these aren't useful to you, you can drop them in `beforeSend`. +Note that the Cocoa SDK has no control over the stacktraces provided by MetricKit. Some only offer a couple of frames. If these aren't useful to you, you can drop them in `beforeSend`. You can identify MetricKit events by looking at the `mx_hang_diagnostic`, `mx_cpu_exception`, and `mx_disk_write_exception` `mechanism.type`. From 36fc1f22da254315d55a1e31a5ce865af7701261 Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Fri, 13 Oct 2023 14:05:57 +0200 Subject: [PATCH 7/9] change page title to MetricKit --- src/platforms/apple/common/configuration/metric-kit.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/apple/common/configuration/metric-kit.mdx b/src/platforms/apple/common/configuration/metric-kit.mdx index 91651dcab3520..bc48507d08421 100644 --- a/src/platforms/apple/common/configuration/metric-kit.mdx +++ b/src/platforms/apple/common/configuration/metric-kit.mdx @@ -1,5 +1,5 @@ --- -title: Metric Kit +title: MetricKit sidebar_order: 20 description: "This feature, once enabled, subscribes to MXDiagnosticPayload data of MetricKit and it to Sentry." --- From 31f2c0e392cf0febc1fe0c5d38723b34440c89d0 Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Fri, 13 Oct 2023 14:15:29 +0200 Subject: [PATCH 8/9] code review --- .../apple/common/configuration/metric-kit.mdx | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/src/platforms/apple/common/configuration/metric-kit.mdx b/src/platforms/apple/common/configuration/metric-kit.mdx index bc48507d08421..31151993c68ee 100644 --- a/src/platforms/apple/common/configuration/metric-kit.mdx +++ b/src/platforms/apple/common/configuration/metric-kit.mdx @@ -4,15 +4,10 @@ sidebar_order: 20 description: "This feature, once enabled, subscribes to MXDiagnosticPayload data of MetricKit and it to Sentry." --- -Once enabled, this feature subscribes to [MetricKit's](https://developer.apple.com/documentation/metrickit) [MXDiagnosticPayload](https://developer.apple.com/documentation/metrickit/mxdiagnosticpayload) data, converts it to events, and sends it to Sentry. This feature is available on Cocoa 8.14.0 and up. +The [MetricKit](https://developer.apple.com/documentation/metrickit) integration subscribes to [MXHangDiagnostic](https://developer.apple.com/documentation/metrickit/mxhangdiagnostic), [MXDiskWriteExceptionDiagnostic](https://developer.apple.com/documentation/metrickit/mxdiskwriteexceptiondiagnostic) +and [MXCPUExceptionDiagnostic](https://developer.apple.com/documentation/metrickit/mxcpuexceptiondiagnostic), which it converts to Sentry events. -The MetricKit integration subscribes to: - -- [MXHangDiagnostic](https://developer.apple.com/documentation/metrickit/mxhangdiagnostic) -- [MXDiskWriteExceptionDiagnostic](https://developer.apple.com/documentation/metrickit/mxdiskwriteexceptiondiagnostic) -- [MXCPUExceptionDiagnostic](https://developer.apple.com/documentation/metrickit/mxcpuexceptiondiagnostic) - -The SDK supports this feature from iOS 15 and up and macOS 12 and up because in these versions, MetricKit delivers diagnostic reports immediately, which allows the Sentry SDK to apply current data from the scope. +This feature is available on Cocoa 8.14.0 and up. The SDK supports this feature from iOS 15 and up and macOS 12 and up because in these versions, MetricKit delivers diagnostic reports immediately, which allows the Sentry SDK to apply current data from the scope. Note that the Cocoa SDK has no control over the stacktraces provided by MetricKit. Some only offer a couple of frames. If these aren't useful to you, you can drop them in `beforeSend`. From e1251b876fb8780947020ad0904dfc676cebe049 Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Mon, 16 Oct 2023 16:23:18 +0200 Subject: [PATCH 9/9] Update src/platforms/apple/common/configuration/metric-kit.mdx Co-authored-by: Shana Matthews --- src/platforms/apple/common/configuration/metric-kit.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/apple/common/configuration/metric-kit.mdx b/src/platforms/apple/common/configuration/metric-kit.mdx index 31151993c68ee..a6c9875c46479 100644 --- a/src/platforms/apple/common/configuration/metric-kit.mdx +++ b/src/platforms/apple/common/configuration/metric-kit.mdx @@ -9,7 +9,7 @@ and [MXCPUExceptionDiagnostic](https://developer.apple.com/documentation/metrick This feature is available on Cocoa 8.14.0 and up. The SDK supports this feature from iOS 15 and up and macOS 12 and up because in these versions, MetricKit delivers diagnostic reports immediately, which allows the Sentry SDK to apply current data from the scope. -Note that the Cocoa SDK has no control over the stacktraces provided by MetricKit. Some only offer a couple of frames. If these aren't useful to you, you can drop them in `beforeSend`. +Note that the Cocoa SDK has no control over the stack traces provided by MetricKit. Some only offer a couple of frames. If these aren't useful to you, you can drop them in `beforeSend`. You can identify MetricKit events by looking at the `mx_hang_diagnostic`, `mx_cpu_exception`, and `mx_disk_write_exception` `mechanism.type`.