How to capture SDK/app diagnostic logs and export them as a shareable bundle, so Scope support receives complete logs. Companion to iOS SmartDrive framework. Last updated: 20 Jul, 2026.

When you raise a support issue, Scope needs the app's diagnostic logs. This page shows the reference logging pipeline used by the demo app: capture events into a local store, roll them up into a per-day ZIP with an identifying header, and share that ZIP by email or the share sheet.

• 1. Overview
• 2. The log store
  • 2.1. Set up the Core Data store
  • 2.2. LogEventManager
  • 2.3. Global log functions
• 3. What to log and where
• 4. Building the report
• 5. Sharing the report
• 6. Sending logs to Scope support
• 7. Troubleshooting

The pipeline has four stages:

capture            store                 build                  share
──────             ─────                 ─────                  ─────
logEvent(...)  ──► LogEventManager  ──►  ReportManager      ──►  ReportComposer
health checks      (Core Data,           (per-day .txt in a      (email / share sheet)
SDK callbacks       7-day retention)      ZIP + header)
server errors

Everything funnels through one global logEvent(...) call into a Core Data store. On export, the store is grouped by day into text files, zipped with a header that identifies the user/vehicle/device, and handed to the share sheet.

The store is a small Core Data model with a single entity. Set it up once, in this order.

Step 1 — Add the data model. File ▸ New ▸ File ▸ Data Model. The filename you choose is the model name, and you must pass the same name to NSPersistentContainer(name:) later. Note it down.

Step 2 — Add the LogEvent entity with exactly these attributes:

Step 3 — Set Codegen to Manual/None. Select the entity, open the Data Model Inspector, and set Codegen = Manual/None. This is required because you provide the NSManagedObject subclass by hand (Step 4). Leaving it on the default "Class Definition" makes Xcode generate a second LogEvent, which fails to build with "invalid redeclaration of 'LogEvent'".

Step 4 — Add the subclass files (from the demo):

class LogEvent: NSManagedObject {}

extension LogEvent {
    @nonobjc public class func fetchRequest() -> NSFetchRequest<LogEvent> {
        return NSFetchRequest<LogEvent>(entityName: "LogEvent")
    }
    @NSManaged public var date: NSDate?
    @NSManaged public var type: NSNumber?
    @NSManaged public var group: NSNumber?
    @NSManaged public var text: String?
}

Step 5 — Point the container at your model. In LogEventManager, NSPersistentContainer(name:) takes the model filename from Step 1 — not a fixed string:

NSPersistentContainer(name: "Ayalon_iOS")   // must equal your .xcdatamodeld filename

A singleton that owns the Core Data stack and writes on a background context. Key responsibilities: write a log, keep 7 days of history, save on background/terminate, capture crashes, and observe SDK server errors.

class LogEventManager: NSObject {
    static let shared = LogEventManager()
    private let entityName = "LogEvent"
    static let daysLimit = 7

    private lazy var persistentContainer: NSPersistentContainer = {
        let container = NSPersistentContainer(name: "YourModelName")
        container.loadPersistentStores { _, error in
            if let error = error { fatalError("Core Data: \(error)") }
        }
        return container
    }()
    private lazy var privateManagedObjectContext = persistentContainer.newBackgroundContext()

    private override init() {
        super.init()
        // Trim old logs when the app becomes active
        NotificationCenter.default.addObserver(self, selector: #selector(appDidBecomeActive),
                                               name: UIApplication.didBecomeActiveNotification, object: nil)
        // Capture SDK server errors automatically
        NotificationCenter.default.addObserver(self, selector: #selector(logServerError(_:)),
                                               name: Notification.Name(SDApiManager.serverErrorNotificationName()), object: nil)
    }

    @objc private func appDidBecomeActive() { deleteExpiredLogs() }

    fileprivate func saveLog(_ type: LogType, group: LogGroup, groupInfo: String?, description: String) {
        privateManagedObjectContext.perform {
            let log = NSEntityDescription.insertNewObject(forEntityName: self.entityName,
                                                          into: self.privateManagedObjectContext) as! LogEvent
            log.date = NSDate()
            log.type = NSNumber(value: type.rawValue)
            log.group = NSNumber(value: group.rawValue)
            log.text = description
            try? self.privateManagedObjectContext.save()
        }
    }

    func saveContext() {
        let context = persistentContainer.viewContext
        if context.hasChanges { try? context.save() }
    }

    // exportLogs(from:completion:), deleteExpiredLogs(), saveCrash(), logServerError()
    // — copy verbatim from the demo's LogEventManager.swift
}

