https://github.com/getsentry/sentry-cocoa

The official Sentry SDK for iOS, tvOS, macOS, watchOS.
https://github.com/getsentry/sentry-cocoa

cocoa crash crash-reporting crash-reports error-handler error-monitoring hacktoberfest ios macos objective-c sdk sentry swift tag-production team-mobile tvos watchos

Last synced: 2 months ago
JSON representation

The official Sentry SDK for iOS, tvOS, macOS, watchOS.

• Host: GitHub
• URL: https://github.com/getsentry/sentry-cocoa
• Owner: getsentry
• License: mit
• Created: 2016-04-05T18:55:09.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2025-04-08T09:47:25.000Z (9 months ago)
• Last Synced: 2025-04-08T10:08:25.702Z (9 months ago)
• Topics: cocoa, crash, crash-reporting, crash-reports, error-handler, error-monitoring, hacktoberfest, ios, macos, objective-c, sdk, sentry, swift, tag-production, team-mobile, tvos, watchos
• Language: Swift
• Homepage: https://sentry.io/for/cocoa/
• Size: 21.6 MB
• Stars: 866
• Watchers: 65
• Forks: 341
• Open Issues: 322
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          


    

        

    



_Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us [**Check out our open positions**](https://sentry.io/careers/)_

> [!NOTE]

> You are currently viewing the **`main`** branch which contains the upcoming **v9** release with breaking changes.

>

> For the stable **v8** release, please switch to the [`v8.x` branch](https://github.com/getsentry/sentry-cocoa/tree/v8.x) and refer to the [v8 CHANGELOG](https://github.com/getsentry/sentry-cocoa/blob/v8.x/CHANGELOG.md).

# Official Sentry SDK for iOS / tvOS / macOS / watchOS (1)

[![Build](https://img.shields.io/github/actions/workflow/status/getsentry/sentry-cocoa/build.yml?branch=main)](https://github.com/getsentry/sentry-cocoa/actions/workflows/build.yml?query=branch%3Amain)

[![codecov.io](https://codecov.io/gh/getsentry/sentry-cocoa/branch/master/graph/badge.svg)](https://codecov.io/gh/getsentry/sentry-cocoa)

[![CocoaPods compatible](https://img.shields.io/cocoapods/v/Sentry.svg)](https://cocoapods.org/pods/Sentry)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![SwiftPM compatible](https://img.shields.io/badge/spm-compatible-brightgreen.svg?style=flat)](https://swift.org/package-manager)

![platforms](https://img.shields.io/cocoapods/p/Sentry.svg?style=flat)

[![Swift Package Index](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fgetsentry%2Fsentry-cocoa%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/getsentry/sentry-cocoa)

[![X Follow](https://img.shields.io/twitter/follow/sentry?label=sentry&style=social)](https://x.com/intent/follow?screen_name=sentry)

[![Discord Chat](https://img.shields.io/discord/621778831602221064?logo=discord&logoColor=ffffff&color=7389D8)](https://discord.com/invite/sentry)

# Installation

SPM is the recommended way to include Sentry into your project, but we also support [CocoaPods](https://cocoapods.org/pods/Sentry) and Carthage, and provide pre-built XCFrameworks on [our GitHub Releases page](https://github.com/getsentry/sentry-cocoa/releases).

# Initialization

_Remember to call this as early in your application life cycle as possible_

Ideally in `applicationDidFinishLaunching` in `AppDelegate`

```swift

import Sentry

// ....

SentrySDK.start { options in

    options.dsn = "___PUBLIC_DSN___"

    options.debug = true // Helpful to see what's going on

}

```

```objc

@import Sentry;

// ....

[SentrySDK startWithConfigureOptions:^(SentryOptions *options) {

    options.dsn = @"___PUBLIC_DSN___";

    options.debug = @YES; // Helpful to see what's going on

}];

```

For more information checkout the [docs](https://docs.sentry.io/platforms/apple).

(1)limited symbolication support and no crash handling.

# Blog posts

[Mobile Vitals - Four Metrics Every Mobile Developer Should Care About](https://blog.sentry.io/2021/08/23/mobile-vitals-four-metrics-every-mobile-developer-should-care-about/).

[How to use Sentry Attachments with Mobile Applications](https://blog.sentry.io/2021/02/03/how-to-use-sentry-attachments-with-mobile-applications/?utm_source=github&utm_medium=readme&utm_campaign=sentry-cocoa).

[Close the Loop with User Feedback](https://blog.sentry.io/2021/02/16/close-the-loop-with-user-feedback/?utm_source=github&utm_medium=readme&utm_campaign=sentry-cocoa).

[A Sanity Listicle for Mobile Developers](https://blog.sentry.io/2021/03/30/a-sanity-listicle-for-mobile-developers/?utm_source=github&utm_medium=readme&utm_campaign=sentry-cocoa).

# Resources

- [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/apple/)

- [![Discussions](https://img.shields.io/github/discussions/getsentry/sentry-cocoa.svg)](https://github.com/getsentry/sentry-cocoa/discussions)

- [![Discord Chat](https://img.shields.io/discord/621778831602221064?logo=discord&logoColor=ffffff&color=7389D8)](https://discord.com/invite/sentry)

- [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry)

- [![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-sentry-green.svg)](https://github.com/getsentry/.github/blob/master/CODE_OF_CONDUCT.md)

- [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)