Skip to content

docs(apple): Document MetricKit diagnostic and metric options - #20365

Draft
itaybre wants to merge 1 commit into
masterfrom
itaybre/docs/apple-metrickit-options
Draft

itaybre wants to merge 1 commit into
masterfrom
itaybre/docs/apple-metrickit-options

Conversation

@itaybre

@itaybre itaybre commented Oct 30, 2026

Copy link
Copy Markdown
Contributor

Document the MetricKit options shipped in Cocoa 9.31.0 and 9.32.0. The MetricKit page only described enableMetricKit and three diagnostics, and the options page didn't list the experimental MetricKit options.

MetricKit page

The page now covers diagnostic reports and metric reports separately. It documents options.experimental.metrickit.enabledDiagnosticReports with the available reports, their mechanism.type and platforms, how the option interacts with enableMetricKit, and the warning that .crash reports crashes in addition to the SDK's crash handler. It adds hangReportingMode, and enabledMetricReports with every metric name, type and unit, its attributes and the Swift-only limitation. A new section explains that MetricKit data arrives after it was recorded and that events from earlier runs carry the app and OS versions of that time without the current scope.

Options page and feature lists

The options page lists the three experimental MetricKit options and drops the outdated note that MetricKit lets the SDK apply the current scope. The visionOS feature list no longer says MetricKit is unavailable, and the macOS list no longer says it's enabled by default.

Features that are still in review, such as the xOS 27 MetricManager reports, memory exception diagnostics and histograms, will be documented once they ship.

Fixes COCOA-2037
Fixes getsentry/sentry-cocoa#9279

Cover enabledDiagnosticReports, enabledMetricReports and
hangReportingMode, list the metric reports with their names, types
and units, and explain how delayed MetricKit data is reported.
Fix the visionOS and macOS feature lists.

Fixes COCOA-2037
@vercel

vercel Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 30, 2026 8:27pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 30, 2026 8:27pm UTC

Request Review

@linear-code

linear-code Bot commented Oct 30, 2026

Copy link
Copy Markdown

COCOA-2037

@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 30, 2026 20:19
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 30, 2026
@codeowner-assignment
codeowner-assignment Bot requested review from NinjaLikesCheez and philprime and removed request for a team October 30, 2026 20:19

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 1a05e557 Deployed Oct 30, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Needs Triage The PR description is missing valid priority information

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the MetricKit diagnostic and metric options

1 participant