Skip to main content

iOS/tvOS Platform Documentation

Getting Started​

The Embrace Apple SDK is designed to provide first class observability and diagnostic data collection to your mobile application. It supports multiple platforms including iOS, iPadOS, and tvOS.

Recommended Major Version - Apple 6.x​

Our Apple 6.x SDK is recommended for all current and new customers. The 6.x SDK is our open-source superset of OpenTelemetry instrumentation, built in Swift for modern language (such as async/await) and mobile observability (spans, logs) features. It has all the latest Embrace features and semantics, and will continue to grow as Embrace helps expand the OTel ecosystem for mobile.

We recommend that customers use our version 6 SDK, as it contains OTel primitives, open-source support, and better use of modern Swift features like async/await. If you are upgrading from our older 5x SDK, a migration guide is available to implement the new features and interface in the 6.x SDK.

This documentation reflects information on the 6.x SDK. Current documentation for the 6.x SDK is split into three sections:

  1. Integration Guide for open-source SDK developers.
  2. Getting Started for users adding Embrace to your project.
  3. Feature Reference for more details about Embrace features.

5.x SDK Documentation​

Embrace iOS 5.x is the closed-source SDK that has been generally available since the year 2020. It is not available for open-source developers, and is not recommended for new users.

Versions 5.x and 6.x are not compatible nor are they interoperable. The 6.x SDK is built on OpenTelemetry, and the features and signals that it provides have different semantics and syntax than previous versions. 6.x is also a rewrite of the SDK in the Swift programming language, so it does not include features that Embrace does not intend to support in the future, like Moments.

This documentation reflects information on the 5.x SDK. It is split into two sections:

  1. Integration Guide
  2. Feature Reference

Any questions​

If you would like clarification on which SDK to use, please reach out to us on the community slack or email us at support@embrace.com.

You can also view our FAQ and Changelog