Question 1

How do I filter out sensitive user data in Diagnostics reports?

Accepted Answer

Implement the DiagnosticsReportFilter protocol to create custom filters. For example, you can exclude specific UserDefaults keys or app metadata by checking key-value pairs in the diagnostics dictionary, as shown in the README's example.

Question 2

Can I use Diagnostics on macOS?

Accepted Answer

Yes, Diagnostics natively supports macOS via NSSharingService for report sharing. The API is consistent with iOS, allowing cross-platform diagnostic reporting with minimal code changes, as demonstrated in the usage section.

Question 3

How to add custom error logs to Diagnostics?

Accepted Answer

Use DiagnosticsLogger.log(error:) for errors or log(message:) for strings. Ensure errors conform to LocalizedError for better descriptions in reports, and set up the logger early in the app lifecycle to capture all logs.

Question 4

Diagnostics vs Crashlytics: which is better for iOS?

Accepted Answer

Diagnostics is best for in-app, user-initiated report sharing with privacy controls and HTML formatting, while Crashlytics excels at automatic crash reporting and cloud analytics. Use Diagnostics for support workflows; Crashlytics for development monitoring.

Question 5

What smart insights come with Diagnostics?

Accepted Answer

Default insights include UpdateAvailableInsight for checking app version updates and DeviceStorageInsight for storage warnings. You can extend these by implementing SmartInsightsProviding to parse logs and add custom insights based on your app's data.

Question 6

How to install Diagnostics with Swift Package Manager?

Accepted Answer

Add the package URL in Xcode's Swift Packages or in Package.swift, specifying dependencies and targets. The library integrates seamlessly with SPM, as outlined in the installation section, making dependency management straightforward.

Diagnostics

What is Diagnostics?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions