Features
Learn about Sentry's Apple SDK features for macOS.
Sentry's Apple SDK for macOS enables automatic reporting of errors and exceptions, and identifies performance issues in your application. The minimum supported macOS version is 10.10. All features listed below are enabled by default unless otherwise noted.
For macOS, a simple manual setup is required for the SDK to report uncaught exceptions.
The SDK builds a crash report that persists to disk. While it attempts to send the report right after the crash, it may not always work because the environment may be unstable at the time of the crash. If this is the case, the report will be sent upon application start.
For a complete list of all available features, see the main Features page. This page highlights macOS-specific features and capabilities.
MetricKit integration integrates with Apple's MetricKit framework for system-level performance metrics.
- Available on macOS 12+
- Enabled by default (requires
enableMetricKitoption)
Profiling provides code-level performance profiling with multiple modes (requires configuration):
- Transaction-based profiling (deprecated)
- Continuous profiling
- UI Profiling (recommended)
- Launch profiling
- Multiple types of errors are captured, including:
- Mach exceptions
- Fatal signals
- Unhandled exceptions
- C++ exceptions
- Objective-C exceptions
- Error messages of
fatalError,assert, andprecondition - Start-up crashes. The SDK init waits synchronously for up to 5 seconds to flush out events if the app crashes within 2 seconds after the SDK init.
- App hang detection
- HTTP client errors automatically captured
macOS supports comprehensive performance monitoring:
- Network request monitoring for HTTP request performance
- File I/O performance tracking for file operations
- Core Data performance tracking for Core Data query performance
- Distributed tracing across services
For macOS apps using UIKit (Mac Catalyst), the following features are also available:
- App start tracking for cold and warm app start times
- Frame rate tracking for UI rendering performance
- User interaction tracking that automatically creates transactions for UI interactions
- Automatic performance transactions for UIViewController rendering
- Release health tracks crash-free users and sessions
- Session tracking automatically tracks user sessions for release health metrics
- Events enriched with device data, environment information, and app state
- Breadcrumbs are automatically captured for:
- Application lifecycle events (
didBecomeActive,didEnterBackground) - System events (memory warnings, keyboard did show and did hide, screenshot taken)
- Outgoing HTTP requests
- Application lifecycle events (
- Attachments enrich your event by storing additional files, such as config or log files
- Source Context shows snippets of code around the location of stack frames
- User Feedback provides the ability to collect user information when an event occurs (programmatic API only, no UI on macOS)
- Swift Async/Await support for automatically stitching together stack traces of Swift concurrency code
- Logs capturing available (requires
enableLogsoption) - Offline caching when a device is unable to connect; we send a report once we receive another event
For information about experimental features available on macOS, see the Experimental Features page.
macOS has some limitations compared to iOS:
- Session Replay not available
- User Feedback UI not available (programmatic API only)
- Screenshot capture not available (except Mac Catalyst)
- View Hierarchy capture not available (except Mac Catalyst)
- Watchdog terminations not available
For configuration options and detailed documentation, see the Configuration section.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").