Application Real-Time Monitoring Service:iOS SDK configuration reference

Set the endpoint

Associate the SDK with a data endpoint. Call this method before start.

@objc
public static func setEndpoint(_ endpoint: String)

Set the workspace

Associate the SDK with a workspace. Call this method before start.

@objc
public static func setWorkspace(_ workspace: String)

Initialize the SDK

Start the SDK after you configure the endpoint and workspace.

@objc(start:)
public static func start(_ serviceId: String)

Set a custom device ID

Override the default device ID. After you set this value, the SDK reports it instead of the auto-generated ID.

@objc
public static func setDeviceID(_ deviceID: String)

Set a custom app version

Report a custom app version instead of the version that the SDK detects automatically.

@objc
public static func setAppVersion(_ appVersion: String)

Set the channel ID

Tag the distribution channel for the app, such as app-store or an enterprise distribution identifier.

@objc
public static func setChannelID(_ channelID: String)

Set the environment

Specify the runtime environment. Call this method after setConfigAddress and before start.

@objc
public static func setEnvironment(_ env: Env)

Env values

Set the username

Associate monitoring data with a user identity for per-user filtering and analysis.

@objc
public static func setUserName(_ userID: String)

Set user metadata

Attach key-value metadata to the current user. This data accompanies the username in analytics.

@objc(setUserExtraInfo:)
public static func setUserExtraInfo(_ extraInfo: [String: AnyObject])

Set global properties

Attach custom properties to all subsequent data that the SDK reports. Use these properties to segment analytics by business dimensions such as region, experiment group, or feature flag.

The SDK provides two methods:

// Replace all global properties
@objc(setExtraInfo:)
public static func setExtraInfo(_ extraInfo: [String: AnyObject])

// Append to existing global properties
@objc(addExtraInfo:)
public static func addExtraInfo(_ extraInfo: [String: AnyObject])

Report a custom exception

Report an application exception with its type, cause, and stack trace.

@objc(setCustomException:causeBy:errorDump:)
public static func setCustomException(_ exceptionType: String, _ causeBy: String, _ errorDump: String)

Report a custom event

Report a custom event with optional grouping, snapshots, numeric values, and metadata. The SDK provides multiple overloads that share the same base parameters. Choose the overload that matches the data you need to attach.

Full method signature (all optional parameters included):

@objc(setCustomEvent:group:snapshots:value:info:)
public static func setCustomEvent(
    _ name: String,
    group: String? = nil,
    snapshots: String? = nil,
    value: Double = 0,
    info: [String: String]? = nil
)

Parameters

Available overloads

Pass only the parameters you need:

// Event name only
@objc(setCustomEvent:)
setCustomEvent(_ name: String)

// With group
@objc(setCustomEvent:group:)
setCustomEvent(_ name: String, group: String?)

// With group and snapshots
@objc(setCustomEvent:group:snapshots:)
setCustomEvent(_ name: String, group: String?, snapshots: String?)

// With group and numeric value
@objc(setCustomEvent:group:value:)
setCustomEvent(_ name: String, group: String?, value: Double)

// With group and metadata
@objc(setCustomEvent:group:info:)
setCustomEvent(_ name: String, group: String?, info: [String: String]?)

// With group, snapshots, and numeric value
@objc(setCustomEvent:group:snapshots:value:)
setCustomEvent(_ name: String, group: String?, snapshots: String?, value: Double)

// With group, snapshots, and metadata
@objc(setCustomEvent:group:snapshots:info:)
setCustomEvent(_ name: String, group: String?, snapshots: String?, info: [String: String]?)

// With group, numeric value, and metadata
@objc(setCustomEvent:group:value:info:)
setCustomEvent(_ name: String, group: String?, value: Double, info: [String: String]?)

// All parameters
@objc(setCustomEvent:group:snapshots:value:info:)
setCustomEvent(_ name: String, group: String?, snapshots: String?, value: Double, info: [String: String]?)

Example: report a purchase event with a value and metadata

setCustomEvent(
    "purchase_completed",
    group: "checkout",
    value: 99.99,
    info: ["currency": "USD", "item_count": "3"]
)

Report a custom log

Report a custom log entry with optional name, snapshot, level, and metadata. Like custom events, the SDK provides multiple overloads.

Full method signature (all optional parameters included):

@objc(setCustomLog:name:snapshots:level:info:)
public static func setCustomLog(
    _ logInfo: String,
    name: String? = nil,
    snapshots: String? = "",
    level: String? = "INFO",
    info: [String: String]? = nil
)

Parameters

Available overloads

// Log message only
@objc(setCustomLog:)
setCustomLog(_ logInfo: String)

// With name
@objc(setCustomLog:name:)
setCustomLog(_ logInfo: String, name: String?)

// With name and snapshots
@objc(setCustomLog:name:snapshots:)
setCustomLog(_ logInfo: String, name: String?, snapshots: String?)

// All parameters
@objc(setCustomLog:name:snapshots:level:info:)
setCustomLog(_ logInfo: String, name: String?, snapshots: String?, level: String?, info: [String: String]?)

Example: report a warning-level log with metadata

setCustomLog(
    "Payment gateway timeout after 30s",
    name: "payment_error",
    level: "WARNING",
    info: ["gateway": "stripe", "retry_count": "2"]
)