iOS SDK接入

1. 在Podfile文件中添加以下配置。

   source 'https://gitee.com/aliyun-sls/Specs.git'
   pod 'AliyunLogProducer', '4.3.4' # 建議使用最新版本
   pod 'AliyunLogNetworkDiagnosis', '4.3.8' # 建議使用最新版本

   更多版本信息，請參見aliyun-log-ios-sdk。

2. 在AppDelegate類中引入如下頭文件。

   #import <AliyunLogNetworkDiagnosis/AliyunLogNetworkDiagnosis.h>

3. 在AppDelegate類的application: didFinishLaunchingWithOptions:方法中添加如下SDK初始化代碼。

   重要

   上報日志到日志服務時需使用阿里云賬號或RAM用戶的AccessKey，用于鑒權及防篡改。為避免將AccessKey保存在移動端應用中，造成安全風險，推薦您使用移動端日志直傳服務配置AccessKey。具體操作，請參見采集-搭建移動端日志直傳服務。

   SLSCredentials *credentials = [SLSCredentials credentials];
   // endpoint和project不支持動態更新，請在初始化SDK時指定
   credentials.endpoint = @"<your endpoint>";
   credentials.project = @"<your project>";
   
   // AccessKey建議通過STS方式獲取，參考文檔：采集-搭建移動端日志直傳服務
   // AccessKey在初始化時可以先不填，后續通過[[SLSCocoa sharedInstance] setCredentials:credentials];方法可以更新，參考后面的updateSDK方法實現
   credentials.accessKeyId = @"<your accessKeyId>"";
   credentials.accessKeySecret = @"<your accessKeySecret>";
   credentials.securityToken = @"<your accessKey securityToken>"; // 僅當AccessKey是通過STS服務獲取時需要
   
   SLSNetworkDiagnosisCredentials *networkCredentials = [credentials createNetworkDiagnosisCredentials];
   //secretKey不支持動態更新，請在初始化時指定
   networkCredentials.secretKey = self.secretKey;
   
   // （可選）設置業務擴展字段。僅對新產生的探測數據生效。
   // 不支持動態更新，請在SDK初始化時設置。
   [networkCredentials putExtension:@"custom_value" forKey:@"custom_key"];
   
   // 用戶接受隱私協議之前，先調用preInit完成SDK初始化。
   [[SLSCocoa sharedInstance] preInit:credentials configuration:^(SLSConfiguration * _Nonnull configuration) {
   	configuration.enableNetworkDiagnosis = YES;
   }];
   
   // 用戶接受隱私協議之后，再調用initialize完成SDK的完整初始化。
   [[SLSCocoa sharedInstance] initialize:credentials configuration:^(SLSConfiguration * _Nonnull configuration) {
   	configuration.enableNetworkDiagnosis = YES;
   }];
   
   // （可選）設置設備ID，可在任何時機調用，僅對新產生的探測數據生效。
   [SLSUtdid setUtdid:@"<your device id"];
   
   // （可選）配置用戶信息，可在任何時機調用。僅對新產生的探測數據生效。
   SLSUserInfo *userInfo = [SLSUserInfo userInfo];
   userInfo.uid = @"<your user id>";
   userInfo.channel = @"<your user channel";
   [userInfo addExt:@"ext_value" key:@"ext_key"];
   [[SLSCocoa sharedInstance] setUserInfo:userInfo];

   更多SDK使用示例請參考：Demo示例。

   重要參數說明如下表所示。

   字段	是否必填	說明
   secretKey	是	接入端應用的密鑰。更多信息，請參見創建接入端應用。
   putExtension	否	設置自定義信息，支持設置多個鍵值對。設置后，探測數據中將附加這些信息。
   endpoint	是	日志服務Project所屬的Endpoint，必須以https://開頭。如何獲取，請參見公網。
   project	是	您在創建接入端應用時指定的Project。更多信息，請參見創建接入端應用。

