Debugging Logs

How to enable and interpret debugging logs for TheCompanyApp.

Enable Logging

Core Data CloudKit Debugging

Xcode Scheme Arguments:

1. Product → Scheme → Edit Scheme...

2. Run → Arguments tab

3. Arguments Passed On Launch → Click "+"

4. Add each argument:

-com.apple.CoreData.CloudKitDebug 3
-com.apple.CoreData.Logging.oslog 1
-com.apple.CoreData.ConcurrencyDebug 1

Levels:

• 1 = Errors only

• 2 = Warnings + Errors

• 3 = Info + Warnings + Errors (verbose)

Result: CloudKit sync logs appear in Xcode console.

CloudKit Container Logging

Additional Argument:

-com.apple.CoreData.CloudKitContainerDebug 1

Logs: Container setup, account status, zone creation.

Network Logging

Environment Variable:

1. Edit Scheme → Run → Arguments tab

2. Environment Variables → Click "+"

3. Add:

   • Name: CFNETWORK_DIAGNOSTICS

   • Value: 3

Result: HTTP/HTTPS requests logged.

Reading Logs in Xcode

Run App from Xcode

1. Build and run (⌘R)

2. Perform action (e.g., save company, accept share)

3. View logs in Debug Console (bottom panel)

Filter Logs

Search Bar (bottom right of console):

• Filter by "CloudKit": CloudKit

• Filter by errors: error

• Filter by specific entity: Companies

Example Log:

2024-01-15 10:23:45.123 [CloudKit] Export started for store: TheCompanyApp.sqlite
2024-01-15 10:23:47.456 [CloudKit] Exported 5 records: Companies, InventoryItem
2024-01-15 10:23:48.789 [CloudKit] Export succeeded

Common Log Patterns

Successful Sync

Export (Upload):

CoreData: CloudKit: CoreData+CloudKit: -[NSCloudKitMirroringDelegate _performExportActivity:]: <NSCloudKitMirroringDelegate: 0x...> - Beginning export...
CoreData: CloudKit: CoreData+CloudKit: -[PFCloudKitExporter analyzeHistoryInStore:withManagedObjectContext:error:]: Analyzing 3 transactions for export.
CoreData: CloudKit: CoreData+CloudKit: Exported 3 records.
CoreData: CloudKit: Export succeeded with no errors.

Import (Download):

CoreData: CloudKit: CoreData+CloudKit: -[NSCloudKitMirroringDelegate _performImportActivity:]: <NSCloudKitMirroringDelegate: 0x...> - Beginning import...
CoreData: CloudKit: Fetched 2 record zones.
CoreData: CloudKit: Imported 5 records.
CoreData: CloudKit: Import succeeded.

Sync Errors

Network Unavailable:

CoreData: CloudKit: Export failed: Error Domain=CKErrorDomain Code=3 "Network unavailable"

Not Authenticated:

CoreData: CloudKit: Account status check failed: Error Domain=CKErrorDomain Code=9 "Not authenticated"

Quota Exceeded:

CoreData: CloudKit: Export failed: Error Domain=CKErrorDomain Code=27 "Quota exceeded"

Share-Related Logs

Share Creation:

CloudKit: Creating share for record: CD_Companies
CloudKit: Share created successfully: CKShare/<ShareID>

Share Acceptance:

CloudKit: Accepting share from URL: https://www.icloud.com/share/...
CloudKit: Share metadata fetched: Root record = CD_Companies
CloudKit: Share accepted successfully

Enlistment:

CoreData: CloudKit: Enlisting records in share zone: com.apple.coredata.cloudkit.share.<ShareID>
CoreData: CloudKit: Enlisted 10 records in share.

Console.app (macOS)

Use Case: View logs from physical device or Simulator.

Setup

1. Connect device to Mac (or run Simulator)

2. Open Console.app (Applications → Utilities)

3. Select device in sidebar

4. Start monitoring

Filter Console Logs

Search Field:

process:TheCompanyApp