The server-error observer is important: it automatically logs every failed API response (URL, request body, HTTP status, error reason) without you adding a call at each site:

@objc private func logServerError(_ notification: NSNotification) {
    guard let response = notification.userInfo?[SDApiManager.responseKeyNotificationName()] as? CCAPIResponse else { return }
    logEvent(.API, description: "Server error occured - [user: \(SDApiManager.userId()), url: \(response.requestUrl ?? ""), code: \(response.httpStatusCode), reason: \(response.errorReason ?? "")]")
}

Expose two free functions so logging is a one-liner anywhere in the app:

func logEvent(_ group: LogGroup, groupInfo: String? = nil, description: String) {
    LogEventManager.shared.saveLog(.Trace, group: group, groupInfo: groupInfo, description: description)
}

func logCrash(description: String) {
    LogEventManager.shared.saveCrash(description: description)
}

LogGroup is provided by SCPSmartDrive (cases like .TripStart, .SLC, .API, .AppBackground). Use LogEventManager.logGroupTitle(_:) from the demo to render readable names if you display logs in-app.

Wire logEvent (and the health check) at the points the demo does — these are what make a log useful for diagnosing session and trip issues:

• App lifecycle (AppDelegate): initializeFeatures, onDidBecomeActive, onDidEnterBackground, onTerminate.
• Health snapshots: SmartDriveHelper.logHealthCheck(trigger:) at launch, background, trip start, and trip end. This one snapshot captures authorization, permissions, recorder state, and trip counts — the single most useful entry for support.
• Trip callbacks (TripWrapper delegate): tripStarted, tripEnded.
• Server errors: handled automatically by the observer in §2.2.

ReportManager reads the store and produces a ZIP: one dd-MMM-yyyy.txt per day (last 7 days), each line HH:mm:ss - message, prefixed by an identifying header.

Dependency: ZIPFoundation. The report builder is the only part of this pipeline that needs it. The demo pulls it in via CocoaPods — its entire Podfile is:

platform :ios, '15.0'
workspace 'SmartDriveDemo.xcworkspace'

target 'SmartDriveDemo' do
  use_frameworks!

  pod 'ZIPFoundation'
end

Then pod install, and open the generated .xcworkspace (not the .xcodeproj). Set platform to match your app's deployment target. If you already consume the SDK via Swift Package Manager, you can instead add ZIPFoundation as an SPM dependency and skip CocoaPods entirely — either works. General CocoaPods/SPM coexistence is covered on the Consolidated SPM page §6.

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '15.0'
      config.build_settings['ENABLE_USER_SCRIPT_SANDBOXING'] = 'NO'
    end
  end
end

The header is what lets support match logs to an account and device:

<App> vX.Y(build), <bundleId>
USER ID: <SDApiManager.userId()>
USERNAME: <SDApiManager.username()>
PVU: <SDApiManager.pvu()>
VEHICLE UNIT SERIAL NUMBER: <SDApiManager.unitSerialNumber()>
VEHICLE NAME: <SDApiManager.vehicleName()>
BASE URL: <SDApiManager.baseUrl()>
SYSTEM: <iOS version>
DEVICE: <model identifier>
APP TYPE: <SMART | BEACON>
LOG CREATED - <timestamp>

Copy ReportManager.swift from the demo as-is. It depends on AppDelegate.documentDirectory (where the ZIP is written) and AppDelegate.shared.appType; provide those, or replace with your own document-directory URL and app-type string.

ReportManager.shared.createLogData { data in
    // `data` is the zipped bundle; ReportManager.shared.dataURL is the file on disk
}

ReportComposer presents an action sheet with Email (MFMailComposeViewController, attaches the ZIP) and More (UIActivityViewController share sheet). Trigger it from any screen — the demo uses an Export logs button:

@IBAction func exportLogs(_ sender: UIButton) {
    ReportComposer.shared.showDialog(at: self)
}

Copy ReportComposer.swift from the demo. Email requires a device with Mail configured (MFMailComposeViewController.canSendMail()); the share sheet works regardless (AirDrop, Files, messaging apps).

Ask the user to reproduce the issue, then tap Export logs and send the ZIP. Before sending, open the first .txt and confirm the header fields are populated — an empty USER ID / BASE URL means the log was captured while logged out (see §7).

• Demo files: LogEventManager.swift, LogEventManager extensions, ReportManager.swift, ReportComposer.swift, LogEvent+CoreData*.
• Flutter Diagnostic Logs & Export — the Flutter equivalent.