4. Apple的Local Network Privacy（本地網絡隱私）政策適配。

   1. 適用場景。

      從iOS14開始，Apple對訪問本地網絡的隱私政策進行了升級。如果您的應用使用了我們SDK提供的以下功能，可能會觸發Local Network Privacy政策：

      • 使用DNS（域名解析）探測功能：當您使用我們的SDK進行DNS探測，以下兩種情形都會觸發Local Network Privacy政策。

        • 調用者指定DNS服務器（域名解析服務器）：當您指定的DNS服務器為私有IP地址（什么是私有地址）時。

        • 調用者不指定DNS服務器：當設備網絡處于WiFi環境下時。

      • 使用ping、mtr、tcpping、udpping等其他探測接口時，目標地址為私有IP地址時。

   2. 如何適配本地網絡隱私政策？

      當您的使用場景會觸發Local Network Privacy政策時，集成步驟中需要確保執行如下措施以避免在提交App Store時被審核拒絕。

      在應用的Info.plist中增加如下鍵值對：

      <key>NSLocalNetworkUsageDescription</key>
      <string>您的應用需要訪問本地網絡的目的說明</string>

      說明

      網絡本地網絡目的需要符合您提供的應用的實際場景，關鍵要點包括：

      1. 說明訪問本地網絡的目的,列舉具體的功能和服務場景,表明對用戶有實際價值和意義。

      2. 承諾會尊重用戶隱私,經授權、在必要時才訪問,不獲取隱私數據,讓審核人員放心。

      3. 語氣真誠友好,希望得到理解支持,體現對審核的重視,有利于通過。

   3. Apple的Local network privacy政策介紹（官方Local Network Privacy FAQ）。

      Apple的Local network privacy（本地網絡隱私）是iOS 14、iPadOS 14、tvOS 14和watchOS 7引入的一項新隱私保護功能。其主要目的在于讓您了解哪些應用程序正在局域網內與其他設備通信，以防止應用程序在未經用戶許可的情況下濫用本地網絡。以下是關于這一功能的詳細解釋：

      1. 本地網絡訪問權限：當應用程序首次嘗試在局域網內與其他設備通信時，系統會向用戶顯示一個彈窗，詢問是否允許該應用訪問本地網絡。您可以選擇是或者否。這為您提供了對應用程序網絡行為更多的控制和了解。

      2. 本地網絡應用程序指示器：當應用程序在局域網內與其他設備通信時，狀態欄會顯示一個指示器（通常是一個帶箭頭的圓點），以提示您當前有應用程序正在使用本地網絡，增加了透明度。

      3. 微調隱私設置：您可以在系統設置的隱私部分查看和管理哪些應用程序被授予了訪問本地網絡的權限。隨時撤銷或重新授予權限。

      4. 影響范圍：任何使用Bonjour、mDNS或其他局域網通信技術的應用程序都會受到本地網絡隱私的影響。常見的場景包括局域網多人游戲、文件共享、智能家居設備控制等。

      5. 開發者適配：為確保應用程序在新的隱私策略下正常工作，開發者需要正確處理本地網絡訪問權限的請求和結果。未經授權的網絡訪問可能會導致應用程序無法正常運行。

      6. 教育：在系統升級過程中，Apple會向您介紹新功能，而應用程序開發者也有責任向您解釋他們需要訪問本地網絡的原因，以及如何妥善處理您的隱私關切。

      Local network privacy提升了用戶對應用網絡活動的可見性和掌控度，有效阻止惡意應用的數據竊取或網絡資源濫用行為。這同時也向開發者提出了更高要求，需在功能實現與用戶隱私保護間尋找平衡。

Android SDK接入

1. 在根build.gradle文件中添加以下配置。

   repositories {
     google()
     jcenter()
     mavenCentral()
     maven { url 'https://maven.aliyun.com/repository/public/' }
   }

2. 添加如下依賴。

   implementation 'io.github.aliyun-sls:aliyun-log-android-sdk:2.7.1@aar' // 建議使用最新版本
   implementation 'io.github.aliyun-sls:sls-android-core:1.0.10@aar' // 建議使用最新版本
   implementation 'io.github.aliyun-sls:sls-android-ot:1.0.8.1@aar' // 建議使用最新版本
   implementation 'io.github.aliyun-sls:sls-android-network-diagnosis:2.2.6@aar' // 建議使用最新版本
   implementation 'com.squareup.okhttp3:okhttp:3.11.0' // （可選）最低兼容3.10.0版本，HTTP探測時必須

   更多版本信息，請參見aliyun-log-android-sdk。

