Instrument your iOS application with the Honeycomb OpenTelemetry Swift SDK, send telemetry to Honeycomb, and measure real device performance in production.
Use the Honeycomb OpenTelemetry Swift SDK to collect telemetry data from your iOS application and send it to Honeycomb.
Instrumenting your application lets you measure how it behaves on actual devices, detect performance issues, and better understand how users experience your application.This guide walks you through the process of instrumenting an application in your local development environment and verifying that telemetry is successfully flowing to Honeycomb.
Before You Begin
Before getting started, make sure you have:
A Honeycomb account
If you don’t already have an account, sign up for one.
Honeycomb stores your data in either a US-based or EU-based location, depending on your account region:
A Honeycomb Ingest API Key
For this guide, you’ll need a Honeycomb Ingest API Key with the Can create services/datasets permission.
This key lets your application send telemetry to Honeycomb and create a dataset for your service.
When deploying to production, replace this key with a separate key that does not allow dataset creation.
This helps protect your data structure in live environments.
Add Dependencies
To send telemetry from your application, add the Honeycomb OpenTelemetry Swift SDK to your project.
The Honeycomb OpenTelemetry Swift SDK is compatible with applications targeting iOS 13+.
Using Xcode
If you manage dependencies using Xcode:
In Xcode, navigate to File > Add Package Dependencies…
When prompted for a repository URL, enter https://github.com/honeycombio/honeycomb-opentelemetry-swift.
To start collecting telemetry, configure the SDK early in your application’s lifecycle.
This ensures that events such as startup time and early view loads are captured.
We recommend setting it up in the init() method of your App class, or something equivalent.Here’s an example configuration using the HoneycombOptions.Builder(), which lets us use the builder pattern to set configuration options:
import Honeycombimport SwiftUI@mainstruct ExampleApp: App { init() { do { let options = try HoneycombOptions.Builder() // Uncomment the line below to send to EU instance. Defaults to US. // .setAPIEndpoint("https://api.eu1.honeycomb.io:443") .setAPIKey("YOUR-API-KEY") .setServiceName("YOUR-SERVICE-NAME") .setServiceVersion("0.0.1") .setDebug(true) .build() try Honeycomb.configure(options: options) } catch { NSException(name: NSExceptionName("HoneycombOptionsError"), reason: "\(error)").raise() } }}
In this example, key configuration options include:APIEndpoint
: URL where your telemetry is sent.
: Defaults to https://api.honeycomb.io:443 (the Honeycomb US instance URL).
: For EU instances, set this to https://api.eu1.honeycomb.io:443.
: If you’re using an OpenTelemetry Collector, use your collector’s URL instead.APIKey
: Your Ingest API Key, which authorizes your application to send telemetry directly to Honeycomb.serviceName
: The name of your application, which Honeycomb will use as your dataset name.
Choose something meaningful and consistent.
If you don’t provide a service name, the dataset name will be inferred from your bundle.
serviceVersion
: The current version of your application.
This helps track changes in behavior across different versions of your application.debug
: Set to true to enable debug logs, which can help troubleshoot configuration issues during development.
Enable Automatic Instrumentation
The Honeycomb OpenTelemetry Swift SDK includes built-in support for capturing common system and runtime events.
These can provide useful context without requiring additional code.
These include:
MetricKit
: Captures system-level performance data, such as CPU and memory usage.
It’s a great place to start exploring how your application behaves in real-world conditions.
Explore using Boards
You can also explore your data by creating a Board from a pre-configured Board template.
Our specialized template for mobile iOS data includes a curated set of ready-made queries and visualizations based on the fields collected by the Honeycomb OpenTelemetry Swift SDK.This template gives you an immediate, actionable view into common mobile metrics, like application start times, cold launches, crashes, and session flows, without needing to build anything from scratch.
You can use it as-is or customize it to fit your needs.To learn more, visit Use Board Templates.
Troubleshooting
Running into issues? Here are some common problems and ways to fix them.
The Honeycomb OpenTelemetry Swift SDK uses the value passed to .setApiKey() to send your telemetry data.
This must be set correctly for data to reach Honeycomb.
My dataset name looks wrong
Check the value passed to .setServiceName().
This value determines the name of your dataset in Honeycomb.
If you leave it blank, the default will be inferred from your bundle, which might not be descriptive or consistent across builds.