Application Real-Time Monitoring Service:Monitor iOS apps

Set the Endpoint

Sets the endpoint for your application. Call this method before start.

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

Set the Workspace

Sets the workspace for your application. Call this method before start.

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

Start the SDK

Initializes the SDK with the specified service ID.

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

Set a Custom Device ID

Sets a custom device ID that replaces the automatically obtained one.

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

Set a Custom App Version

Sets a custom app version that the SDK reports instead of the automatically detected one.

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

Set the App Channel

Sets a channel ID to identify the distribution channel of your application.

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

Exclude Specific Classes

Adds a class name to the swizzle exclusion set so that matched classes skip automatic instrumentation. Use this method to exclude classes that you do not want to monitor or that cause compatibility issues. You can call this method multiple times. The SDK uses substring matching for class name exclusion.

// Exclude all classes containing StoreKit2ViewController
[AlibabaCloudRUM excludeClassFromTracking:@"StoreKit2ViewController"];
// Exclude all classes containing BTDemoStoreKit2MixedBridge
[AlibabaCloudRUM excludeClassFromTracking:@"BTDemoStoreKit2MixedBridge"];

Enable or Disable Modules

Enables or disables specific data collection modules. Local configurations take precedence over remote configurations. Multiple calls accumulate.

@objc(disableModule:)
public static func disableModule(_ module: AlibabaCloudModule)

@objc(enableModule:)
public static func enableModule(_ module: AlibabaCloudModule)

@objc(AlibabaCloudModule)
public enum AlibabaCloudModule: Int {
    case crash        = 0
    case network      = 1
    case view         = 2
    case action       = 3
    case webView      = 4
    case longTask     = 5
    case appLaunch    = 6
    case appState     = 7
    case netState     = 8
    case customEvent  = 9
    case customLog    = 10
    case customMetric = 11
}

Example:

// Disable the network data collection module
[AlibabaCloudRUM disableModule:AlibabaCloudModuleNetwork];

Set the Application Environment

Specifies the application environment, such as LOCAL, DAILY, or PROD.

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

Resource Snapshot Collection

Collects HTTP request and response headers and payload information. By default, resource snapshot collection is disabled. You must explicitly enable it.

Enables resource snapshot collection for the HttpClient library by setting a ResourceSnapshotProvider.

void setResourceSnapshotProvider(ResourceSnapshotProvider? provider)

Set the Username

Sets a username to link monitoring data with actual users.

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

Set Custom User Extra Info

Sets additional user information to enrich user-level data analysis.

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

Set Global Properties

Sets custom global business properties. Once set, all new data automatically inherits these properties, enabling correlation between monitoring data and business attributes.

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

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

Report Custom Exceptions

Reports custom exception data for statistical analysis.

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

Report Custom Events

Reports custom event data for statistical analysis.

Multiple overloaded versions are available for different reporting requirements:

Report Custom Logs

Reports custom log information for statistical analysis.

Report Custom Resources

Reports custom network resource request data, including request status, performance metrics, and trace tracking information. Two overloaded versions are available for basic and advanced scenarios.

@objc(setCustomResource:success:url:method:statusCode:errorMessage:)
public static func setCustomResource(_ type: String, success: Bool, url: String, method: String, statusCode: Int, errorMessage: String?) -> Bool

// Swift - Successful GET request
let result = AlibabaCloudRUM.setCustomResource(
    "API",
    success: true,
    url: "https://api.example.com/users",
    method: "GET",
    statusCode: 200,
    errorMessage: nil
)

// Swift - Failed POST request
let result2 = AlibabaCloudRUM.setCustomResource(
    "API",
    success: false,
    url: "https://api.example.com/login",
    method: "POST",
    statusCode: 401,
    errorMessage: "Unauthorized access"
)

// Objective-C - Successful GET request
BOOL result = [AlibabaCloudRUM setCustomResource:@"API"
                                         success:YES
                                             url:@"https://api.example.com/users"
                                          method:@"GET"
                                      statusCode:200
                                    errorMessage:nil];

// Objective-C - Failed POST request
BOOL result2 = [AlibabaCloudRUM setCustomResource:@"API"
                                          success:NO
                                              url:@"https://api.example.com/login"
                                           method:@"POST"
                                       statusCode:401
                                     errorMessage:@"Unauthorized access"];

@objc(setCustomResource:success:url:method:statusCode:errorMessage:provider:tracing:measure:)
public static func setCustomResource(_ type: String, success: Bool, url: String, method: String, statusCode: Int, errorMessage: String?, provider: String?, tracing: AlibabaCloudTracingContext?, measure: AlibabaCloudResourceMeasure?) -> Bool