3. 添加如下初始化代碼。

   Credentials credentials = new Credentials();
   // （必填）endpoint和project不支持動態更新，請在初始化SDK時指定
   credentials.endpoint = "<your endpoint>";
   credentials.project = "<your project>";
   
   // AccessKey建議通過STS方式獲取，參考文檔：采集-搭建移動端日志直傳服務
   // AccessKey在初始化時可以先不填，后續通過SLSAndroid.setCredentials(credentials);方法可以更新，參考后面的updateSDK方法實現
   credentials.accessKeyId = "<your accessKeyId>";
   credentials.accessKeySecret = "<your accessKeySecret>";
   //credentials.securityToken = "<your accessKey securityToekn>"; // 僅當AccessKey是通過STS服務獲取時需要
   
   NetworkDiagnosisCredentials networkDiagnosisCredentials = credentials.getNetworkDiagnosisCredentials();
   // （必填）secretKey不支持動態更新，請在初始化時設置。
   networkDiagnosisCredentials.secretKey = secretKey;
   // （可選）設置業務擴展字段。僅對新產生的探測數據生效。
   // 不支持動態更新，請在SDK初始化時設置。
   networkDiagnosisCredentials.extension.put("custom_key", "custom_value");
   
   SLSAndroid.initialize(
     getApplicationContext(),
     credentials,
     configuration -> configuration.enableNetworkDiagnosis = true
   );
   
   // （建議）注冊探測數據上報回調
   SLSAndroid.registerCredentialsCallback((feature, result) -> {
     if (LogProducerResult.LOG_PRODUCER_SEND_UNAUTHORIZED == result ||
         LogProducerResult.LOG_PRODUCER_PARAMETERS_INVALID == result) {
       // 處理AccessKey過期、失效等鑒權問題
       Credentials credentials = new Credentials();
       credentials.accessKeyId = "<your accessKeyId>";
   		credentials.accessKeySecret = "<your accessKeySecret>";
   		credentials.securityToken = "<your accessKey securityToekn>"; 
   
       SLSAndroid.setCredentials(credentials);
     }
   });
   
   // （可選）設置設備ID，可在任何時機調用，僅對新產生的探測數據生效。
   SLSAndroid.setUtdid(getApplicationContext(), "<your device id");
   
   // （可選）配置用戶信息，可在任何時機調用。僅對新產生的探測數據生效。
   UserInfo userInfo = new UserInfo();
   userInfo.uid = "<your user id>";
   userInfo.channel = "<your user channel>";
   userInfo.addExt("ext_key", "ext_value");
   SLSAndroid.setUserInfo(userInfo);

   更多SDK使用示例請參考：Demo示例。

   字段	是否必填	說明
   secretKey	是	接入端應用的密鑰。更多信息，請參見創建接入端應用。
   extension.put	否	設置自定義信息，支持設置多個鍵值對。設置后，探測數據中將附加這些信息。
   endpoint	是	日志服務Project所屬的Endpoint，必須以https://開頭。如何獲取，請參見公網。
   project	是	您在創建接入端應用時指定的Project。更多信息，請參見創建接入端應用。
   accessKeyId	是	具備訪問日志服務Logstore權限的AccessKey ID。 建議您遵循最小化原則，按需授予RAM用戶必要的權限。關于授權的具體操作，請參見創建RAM用戶及授權、RAM自定義授權示例。
   accessKeySecret	是	具備訪問日志服務Logstore權限的AccessKey Secret。 AccessKey Secret是用戶用于加密簽名字符串和日志服務用來驗證簽名字符串的密鑰，必須保密。
   securityToken	否	訪問密鑰的Token。使用STS方式接入時，需要配置。如何獲取，請參見AssumeRole - 獲取扮演角色的臨時身份憑證。

Unity插件接入

1. 下載并導入Unity插件到您的Unity工程。

   下載最新版本的Unity插件，雙擊.unitypackage文件，導入插件相關的文件到您的Unity項目中。

   插件包目錄說明：

   • Assets/Plugins/Unity4SLS： Plugin腳本。

   • Assets/Plugins/Unity4SLS/Android/libs：Android平臺依賴的SDK和NDK。

   • Assets/Plugins/Unity4SLS/iOS/：iOS平臺依賴的Framework和靜態庫。

   • Assets/Plugins/Unity4SLS/Windows/：Windows平臺依賴的庫。

2. 初始化插件。

   重要

   上報日志到日志服務時需使用阿里云賬號或RAM用戶的AccessKey，用于鑒權及防篡改。為避免將AccessKey保存在移動端應用中，造成安全風險，推薦您使用移動端日志直傳服務配置AccessKey。具體操作，請參見采集-搭建移動端日志直傳服務。

   using AliyunSLS;
   
   Credentials credentials = new Credentials();
   // （必填）endpoint和project不支持動態更新，請在初始化SDK時指定
   credentials.endpoint = "<your endpoint>";
   credentials.project = "<your project>";
   credentials.secretKey = "<your secretKey>";
   
   // （可選）AccessKey建議通過STS方式獲取，參考文檔：采集-搭建移動端日志直傳服務
   // AccessKey在初始化時可以先不填，后續通過SLSAndroid.setCredentials(credentials);方法可以更新，參考后面的updateSDK方法實現
   credentials.accessKeyId = accessKeyId;
   credentials.accessKeySecret = accessKeySecret;
   //credentials.securityToken = "<your accessKey securityToekn>"; // 僅當AccessKey是通過STS服務獲取時需要
   
   // （可選）設置業務擴展字段。僅對新產生的探測數據生效。
   credentials.extension = new Dictionary<string, string>();
   extensions.Add("key_from_unity", "value_from_unity");
   
   // （可選）設置設備ID
   credentials.deviceId = "<your device id>";
   
   // 初始化SDK。
   Unity4SLS.Initialize(credentials);
   
   //（可選）配置用戶信息，可在任何時機調用，僅對新產生的探測數據生效。
   UserInfo info = new UserInfo();
   info.uid = "12312123123123";
   info.channel = "dev_debug";
   info.ext.Add("u_key1", "u_value1");
   Unity4SLS.SetUserInfo(info);

   字段	是否必填	說明
   secretKey	是	接入端應用的密鑰。更多信息，請參見創建接入端應用。
   extensions.Add	否	設置自定義信息，支持設置多個鍵值對。設置后，探測數據中將附加這些信息。
   endpoint	是	日志服務Project所屬的Endpoint，必須以https://開頭。如何獲取，請參見公網。
   project	是	您在創建接入端應用時指定的Project。更多信息，請參見創建接入端應用。

