On this page

iOS SDK

Add the dependency, call start() once, and the signals below arrive on their own. There is no event taxonomy to design first and no tracking plan to keep up to date.

Published on Swift Package Manager · CocoaPods.

Before you start

Requirements for the iOS SDK
RuntimeiOS 13 or newer. The package also builds for macOS 11 and tvOS 13. Swift tools 5.7.
PermissionsNone, and no App Tracking Transparency prompt, because no advertising identifier is read.
Publishable keyConsole, under Settings. It is a publishable key, safe to ship in client code: it can only append events.

Install

swift
.package(url: "https://github.com/SharminSirajudeen/drengr-sdk.git", from: "0.3.0")

Start it

In AppDelegate.swift / your App struct. Your publishable key is safe to ship in client code: it can only write.

AppDelegate.swift / your App structswift
// Xcode → Add Package: https://github.com/SharminSirajudeen/drengr-sdk.git (from 0.3.0)
import Drengr

Drengr.start(
    publishableKey: "drengr_pk_YOUR_KEY",
    ingestURL: "https://ziryfxrwrvnunwjupgfg.supabase.co/functions/v1/ingest",
    appPackage: "com.example.app"
)

What arrives on its own

You do not instrument these. They are captured from the moment start() runs. The third column names the iOS API behind each one, so you can check the claim against your own app.

Signals the iOS SDK captures automatically, and the platform hook behind each
SignalWhat it recordsWhere it comes from
screen_viewEvery screen or route the user lands onA swizzle of UIViewController.viewDidAppear(_:)
tapTaps, with the element's own label when it has oneA swizzle of UIWindow.sendEvent(_:)
net / net_failOutgoing requests: host, path, status, duration, sizeA URLSession swizzle, so requests are captured without you changing call sites
crashUncaught exceptions with their stackNSSetUncaughtExceptionHandler, chaining any handler already installed
rage_tap / dead_tapRepeated taps that did nothing — the friction signalThe same UIWindow.sendEvent swizzle as tap
rage_scroll / dead_scrollScroll thrash and scrolls that moved nothingThe same UIWindow.sendEvent swizzle as tap
app_foreground / app_backgroundLifecycle, which is what sessions are built fromUIApplication lifecycle notifications
identifyYour own user id, when you choose to send oneYour own call to Drengr.identify()

Call start() once, as early as you can — anything before it is not captured.

CocoaPods works too: add pod 'Drengr' and run pod install.

URLSession traffic is captured through a protocol hook; no swizzling of your own code.

What never leaves the device

Emails, phone numbers, card numbers and government ids are detected and sealed on the device before the first byte is sent. Our servers hold ciphertext they cannot open. Labels and URLs are redacted and length-capped on the device too.

And what is never collected in the first place:

What the Drengr SDKs do not collect, and why that is structural
Not collectedHow you can tell
Screen recordings, screenshots or DOM snapshotsThere is no column for pixels or markup on the events table, and no SDK reads the framebuffer.
KeystrokesTap capture records that a tap happened and the element's own accessibility label. No SDK attaches a key or text listener.
Raw request and response bodiesWhat is stored is a safe dotted-path projection, redacted and capped at 64 KiB on the device before anything is sent.
Authorization headers, cookies and API keysMasked by name before capture, along with password, pin, cvv, ssn, otp and iban field names.
An IP address on the eventThe events table has no ip or geo column, so no stored event carries one.
Advertising or cross-app identifiersIdentity is a random install_id the SDK generates. No IDFA, no GAID, and no device fingerprint is used for identity.

Most autocapture tools promise not to look. This is built so we cannot. Full design in Security and Privacy.

Start paused behind a consent gate with Drengr.start(startEnabled: false), then resume once the user agrees. A persisted opt-out always wins over that argument, so an opted-out install stays paused across restarts.

Consent controls on the iOS SDK
Start pausedDrengr.start(startEnabled: false)
Opt outDrengr.optOut()
Opt back inDrengr.optIn()
Where the choice is storedUserDefaults, key dev.drengr.opt_out

Retention, deletion and what a GDPR or CCPA request maps to are on Privacy controls.

Check it worked

Run the app and use it for a few seconds, then open the console. Overview checks for your first event every 15 seconds on its own, so you do not need to keep reloading.

Nothing showing up

The first five happen on every platform. The rest are specific to iOS.

Failure modes on the iOS SDK, with the cause and the fix
What you seeWhyFix
No events at all, and Overview never leaves its empty stateThe key belongs to a different organisation, so the writes are accepted against a tenant you are not looking at.Copy the key again from Settings in the organisation you have open in the console.
Events exist but your app is missing from the pickerapp_package does not match the scope you are viewing.Use your real bundle or package id, the same string on every launch. A display name will create a second app.
Events appear only after you close the appNot a bug. The queue batches in memory and flushes on background, which is what makes a dropped connection free.Background the app once, or wait for the next flush. Nothing is lost in the meantime.
Screens are empty but taps and network arriveScreen capture is the one signal that can be wired separately from start().Check the screen hook for your platform in the table above.
Nothing arrives after a user opted outWorking as intended. A persisted opt-out outranks the start argument and survives restarts.Call the opt-in method for your platform. See Privacy controls.
The earliest screens of a cold launch are missingstart() ran after those view controllers had already appeared.Call start() as early as you can, in application(_:didFinishLaunchingWithOptions:) or your App init.
Network is missing from a custom URLSessionCapture attaches through a URLSession hook. A session built with a configuration that bypasses it will not be seen.Use the default configuration, or route the traffic through a session created after start().

Where to go next

Once events are arriving, these are the things worth doing, in order.

Not ready to install anything?

Drop a .har of traffic you already have and see the business events your current analytics is missing. It runs in your browser; nothing is uploaded.

Scan for blind spots →