Additional Filters:

subsystem:com.apple.coredata.cloudkit

Result: See all CloudKit-related logs for TheCompanyApp.

Export Logs

1. Console.app → Edit → Find → Filter Logs

2. Select filtered logs

3. File → Export...

4. Save as .txt or .log file

CloudKit Dashboard

Web Interface: https://icloud.developer.apple.com/dashboard

View Records

1. Select "TheCompanyApp" container

2. Choose Environment: Development or Production

3. Click Data → Records

4. Select zone (Private or Shared)

5. Browse records by type: CD_Companies, CD_InventoryItem, etc.

Useful for:

• Verify records uploaded

• Check field values

• Inspect CKShare records

Monitoring Logs

1. Dashboard → Logs

2. View real-time CloudKit operations

3. Filter by operation type: Save, Fetch, QueryRecords

Example:

[2024-01-15 10:30:12] SAVE_RECORDS: 5 records saved successfully
[2024-01-15 10:30:15] QUERY_RECORDS: 3 records fetched from zone

Telemetry

1. Dashboard → Telemetry

2. View:

   • Request count over time

   • Error rate

   • Database usage (MB)

Debugging Crashes

Enable Crash Reporting

TestFlight: Automatic (testers opt-in).

Xcode: Crashes logged in Xcode console immediately.

Symbolicate Crash Reports

Get Crash Report:

• Xcode → Window → Devices and Simulators

• Select device → View Device Logs

• Select crash report

Symbolication:

• Drag .crash file to Xcode window

• Xcode auto-symbolicates if dSYM available

• View stack trace with function names

Manual Symbolication:

export DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer
atos -arch arm64 -o TheCompanyApp.app.dSYM/Contents/Resources/DWARF/TheCompanyApp -l 0x100000000 0x10000abcd

Replace 0x100000000 (load address) and 0x10000abcd (crash address) from crash report.

Common Crash Patterns

CloudKit Timeout:

Exception Type: EXC_BAD_ACCESS (SIGSEGV)
Crashed Thread: 5 NSPersistentCloudKitContainer.ImportActivity

Fix: Increase timeout, check network.

Core Data Concurrency:

CoreData: error: Persistent store coordinator does not have a persistent store registered for this NSManagedObject

Fix: Ensure context.perform { } used for background operations.

Interpreting Sync Issues

Symptom: Data Not Syncing

Check Logs For:

1. Export started → Export successful?

2. If failed → Error code (CKErrorDomain)

3. Network, authentication, quota errors?

Example Diagnosis:

CoreData: CloudKit: Export failed: Error Domain=CKErrorDomain Code=9

→ Code 9 = Not authenticated → User not signed in to iCloud.

Symptom: Share Not Working

Check Logs For:

1. Creating share for record → Share created?

2. Share metadata fetched → Metadata valid?

3. Share accepted → Acceptance succeeded?

4. Enlisting records → All related data enlisted?

Example Diagnosis:

CloudKit: Share created successfully
CoreData: CloudKit: Enlisted 0 records in share

→ Enlistment failed → Check if related data has correct companyID.

Logging in Production

Disable Debug Logs: Remove Xcode scheme arguments for Release builds.

Implement Custom Logging:

import os.log

let logger = Logger(subsystem: "com.3nsofts.TheCompanyApp", category: "CloudKit")

func logSync(action: String, result: String) {
    logger.info("Sync \(action): \(result)")
}

Usage:

logSync(action: "Export", result: "Success - 5 records")

View in Console.app:

subsystem:com.3nsofts.TheCompanyApp

Performance Profiling

Instruments (Xcode):

1. Product → Profile (⌘I)

2. Select template: Core Data

3. Record while performing actions

4. Analyze:

   • Fetch times

   • Save times

   • Faulting behavior

Identify Slow Queries: Look for fetches > 100ms.

Optimize: Add indexes, reduce fetch batch size, use predicates.

---

Related: Troubleshooting, Share Testing Checklist, Common Issues