Windows SDK接入

下載地址

單擊Windows SDK，下載Windows SDK包。

集成方式

iOS SDK

[[SLSCocoa sharedInstance] registerCredentialsCallback:^(NSString * _Nonnull feature, NSString * result) {
	if ([@"LogProducerSendUnauthorized" isEqualToString:result] || 
      	[@"LogProducerParametersInvalid" isEqualToString:result]) {
        
        //處理token過期，AccessKey失效等鑒權類型問題。
	      //獲取到新的token后，調用如下代碼更新token。
	      SLSCredentials *credentials = [SLSCredentials credentials];
	      credentials.accessKeyId = accessKeyId;
	      credentials.accessKeySecret = accessKeySecret;
	      credentials.securityToken = securityToken; //可選，STS方式獲取的token必須要填。
        
        //更新憑證信息。
	      [[SLSCocoa sharedInstance] setCredentials:credentials];
	}
}];

Android SDK

SLSAndroid.registerCredentialsCallback((feature, result) -> {
  if (LogProducerResult.LOG_PRODUCER_SEND_UNAUTHORIZED == result ||
  LogProducerResult.LOG_PRODUCER_PARAMETERS_INVALID == result) {
  	
    // 處理token過期，AccessKey失效等鑒權類問題。
    Credentials credentials = new Credentials();
    credentials.accessKeyId = accessKeyId;
    credentials.accessKeySecret = accessKeySecret;
    credentials.securityToken = securityToken;

    SLSAndroid.setCredentials(credentials1);
  }
});

Unity

/// <summary>
/// 設置回調。
/// </summary>
public void setCredentialsCallback()
{
    callback_delegate callback = new callback_delegate(credentialsCallback);
    Unity4SLS.RegisterCredentialsCallback(callback);
}

// 處理AccessKey過期或無效。
public void credentialsCallback(string feature, string result)
{
    if ("LogProducerSendUnauthorized" == result || 
        "LogProducerParametersInvalid" == result ||
        "LOG_PRODUCER_SEND_UNAUTHORIZED" == result ||
        "LOG_PRODUCER_PARAMETERS_INVALID" == result) 
    {
        Credentials credentials = new Credentials();
        credentials.accessKeyId = accessKeyId;
        credentials.accessKeySecret = accessKeySecret;

        Unity4SLS.SetCredentials(credentials);
    }

}

Windows SDK

void on_token_ex() {
    //獲取配置類。
    AliNetworkDiagConfig& config = AliNetworkDiagConfig::getNetworkDiagConfig();
    //設置AccessKeyId、AccessKeySecret、Token。
    config.setSlsCredential(accessKeyId, accessKeySecret, securityToken);
    printf("[token-expired-callback] token expired callback excited\n");
}

iOS SDK

SLSPingRequest *request = [[SLSPingRequest alloc] init];
request.domain = @"www.example.com";
//可選參數。
request.context = @"<your ping context id>";
request.parallel = YES;
//可選參數。
request.extention = @{
    @"custom_key": @"custom_value_ios"
};
[[SLSNetworkDiagnosis sharedInstance] ping2:request callback:^(SLSResponse * _Nonnull response) {
    NSLog(@"ping result: %@", response.content);
}];

Android SDK

PingRequest request = new PingRequest();
request.domain = "www.example.com";
//可選參數。
request.multiplePortsDetect = true; //啟用多網卡探測。
request.context = "<your ping context id>";
//可選參數，設置當次網絡探測的擴展業務參數。
request.extension = new HashMap<String, String>() {
    {
        put("custom_key", "custom_value");
    }
};

NetworkDiagnosis.getInstance().ping(request, response -> {
    SLSLog.d(TAG, String.format("ping result: %s", response.content));
});

Unity

