Application Real-Time Monitoring Service：SDK配置參考

設定 Endpoint 地址

每個應用都需要關聯對應的Endpoint地址，該介面需要在調用start:前設定。

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

設定 Workspace 地址

每個應用都需要關聯對應的Workspace，該介面需要在調用start:前設定。

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

啟動介面

您需要調用start: 方法初始化 SDK。

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

設定自訂裝置ID

可以通過此方法設定自訂裝置ID，設定成功後，SDK將不再使用預設擷取的裝置ID。

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

設定自訂App版本號碼

通過此方法設定了自訂App版本號碼，那麼SDK將會上報此版本號碼，不再使用預設擷取的版本號碼。

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

設定使用者渠道ID

區分應用發布的渠道。

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

設定應用環境

區分應用的環境。通過此方法可以指定應用的環境，如LOCAL、DAILY、PROD等。

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

自訂使用者名稱稱

SDK支援設定與使用者相關的資訊，從而完成與實際使用者相關聯的資料分析需求情境。

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

自訂使用者擴充資訊

SDK支援設定與使用者相關的資訊，從而完成資料分析與實際使用者相關聯的需求情境。

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

自訂全域屬性

自訂全域屬性設定後，新產生的資料會自動攜帶該業務屬性資訊，用於分析與業務屬性相關聯的需求。

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

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

自訂異常

調用自訂異常介面，並傳入相應的參數，可完成自訂異常資料的統計功能。

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

自訂事件

SDK支援上報自訂事件。調用相應的介面，並傳入相應的參數，可完成自訂事件數目據的統計功能。

@objc(setCustomEvent:)
public static func setCustomEvent(_ name: String)

@objc(setCustomEvent:group:)
public static func setCustomEvent(_ name: String, group: String? = nil)

@objc(setCustomEvent:group:snapshots:)
public static func setCustomEvent(_ name: String, group: String? = nil, snapshots: String? = nil)

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

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

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

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

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

@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)

自訂日誌

SDK支援上報自訂日誌資訊。調用相應的介面，並傳入相應的參數，可完成自訂日誌資料的統計功能。

@objc(setCustomLog:)
public static func setCustomLog(_ logInfo: String)

@objc(setCustomLog:name:)
public static func setCustomLog(_ logInfo: String, name: String? = nil) 

@objc(setCustomLog:name:snapshots:)
public static func setCustomLog(_ logInfo: String, name: String? = nil, snapshots: String? = "") 

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

基礎情境

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

傳回值：Bool - 介面調用是否成功，true 表示調用成功，false 表示調用失敗（如 SDK 未初始化或參數錯誤）。

使用樣本：

// Swift - 成功的 GET 請求
let result = AlibabaCloudRUM.setCustomResource(
    "AP",
    success: true,
    url: "https://api.example.com/users",
    method: "GET",
    statusCode: 200,
    errorMessage: nil
)

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

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

// Objective-C - 失敗的 POST 請求
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

傳回值：Bool - 介面調用是否成功，true 表示調用成功，false 表示調用失敗。

使用樣本：

// Swift - 建立效能指標對象
let measure = AlibabaCloudResourceMeasure.measure()
measure.duration = 850
measure.size = 10240
measure.dnsDuration = 30
measure.connectDuration = 80
measure.sslDuration = 120
measure.firstByteDuration = 250
measure.downloadDuration = 370

// 建立鏈路追蹤上下文
let traceId = AlibabaCloudTraceGenerator.generateTraceId(.SkywalkingV3)
let spanId = AlibabaCloudTraceGenerator.generateTraceId(.SkywalkingV3)
let tracing = AlibabaCloudTracingContext(traceId: traceId, spanId: spanId, tracingProtocol: .SkywalkingV3)

// 上報完整的資源資訊
let result = AlibabaCloudRUM.setCustomResource(
  "HTTPS",
  success: true,
  url: "https://api.example.com/v2/data",
  method: "POST",
  statusCode: 200,
  errorMessage: nil,
  provider: "Aliyun",
  tracing: tracing,
  measure: measure
)

// Objective-C - 建立效能指標對象
AlibabaCloudResourceMeasure *measure = [AlibabaCloudResourceMeasure measure];
measure.duration = 850;
measure.size = 10240;
measure.dnsDuration = 30;
measure.connectDuration = 80;
measure.sslDuration = 120;
measure.firstByteDuration = 250;
measure.downloadDuration = 370;

// 建立鏈路追蹤上下文
NSString *traceId = [AlibabaCloudTracingGenerator generateTraceId:AlibabaCloudTracingProtocolW3C];
NSString *spanId = [AlibabaCloudTracingGenerator generateSpanId:AlibabaCloudTracingProtocolW3C];
AlibabaCloudTracingContext *tracing = [AlibabaCloudTracingContext contextWithTraceId:traceId
                                                                              spanId:spanId
                                                                            protocol:AlibabaCloudTracingProtocolW3C
];

// 上報完整的資源資訊
BOOL result = [AlibabaCloudRUM setCustomResource:@"HTTPS"
                                         success:YES
                                             url:@"https://api.example.com/v2/data"
                                          method:@"POST"
                                      statusCode:200
                                    errorMessage:nil
                                        provider:@"Aliyun"
                                         tracing:tracing
                                         measure:measure];

輔助類型說明

// Swift - 產生 TraceId 和 SpanId
let traceId = AlibabaCloudTracingGenerator.generateTraceId(.SkywalkingV3)
let spanId = AlibabaCloudTracingGenerator.generateSpanId(.SkywalkingV3)

// Swift - 產生 Trace 上下文
let tracingContext = AlibabaCloudTracingContext(traceId: traceId, spanId: spanId, protocol: .SkywalkingV3)

// Objective-C - 產生 TraceId 和 SpanId
NSString *traceId = [AlibabaCloudTracingGenerator generateTraceId:AlibabaCloudTracingProtocolW3C];
NSString *spanId = [AlibabaCloudTracingGenerator generateSpanId:AlibabaCloudTracingProtocolW3C];

// Objective-C - 產生上下文
AlibabaCloudTracingContext *context = [AlibabaCloudTracingContext contextWithTraceId:traceId
                                                                              spanId:spanId
                                                                     tracingProtocol:AlibabaCloudTracingProtocolW3C
];

// Swift
let measure = AlibabaCloudResourceMeasure.measure()
measure.duration = 1200
measure.size = 5120
measure.dnsDuration = 50
measure.connectDuration = 100
measure.sslDuration = 150
measure.firstByteDuration = 300
measure.downloadDuration = 600

// Objective-C
AlibabaCloudResourceMeasure *measure = [AlibabaCloudResourceMeasure measure];
measure.duration = 1200;
measure.size = 5120;
measure.dnsDuration = 50;
measure.connectDuration = 100;
measure.sslDuration = 150;
measure.firstByteDuration = 300;
measure.downloadDuration = 600;

注意事項

1. 傳回值檢查：建議檢查方法傳回值，如果返回 false，說明介面調用失敗。

2. 非同步上報：介面調用成功（返回 true）僅表示 SDK 已接受該資料，實際資料上報為非同步作業。