SDK插件使用说明

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;
}