PingRequest request = new PingRequest();
request.domain = "www.example.com";
// 可選參數，設置探測上下文
request.context = "your ping request context id";

// 可選參數，設置探測級extension
request.extension = new Dictionary<string, string>();
request.extension.Add("key1", "value1");
request.extension.Add("key2", "value2");

// 可選參數，設置探測級回調函數
request.complete_callback = (response) => 
{
    Debug.Log("ping->completeCallback. type: " + response.type + ", context: " + response.context + ", content: " + response.content + ", error: " + response.error);
};
// 發起探測
Unity4SLS.Ping(request);

Windows SDK

//必選，初始化探測參數(任務ID（可為空字符串）、探測目標、DNS解析（0~3分別代表v4優先、v6優先、v4 only、v6 only）、探測端口）。
PingConfig* pingConfig = new PingConfig("0", "www.example.com", 0, 80);
//可選，修改探測目標。
pingConfig->setTarget("www.example.com");
//可選，修改探測任務ID。
pingConfig->setTraceId("fdadf-daa-dadadad-okokok23");
//可選，修改探測時間間隔，單位：ms。
pingConfig->setInterval(100);
//可選，修改探測超時時間。
pingConfig->setTimeout(2000);
//可選，設置探測結束時的回調
pingConfig->setCallback(demo_ping_callback);
//發起探測。
pingConfig->Detect();
//另：demo_ping_callback 范例：
void demo_ping_callback(void* context, char* json_result) {
    std::string* ctx = static_cast<std::string*>(context);
    printf("[探測結果回調 demo-ping-callback] %s, context : %s\n", json_result, ctx->c_str());
}

iOS SDK

SLSTcpPingRequest *request = [[SLSTcpPingRequest alloc] init];
request.domain = @"www.example.com";
request.port = 80;
//可選參數。
request.context = @"<your tcpping context id>";
//可選參數。
request.extention = @{
    @"custom_key": @"custom_value_ios"
};
[[SLSNetworkDiagnosis sharedInstance] tcpPing2:request callback:^(SLSResponse * _Nonnull response) {
    NSLog(@"ping result: %@", response.content);
}];

Android SDK

TcpPingRequest request = new TcpPingRequest();
request.domain = "www.example.com";
request.port = 80;
//可選參數。
request.context = "<your tcp ping context id>";
//可選參數，設置當次網絡探測的擴展業務參數。
request.extension = new HashMap<String, String>() {
    {
        put("custom_key", "custom_value");
    }
};

NetworkDiagnosis.getInstance().tcpPing(request, response -> {
    SLSLog.d(TAG, String.format("tcp ping result: %s", response.content));
});

Unity

TcpPingRequest request = new TcpPingRequest();
request.domain = "www.example.com";
request.port = 80;

// 可選參數，設置探測上下文
request.context = "your tcpping request context id";

// 可選參數，設置探測級extension
request.extension = new Dictionary<string, string>();
request.extension.Add("key1", "value1");
request.extension.Add("key2", "value2");

// 可選參數，設置探測級回調函數
request.complete_callback = (response) => 
{
    Debug.Log("tcpping->completeCallback. type: " + response.type + ", context: " + response.context + ", content: " + response.content + ", error: " + response.error);
};
// 發起探測
Unity4SLS.TcpPing(request);

Windows SDK

//必選，初始化探測參數(任務ID（可為空字符串）、探測目標、DNS解析（0~3分別代表v4優先、v6優先、v4 only、v6 only）、探測端口）
TcppingConfig* tcppingConfig = new TcppingConfig("", "www.example.com", 1, 80);
//可選，修改探測目標。
tcppingConfig->setTarget("www.example.com");
//可選，修改探測任務ID。
tcppingConfig->setTraceId("fdadf-daa-dadadad-okokok23");
//可選，修改探測時間間隔，單位：ms。
tcppingConfig->setInterval(100);
//可選，修改探測超時時間。
tcppingConfig->setTimeout(2000);
//可選，設置探測結束時的回調
tcppingConfig->setCallback(demo_tcpping_callback);
//發起探測。
tcppingConfig->Detect();

//另：demo_tcpping_callback 范例：
void demo_tcpping_callback(void* context, char* json_result) {
    std::string* ctx = static_cast<std::string*>(context);
    printf("[探測結果回調 demo-tcpping-callback] %s, context : %s\n", json_result, ctx->c_str());
}

iOS SDK

SLSHttpRequest *request = [[SLSHttpRequest alloc] init];
request.domain = @"https://demo.ne.aliyuncs.com";
//可選參數。
request.context = @"<your http context id>";
request.headerOnly = YES;
request.downloadBytesLimit = 128 * 1024; // 128KB
//可選參數，證書檢驗回調。getHttpCredential的配置參考下文。
request.credential = ^NSURLCredential * _Nullable(NSString * _Nonnull url) {
    return [self getHttpCredential:url];
};
//可選參數。
request.extention = @{
    @"custom_key": @"custom_value_ios"
};

