close
Skip to content

Document Crashlytics hang reporting and OTel event reporting in README#46

Merged
pilot34 merged 3 commits into
mainfrom
gtarasov/readme-crashlytics-otel
Jun 25, 2026
Merged

Document Crashlytics hang reporting and OTel event reporting in README#46
pilot34 merged 3 commits into
mainfrom
gtarasov/readme-crashlytics-otel

Conversation

@pilot34

@pilot34 pilot34 commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

What

Documents the two built-in reporting integrations in the main README:

  • Crashlytics — reports fatal and non-fatal hangs (with stack traces) to Firebase Crashlytics so they show up as issues next to crashes.
  • OpenTelemetry — reports all events to any OTel-compatible backend (already had a detailed section; now surfaced in the feature list and cross-linked).

Changes

  • New Crashlytics Integration section: installation (SPM PerformanceSuiteCrashlytics / CocoaPods pod 'PerformanceSuite/Crashlytics'), usage via enableWithCrashlyticsSupport(...), the fatal/non-fatal hang reporting lifecycle, CrashlyticsHangsSettings customization (.fatalHangsAsCrashes vs .fatalHangsAsNonFatals, hangReason, hangTypeFormatter), and the crashlyticsEnabledInDebug escape hatch.
  • New "Built-in reporting integrations" subsection in the feature list, with cross-links to both integration sections.
  • Refined the existing crashes note to clarify hangs can be reported to Crashlytics out of the box.

Docs-only change, grounded in PerformanceSuite/Crashlytics sources, Package.swift, and the podspec.

🤖 Generated with Claude Code

Gleb Tarasov and others added 3 commits June 25, 2026 18:14
Add a "Crashlytics Integration" section covering enableWithCrashlyticsSupport,
CrashlyticsHangsSettings (reporting modes, hang reason, type formatter), the
fatal/non-fatal hang reporting lifecycle, and the crashlyticsEnabledInDebug
escape hatch. Surface both built-in reporting integrations (Crashlytics for
hangs, OpenTelemetry for all events) in the feature list with cross-links.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Fatal hangs in .fatalHangsAsCrashes mode capture all threads, not just the
main thread. Remove the redundant hangs-only blockquote.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the full in-README Crashlytics and OpenTelemetry sections with short
blurbs that link to dedicated wiki pages, matching the project's existing
convention of keeping detailed docs in the Wiki.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@pilot34
pilot34 merged commit 82265b3 into main Jun 25, 2026
3 checks passed
@github-actions

Copy link
Copy Markdown

Code Coverage

Package Line Rate Branch Rate Health
PerformanceSuite.Crashlytics.Sources 94% 87%
PerformanceSuite.MainThreadCallStack 75% 86%
PerformanceSuite.OTel.Sources 99% 88%
PerformanceSuite.Sources.InstanceObservers 94% 93%
PerformanceSuite.Sources.Model 94% 81%
PerformanceSuite.Sources.Observers 86% 84%
PerformanceSuite.Sources.Public 92% 91%
PerformanceSuite.Sources.Reporters 88% 86%
PerformanceSuite.Sources.Swizzling 95% 90%
PerformanceSuite.Sources.Utils 94% 93%
Summary 93% (3845 / 4149) 89% (2051 / 2296)

Minimum allowed line rate is 75%

pilot34 added a commit that referenced this pull request Jun 25, 2026
Follow-up to #46 (those commits landed after the squash-merge):
- WatchDogTerminationsReceiver -> WatchdogTerminationsReceiver
- Add link target for "Screen identifiers" (#screen-identifiers)
- TTI sample: in-scope `screen` + `.milliseconds` (was undefined
  `performanceScreen` and sub-second-truncating `.seconds`)
- Bump example CocoaPods tag to current release (1.10.1)
- Drop the long descriptions after the Crashlytics/OTel wiki links

Co-authored-by: Gleb Tarasov <gleb.tarasov@booking.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant