Open Source Integration
The Embrace Apple SDK is built on OpenTelemetry and captures vital signals from mobile apps. It is available for open source developers to use, modify, and configure according the Apache-2.0 license. Adding the Embrace Apple SDK allows you to capture and export OTel spans and logs with Embrace's automatic and manual instrumentation.
This section shows you how to set up Embrace in your app, without signing up for the Embrace commercial product. Commercial customers adding the Embrace Apple SDK for the first time should also use this section before proceeding.
Decisions You Need To Make
Before you dive into integrating Embrace there are a few decisions you should make to help guide your process:
- Are you integrating a new App or an existing application?
- Are you replacing an existing automated debugging SDK?
- Do you plan to use multiple automated debugging SDKs?
- What integration path makes sense for you? CocoaPods, SPM, or your own manual integration of the framework?
Integration Steps
We recommend following these steps in order.
- First, link the Embrace SDK to your Xcode project.
- Then, initialize the Embrace Client as close to launch of your application code as possible.
- For configuration options in the SDK, read about the
Embrace.Options
object that is used to initialize it. Also consider which signals you would like to autoinstrument with the Embrace SDK.