[[SLSNetworkDiagnosis sharedInstance] http2:request callback:^(SLSResponse * _Nonnull response) {
    NSLog(@"ping result: %@", response.content);
}];

Android SDK

HttpRequest request = new HttpRequest();
//可選參數。
request.context = "<your http context id>";
request.headerOnly = true;
request.downloadBytesLimit = 1024;
//可選參數，證書檢驗回調。getSSLContext的配置參考下文。
request.credential = new HttpCredential(getSSLContext(context), null);
//可選參數，設置當次網絡探測的擴展業務參數。
request.extension = new HashMap<String, String>() {
    {
        put("custom_key", "custom_value");
    }
};

request.domain = "https://www.example.com";
NetworkDiagnosis.getInstance().http(request, response -> {
    SLSLog.d(TAG, String.format("http result: %s", response.content));
});

Unity

HttpRequest request = new HttpRequest();
request.domain = "https://www.example.com";

// 可選參數，設置探測上下文
request.context = "your http request context id";
request.headerOnly = true;
request.downloadBytesLimit = 1024;

// 可選參數，設置探測級extension
request.extension = new Dictionary<string, string>();
request.extension.Add("key1", "value1");
request.extension.Add("key2", "value2");

// 可選參數，設置探測級回調函數
request.complete_callback = (response) => 
{
    Debug.Log("http->completeCallback. type: " + response.type + ", context: " + response.context + ", content: " + response.content + ", error: " + response.error);
};
// 發起探測
Unity4SLS.Http(request);

Windows SDK

//必選，初始化探測參數(任務ID，探測目標，DNS解析（0~3分別代表v4優先、v6優先、v4 only、v6 only）)
HttpDetectionConfig* httpConfig = new HttpDetectionConfig("", "http://www.example.com", 1);
//可選，修改探測目標。
httpConfig->setTarget("http://www.example.com");
//可選，修改探測任務ID。
httpConfig->setTraceId("fdadf-daa-dadadad-okokok23");
//可選，修改探測時間間隔，單位：ms。
httpConfig->setInterval(100);
//可選，修改探測超時時間。
httpConfig->setTimeout(2000);
//可選，設置探測結束時的回調
httpConfig->setCallback(demo_http_callback);
//發起探測。
httpConfig->Detect();

//demo_http_callback 范例：
void demo_http_callback(void* context, char* json_result) {
    std::string* ctx = static_cast<std::string*>(context);
    printf("[探測結果回調 demo-http-callback] %s, context : %s\n", json_result, ctx->c_str());
}

iOS SDK

SLSMtrRequest *request = [[SLSMtrRequest alloc] init];
request.domain = @"www.example.com";
//可選參數。
request.context = @"<your mtr context id>";
request.parallel = YES;
request.protocol = SLS_MTR_PROROCOL_ALL;
//可選參數。
request.extention = @{
    @"custom_key": @"custom_value_ios"
};

[[SLSNetworkDiagnosis sharedInstance] mtr2:request callback:^(SLSResponse * _Nonnull response) {
    NSLog(@"ping result: %@", response.content);
}];

Android SDK

MtrRequest request = new MtrRequest();
request.domain = "www.example.com";
//可選參數。
request.protocol = Protocol.ICMP;
request.context = "<your mtr context id>";
//可選參數，設置當次網絡探測的擴展業務參數。
request.extension = new HashMap<String, String>() {
    {
        put("custom_key", "custom_value");
    }
};

NetworkDiagnosis.getInstance().mtr(request, response -> {
    SLSLog.d(TAG, String.format("mtr result: %s", response.content));
});

Unity

MtrRequest request = new MtrRequest();
request.domain = "www.example.com";
// 可選參數，設置探測上下文
request.context = "your mtr request context id";

// 可選參數，設置探測級extension
request.extension = new Dictionary<string, string>();
request.extension.Add("key1", "value1");
request.extension.Add("key2", "value2");

// 可選參數，設置探測級回調函數
request.complete_callback = (response) => 
{
    Debug.Log("mtr->completeCallback. type: " + response.type + ", context: " + response.context + ", content: " + response.content + ", error: " + response.error);
};
// 發起探測
Unity4SLS.Mtr(request);

Windows SDK

//必選，初始化探測參數。
MtrDetectionConfig* mtrConfig = new MtrDetectionConfig("", "www.example.com", "ICMP", 1);
//可選，修改探測目標。
mtrConfig->setTarget("www.example.com");
//可選，修改探測任務ID。
mtrConfig->setTraceId("fdadf-daa-dadadad-okokok23");
//可選，修改探測時間間隔，單位：ms。
mtrConfig->setInterval(100);
//可選，修改探測超時時間。
mtrConfig->setTimeout(2000);
//可選，設置探測結束時的回調
mtrConfig->setCallback(demo_mtr_callback);
//發起探測。
mtrConfig->Detect();

//demo_mtr_callback 范例：
void demo_mtr_callback(void* context, char* json_result) {
    std::string* ctx = static_cast<std::string*>(context);
    printf("[探測結果回調 demo-mtr-callback] %s, context : %s\n", json_result, ctx->c_str());
}

iOS SDK

SLSDnsRequest *request = [[SLSDnsRequest alloc] init];
request.domain = @"www.example.com";
//可選參數。
request.context = @"<your dns context id>";
//可選參數。
request.extention = @{
    @"custom_key": @"custom_value_ios"
};

[[SLSNetworkDiagnosis sharedInstance] dns2:request callback:^(SLSResponse * _Nonnull response) {
    NSLog(@"ping result: %@", response.content);
}];

Android SDK

DnsRequest request = new DnsRequest();
request.domain = "www.example.com";
//可選參數。
request.context = "<your dns context id>";
//可選參數，設置當次網絡探測的擴展業務參數。
request.extension = new HashMap<String, String>() {
    {
        put("custom_key", "custom_value");
    }
};
NetworkDiagnosis.getInstance().dns(request, response -> {
    SLSLog.d(TAG, String.format("dns result: %s", response.content));
});

Unity

DnsRequest request = new DnsRequest();
request.domain = "www.example.com";
// 可選參數，設置探測上下文
request.context = "your dns request context id";

// 可選參數，設置探測級extension
request.extension = new Dictionary<string, string>();
request.extension.Add("key1", "value1");
request.extension.Add("key2", "value2");

// 可選參數，設置探測級回調函數
request.complete_callback = (response) => 
{
    Debug.Log("dns->completeCallback. type: " + response.type + ", context: " + response.context + ", content: " + response.content + ", error: " + response.error);
};
// 發起探測
Unity4SLS.Dns(request);

Windows SDK

//必選，初始化探測參數。
DnsDetectionConfig* dnsConfig = new DnsDetectionConfig("", "www.example.com", 2000, 0, "223.5.5.5", "A");
//可選，修改探測目標。
dnsConfig->setTarget("www.example.com");
//可選，修改探測任務ID。
dnsConfig->setTraceId("fdadf-daa-dadadad-okokok23");
//可選，修改探測時間間隔，單位：ms。
dnsConfig->setInterval(100);
//可選，修改探測超時時間。
dnsConfig->setTimeout(2000);
//可選，修改DNS服務器。
dnsConfig->setServers("30.30.XX.XX");
//可選，修改DNS解析選項。
dnsConfig->setType(1);
//可選，設置探測結束時的回調
dnsConfig->setCallback(demo_dns_callback);
//發起探測。
dnsConfig->Detect();

//demo_mtr_callback 范例：
void demo_dns_callback(void* context, char* json_result) {
    std::string* ctx = static_cast<std::string*>(context);
    printf("[探測結果回調 demo-dns-callback] %s, context : %s\n", json_result, ctx->c_str());
}

Windows SDK

//必選，初始化探測參數，"7564"為UDP報文負載，為十六進制字符串（Hex String）格式，
UdpConfig* udpConfig = new UdpConfig("0", "www.example.com", 0, 4000, "7564");
//可選，修改探測目的
udpConfig->setTarget("www.example.com");
//可選，修改探測任務id
udpConfig->setTraceId("fdadf-daa-dadadad-okokok23");
//可選，修改探測時間間隔(ms)
udpConfig->setInterval(100);
//可選，修改探測超時時間
udpConfig->setTimeout(2000);
//可選，設置探測結束時的回調
udpConfig->setCallback(demo_udp_callback);
//發起探測。
udpConfig->Detect();

//demo_udp_callback 范例：
void demo_udp_callback(void* context, char* json_result) {
    std::string* ctx = static_cast<std::string*>(context);
    printf("[探測結果回調 demo-udp-callback] %s, context : %s\n", json_result, ctx->c_str());
}

iOS SDK

// 給用戶打上兩個標簽，分別是 "tag_vip", "tag_japan_normal"
NSArray *tags = [[NSArray alloc] initWithObjects:@"tag_vip", @"tag_japan_normal", nil];
[AliNetworkDiagnosis setUserTags:tags];

Android SDK

// 給用戶打上兩個標簽，分別是 "tag_vip", "tag_japan_normal"
String[] tags = {"tag_vip","tag_japan_normal"};
Diagnosis.setUserTags(tags);

iOS SDK

[[SLSNetworkDiagnosis sharedInstance] updateExtensions:@{
    @"key1": @"value1",
    @"key2": @"value2"
}];

Android SDK

NetworkDiagnosis.getInstance().updateExtensions(new HashMap<String, String>(){
    {
        put("key1", "value1");
        put("key2", "value2");
    }
});

Unity

Dictionary<string, string> extensions = new Dictionary<string, string>();
extensions.Add("key_from_unity", "value_from_unity");

Unity4SLS.UpdateExtensions(extensions);

Windows SDK

//獲取配置類。
AliNetworkDiagConfig& config = AliNetworkDiagConfig::getNetworkDiagConfig();

//自定義Extension信息。
std::map<std::string, std::string> mp;
mp.insert(make_pair("key1", "value1"));
mp.insert(make_pair("key2", "value2"));
mp.insert(make_pair("key3", "value3"));

//更新擴展信息。
config.updateExtension(mp); 

iOS SDK

[[SLSNetworkDiagnosis sharedInstance] setPolicyDomain:@"your custom domain"];

Android SDK

NetworkDiagnosis.getInstance().setPolicyDomain("your custom domain");

Unity

Unity4SLS.SetPolicyDomain("your custom domain");

Windows SDK

config.setPolicyDomain("yourpolicydomain"); 

iOS SDK

//注冊HTTP探測證書校驗回調。
[[SLSNetworkDiagnosis sharedInstance] registerHttpCredentialDelegate:^NSURLCredential * _Nullable(NSString * _Nonnull url) {
    return [self getHttpCredential:url];
}];

//處理證書校驗。
-(NSURLCredential*) getHttpCredential:(NSString*)url {
    if (![url containsString:@"demo.ne.aliyuncs.com"]) {
        return nil;
    }
    
    NSString *p12WithBase64 = @"your p12 infomation";
    NSData *p12Data = [[NSData alloc] initWithBase64EncodedString:p12WithBase64 options:0];
    CFDataRef inPKCS12Data = (__bridge CFDataRef)p12Data;
        
    SecIdentityRef identity = NULL;
    NSString *pass = @"123";
    OSStatus status = [self extractIdentity:inPKCS12Data identity:&identity pass:pass];
    if(status != 0 || identity == NULL) {
        return nil;
    }
        
        SecCertificateRef certificate = NULL;
        SecIdentityCopyCertificate (identity, &certificate);
        const void *certs[] = {certificate};
        CFArrayRef arrayOfCerts = CFArrayCreate(kCFAllocatorDefault, certs, 1, NULL);
        
        //NSURLCredentialPersistenceForSession:創建URL證書，在會話期間有效。
        NSURLCredential *credential = [NSURLCredential credentialWithIdentity:identity certificates:(__bridge NSArray*)arrayOfCerts persistence:NSURLCredentialPersistenceForSession];
        
        if(certificate) {
            CFRelease(certificate);
        }
        
        if (arrayOfCerts) {
            CFRelease(arrayOfCerts);
        }
    if (credential) {
        return [credential copy];
    }
    
    return nil;
}

Android SDK

//注冊HTTP探測證書校驗回調。
final HttpCredential credential = new HttpCredential(getSSLContext(context), null);
NetworkDiagnosis.getInstance().registerHttpCredentialCallback((url, context) -> credential);


//處理證書校驗。
@RequiresApi(api = VERSION_CODES.O)
private SSLContext getSSLContext(Context context) {
    try {
        //服務器端需要驗證的客戶端證書。
        String KEY_STORE_TYPE_P12 = "PKCS12";
        KeyStore keyStore = KeyStore.getInstance(KEY_STORE_TYPE_P12);

        String p12Str = "your p12 infomation";
        byte[] p12Data = Base64.getDecoder().decode(p12Str);

        InputStream ksIn = new ByteArrayInputStream(p12Data);
        try {
            keyStore.load(ksIn, "your password".toCharArray());
        } catch (Exception e) {
            Log.e("Exception", e.getMessage(), e);
        } finally {
            try {
                ksIn.close();
            } catch (Exception ignore) {
            }
        }
        SSLContext sslContext = SSLContext.getInstance("TLS");
        TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(
            TrustManagerFactory.getDefaultAlgorithm());
        trustManagerFactory.init((KeyStore)null);

        KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance("X509");
        keyManagerFactory.init(keyStore, "your password".toCharArray());
        sslContext.init(keyManagerFactory.getKeyManagers(), trustManagerFactory.getTrustManagers(), null);
        return sslContext;
    } catch (Exception e) {
        Log.e("tag", e.getMessage(), e);
    }
    return null;
}