阿里云日志服务SLSSDK插件使用说明-云淘科技

集成SDK插件到App后，您只需启动App，网络质量分析器就会自动进行网络探测。本文介绍SDK插件的使用说明。

SDK接入

iOS SDK接入

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

source 'https://github.com/aliyun-sls/Specs.git'
pod 'AliyunLogProducer', '3.2.1', :subspecs => ['Producer', 'Core', 'OT', 'NetworkDiagnosis']

更多版本信息，请参见aliyun-log-ios-sdk。

在AppDelegate类中引入如下头文件。
```
#import 
```

在AppDelegate类的application: didFinishLaunchingWithOptions:方法中添加如下SDK初始化代码。

重要

上报日志到日志服务时需使用阿里云账号或RAM用户的AccessKey，用于鉴权及防篡改。为避免将AccessKey保存在移动端应用中，造成安全风险，推荐您使用移动端日志直传服务配置AccessKey。具体操作，请参见采集-搭建移动端日志直传服务。

SLSCredentials *credentials = [SLSCredentials credentials];
SLSNetworkDiagnosisCredentials *networkDiagnosisCredentials = [credentials createNetworkDiagnosisCredentials];
networkDiagnosisCredentials.secretKey = @"your secretKey";
networkDiagnosisCredentials.endpoint = @"your endpoint";
networkDiagnosisCredentials.project = @"your project";

// 请求AccessKey信息。
- (void) requestAccessKey {
    // 推荐您先使用移动端日志直传服务配置AccessKey信息。
    // ...

    //  获取到AccessKey信息后，完成更新。
    [self updateAccessKey:accessKeyId accessKeySecret:accessKeySecret securityToken:securityToken];
}

// 更新AccessKey信息。
- (void) updateAccessKey:(NSString *)accessKeyId accessKeySecret:(NSString *)accessKeySecret securityToken:(NSString *)securityToken {
    
    // 通过STS服务获取的AccessKey会包含securitToken，需要使用以下方式更新。
    if (securityToken.length > 0) {
        if (accessKeyId.length > 0 && accessKeySecret.length > 0) {
            [_config ResetSecurityToken:accessKeyId
                        accessKeySecret:accessKeySecret
                          securityToken:securityToken
            ];
        }
    } else {
        // 不是通过STS服务获取的AccessKey，使用以下方式更新。
        if (accessKeyId.length > 0 && accessKeySecret.length > 0) {
            [_config setAccessKeyId: accessKeyId];
            [_config setAccessKeySecret: accessKeySecret];
        }
    }
}
//（选填）设置设备ID，可在任何时机调用，仅对新产生的探测数据生效。
//建议在SDK初始化之前调用。
[Utdid setUtdid:@"your device id"];

//初始化SDK。
[[SLSCocoa sharedInstance] initialize:credentials configuration:^(SLSConfiguration * _Nonnull configuration) {
	configuration.enableNetworkDiagnosis = YES;
}];

//（选填）设置扩展业务字段。设置后，所有探测结果中都会包含该业务字段。
[networkDiagnosisCredentials putExtension:@"value" forKey:@"key"];

//（选填）配置用户信息。配置后，所有探测结果中都会包含该信息。
SLSUserInfo *userinfo = [SLSUserInfo userInfo];
//用户UID。
userinfo.uid = @"1234567";
//用户渠道。
userinfo.channel = @"pub";
//用户扩展信息。
[userinfo addExt:@"ext_value" key:@"ext_key"];
//更新用户信息，可在任何时机调用，仅对新产生的探测数据生效。
[[SLSCocoa sharedInstance] setUserInfo:userinfo];

重要参数说明如下表所示。

字段	是否必填	说明
secretKey	是	接入端应用的密钥。更多信息，请参见创建接入端应用。
putExtension	否	设置自定义信息，支持设置多个键值对。设置后，探测数据中将附加这些信息。
endpoint	是	日志服务Project所属的Endpoint，必须以https://开头。如何获取，请参见公网。
project	是	您在创建接入端应用时指定的Project。更多信息，请参见创建接入端应用。

Android SDK接入

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

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

添加如下依赖。

implementation 'io.github.aliyun-sls:aliyun-log-android-sdk:2.7.0@aar'
implementation 'io.github.aliyun-sls:sls-android-core:1.0.8@aar'
implementation 'io.github.aliyun-sls:sls-android-ot:1.0.8.1@aar'
implementation 'io.github.aliyun-sls:sls-android-network-diagnosis:2.1.1@aar'

更多版本信息，请参见aliyun-log-android-sdk。

添加如下依赖。

Credentials credentials = new Credentials();
NetworkDiagnosisCredentials networkDiagnosisCredentials = credentials.getNetworkDiagnosisCredentials();
networkDiagnosisCredentials.secretKey = "your secretKey";
// 传入userId，您可以在网络质量分析器控制台按此字段过滤数据。
networkDiagnosisCredentials.extension.put("userId", "12312");networkDiagnosisCredentials.extension.put("key", "value");
networkDiagnosisCredentials.endpoint = "your endpoint";
networkDiagnosisCredentials.project = "your porject";
// 请求AccessKey信息。
private void requestAccessKey() {
    // 推荐您先使用移动端日志直传服务配置AccessKey信息。
    // ...

    // 获取AccessKey信息后，完成更新。
    updateAccessKey(accessKeyId, accessKeySecret, securityToken);
}

// 更新AccessKey信息。
private void updateAccessKey(String accessKeyId, String accessKeySecret, String securityToken) {
    // 通过STS服务获取的AccessKey包含securitToken，需要使用以下方式更新。
    if (null != securityToken && !"".equals(securityToken)) {
        config.resetSecurityToken(accessKeyId, accessKeySecret, securityToken);
    } else {
        // 不是通过STS服务获取的AccessKey，使用以下方式更新。
        config.setAccessKeyId(accessKeyId);
        config.setAccessKeySecret(accessKeySecret);
    }
}

//（选填）设置设备ID，可在任何时机调用，仅对新产生的探测数据生效。
//建议在SDK初始化之前调用。
SLSAndroid.setUtdid(context, "your device id");

//初始化SDK。
SLSAndroid.initialize(
  context,
  credentials,
  configuration -> {
  	configuration.enableNetworkDiagnosis = true;
  	//（选填）配置用户信息。
  	UserInfo info = new UserInfo();
  	info.uid = "123321";
  	info.channel = "dev";
  	info.addExt("ext_key", "ext_value");
  	configuration.userInfo = info;
    //也可以在任何时机通过以下方式更新UserInfo。
    //仅对新产生的探测数据生效。
    //SLSAndroid.setUserInfo(info);
  }
);

字段	是否必填	说明
secretKey	是	接入端应用的密钥。更多信息，请参见创建接入端应用。
extension.put	否	设置自定义信息，支持设置多个键值对。设置后，探测数据中将附加这些信息。
endpoint	是	日志服务Project所属的Endpoint，必须以https://开头。如何获取，请参见公网。
project	是	您在创建接入端应用时指定的Project。更多信息，请参见创建接入端应用。
accessKeyId	是	具备访问日志服务Logstore权限的AccessKey ID。如何获取，请参见访问密钥。
accessKeySecret	是	具备访问日志服务Logstore权限的AccessKey Secret。如何获取，请参见访问密钥。
securityToken	否	访问密钥的Token。使用STS方式接入时，需要配置。如何获取，请参见AssumeRole – 获取扮演角色的临时身份凭证。

Unity插件接入

下载并导入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平台依赖的库。
- Assets/Scenes/：示例Scenes，实际集成时可以删除。
- Assets/Scripts/：示例Scripts，实际集成时可以删除。

初始化插件。

重要

Credentials credentials = new Credentials();
credentials.endpoint = "your endpoint";
credentials.project = "your project";
credentials.secretKey = "your secretKey";
//可选配置，扩展参数。
credentials.extension = new Dictionary();
extensions.Add("key_from_unity", "value_from_unity");
// 请求AccessKey信息。
private void requestAccessKey() {
    // 推荐您先使用移动端日志直传服务配置AccessKey信息。
    // ...

    // 获取AccessKey信息后，完成更新。
    updateAccessKey(accessKeyId, accessKeySecret, new-securityToken);
}

// 更新AccessKey信息。
private void updateAccessKey(String accessKeyId, String accessKeySecret, String securityToken) {
    // 通过STS服务获取的AccessKey包含securitToken，需要使用以下方式更新。
    if (null != securityToken && !"".equals(securityToken)) {
        config.resetSecurityToken(accessKeyId, accessKeySecret, securityToken);
    } else {
        // 不是通过STS服务获取的AccessKey，使用以下方式更新。
        config.setAccessKeyId(accessKeyId);
        config.setAccessKeySecret(accessKeySecret);
    }
}


//初始化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接入

SDK以MD动态库的形式提供，您可按照集成动态库的形式进⾏Windows SDK接入。

将/lib⽬录下的库⽂件和/include⽬录下的头⽂件添加到项⽬中。
配置附加库⽬录路径。
将alinetworkdiagnosis.dll库同步到⽣成⽬录。
使⽤时，使用#include "api.h"指令。

下载地址

单击Windows SDK，下载Windows SDK包。

SDK初始化

重要

上报日志到日志服务时需使用阿里云账号或RAM用户的AccessKey，用于鉴权及防篡改。为避免将AccessKey保存在代码中，造成安全风险，推荐您使用移动端日志直传服务配置AccessKey。具体操作，请参见采集-搭建移动端日志直传服务。

void logcallback(const char* s) {
    printf("[demo-logcallback]  %s", (char*)s);
}
void on_token_ex() {
    printf("[demo-token-expired-callback] ----------------------token expired callback excited----------------
");
}
void on_token_ex_ctx(void* ctx) {
  	printf("[demo-token-expired-callback] ----------------------context : %s ----------------------
",(char*)ctx);
    printf("[demo-token-expired-callback] ----------------------token expired callback excited----------------
");
}
void demoInit(){
    //开始初始化。
    printf("start init sdk
");                   
    AliNetworkDiagConfig& config = AliNetworkDiagConfig::getNetworkDiagConfig();

    //必填，接入端应用的密钥。
    config.setSecKey("{your_secret_key}"); 

    //可选，设置设备ID。     
    config.setDeviceId("{your_device_id}");

    //可选，设置用户自定义拓展信息，用于业务自定义标识。
    std::map mp;
    mp.insert(make_pair("key", "value"));
    config.setExtension(mp);                    

    //设置最大并发线程数。
    config.setThreadPool(20);    

    //设置日志回调。               
    config.setLogback(logcallback);//默认输出log_debug及以上等级的日志
  	config.setLogCallback(logcallback, Log_Level::log_error);//设置日志输出最低等级

    //设置token失效回调，支持携带自定义参数
    config.setTokenExpiredCallback(on_token_ex);
  	//或
    const char* s = "it's user's context";
    config.setTokenExpiredCallback(on_token_ex_ctx, (void*)s);
  
    //初始化SDK。
    config.init();

    //或者预初始化SDK。
    config.preInit();
    
    //初始化完成。
    printf("end init sdk
");            
}

// 请求AccessKey信息。
void requestAccessKey() {
    // 推荐您先使用移动端日志直传服务配置AccessKey信息。
    // ...

    // 获取AccessKey信息后，完成更新。
    updateAccessKey(accessKeyId, accessKeySecret, securityToken);
}

// 更新AccessKey信息。
void updateAccessKey(std::string accessKeyId, std::string accessKeySecret, std::string securityToken) {
    // 通过STS服务获取的AccessKey包含securitToken，需要使用以下方式更新。
    config.setSlsCredential(accessKeyId, accessKeySecret, securityToken);
}

重要参数说明如下表所示。

字段	是否必填	说明
SecKey	是	接入端应用的密钥。更多信息，请参见创建接入端应用。

扩展功能

处理AccessKey失效

在初始化SDK配置AccessKey时，如果AccessKey是通过STS方式获取到的，则AccessKey可能会面临失效的问题。在AccessKey失效时，SDK支持通过配置回调的方式来接收AccessKey失效信息。

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];
      
	      //更新凭证信息。
	      [[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

/// 
/// 设置回调。
/// 
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
");
}

主动探测

SDK 支持 PING、TCPPING、HTTP、MTR、DNS等多种探测方式的主动发起。您可以调用以下API发起主动探测。

PING

iOS SDK

SLSPingRequest *request = [[SLSPingRequest alloc] init];
request.domain = @"www.aliyun.com";
//可选参数。
request.context = @"";
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.aliyun.com";
//可选参数。
request.multiplePortsDetect = true; //启用多网卡探测。
request.context = "";
//可选参数，设置当次网络探测的扩展业务参数。
request.extension = new HashMap() {
    {
        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.baidu.com";
//可选参数。
request.context = "your ping request context id";

Unity4SLS.Ping(request);

Windows SDK

//必选，初始化探测参数(任务ID（可为空字符串）、探测目标、DNS解析（0~3分别代表v4优先、v6优先、v4 only、v6 only）、探测端口）。
PingConfig* pingConfig = new PingConfig("0", "ping", "www.baidu.com", 0, 80);
//可选，修改探测目标。
pingConfig->setTarget("www.taobao.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(context);
    printf("[探测结果回调 demo-ping-callback] %s, context : %s
", json_result, ctx->c_str());
}

TCPPING

iOS SDK

SLSTcpPingRequest *request = [[SLSTcpPingRequest alloc] init];
request.domain = @"www.aliyun.com";
request.port = 80;
//可选参数。
request.context = @"";
//可选参数。
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.aliyun.com";
request.port = 80;
//可选参数。
request.context = "";
//可选参数，设置当次网络探测的扩展业务参数。
request.extension = new HashMap() {
    {
        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.baidu.com";
request.port = 80;
//可选参数。
request.context = "your tcpping request context id";

Unity4SLS.TcpPing(request);

Windows SDK

//必选，初始化探测参数(任务ID（可为空字符串）、探测目标、DNS解析（0~3分别代表v4优先、v6优先、v4 only、v6 only）、探测端口）
TcppingConfig* tcppingConfig = new TcppingConfig("", "www.baidu.com", 1, 80);
//可选，修改探测目标。
tcppingConfig->setTarget("www.taobao.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(context);
    printf("[探测结果回调 demo-tcpping-callback] %s, context : %s
", json_result, ctx->c_str());
}

HTTP

iOS SDK

SLSHttpRequest *request = [[SLSHttpRequest alloc] init];
request.domain = @"https://demo.ne.aliyuncs.com";
//可选参数。
request.context = @"";
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 = "";
request.headerOnly = true;
request.downloadBytesLimit = 1024;
//可选参数，证书检验回调。getSSLContext的配置参考下文。
request.credential = new HttpCredential(getSSLContext(context), null);
//可选参数，设置当次网络探测的扩展业务参数。
request.extension = new HashMap() {
    {
        put("custom_key", "custom_value");
    }
};

request.domain = "https://www.aliyun.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.baidu.com";
//可选参数。
request.context = "";
request.headerOnly = true;
request.downloadBytesLimit = 1024;

Unity4SLS.Http(request);

Windows SDK

//必选，初始化探测参数(任务ID，探测目标，DNS解析（0~3分别代表v4优先、v6优先、v4 only、v6 only）)
HttpDetectionConfig* httpConfig = new HttpDetectionConfig("", "http://www.baidu.com", 1);
//可选，修改探测目标。
httpConfig->setTarget("http://www.taobao.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(context);
    printf("[探测结果回调 demo-http-callback] %s, context : %s
", json_result, ctx->c_str());
}

MTR

iOS SDK

SLSMtrRequest *request = [[SLSMtrRequest alloc] init];
request.domain = @"www.aliyun.com";
//可选参数。
request.context = @"";
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.aliyun.com";
//可选参数。
request.protocol = Protocol.ICMP;
request.context = "";
//可选参数，设置当次网络探测的扩展业务参数。
request.extension = new HashMap() {
    {
        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.baidu.com";
//可选参数。
request.context = "your mtr request context id";

Unity4SLS.Mtr(request);

Windows SDK

//必选，初始化探测参数。
MtrDetectionConfig* mtrConfig = new MtrDetectionConfig("", "www.taobao.com", "ICMP", 1);
//可选，修改探测目标。
mtrConfig->setTarget("www.taobao.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(context);
    printf("[探测结果回调 demo-mtr-callback] %s, context : %s
", json_result, ctx->c_str());
}

DNS

iOS SDK

SLSDnsRequest *request = [[SLSDnsRequest alloc] init];
request.domain = @"www.aliyun.com";
//可选参数。
request.context = @"";
//可选参数。
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.aliyun.com";
//可选参数。
request.context = "";
//可选参数，设置当次网络探测的扩展业务参数。
request.extension = new HashMap() {
    {
        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.baidu.com";
// 可选参数。
request.context = "your dns request context id";

Unity4SLS.Dns(request);

Windows SDK

//必选，初始化探测参数。
DnsDetectionConfig* dnsConfig = new DnsDetectionConfig("", "www.aliyun.com", 2000, 0, "223.5.5.5", "A");
//可选，修改探测目标。
dnsConfig->setTarget("www.taobao.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(context);
    printf("[探测结果回调 demo-dns-callback] %s, context : %s
", json_result, ctx->c_str());
}

UDP

Windows SDK

//必选，初始化探测参数，"7564"为UDP报文负载
UdpConfig* udpConfig = new UdpConfig("0", "udp", "www.baidu.com", 0, 4000, "7564"); 
//可选，修改探测目的
udpConfig->setTarget("www.taobao.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(context);
    printf("[探测结果回调 demo-udp-callback] %s, context : %s
", json_result, ctx->c_str());
}

更新扩展业务字段

SDK支持在任何时机更新扩展业务字段。更新后的扩展业务字段仅对新产生的探测数据生效。

例如，应用初始化的时候可能未获取到用户ID，可以在用户登录成功后通过此接口更新，传入的key需设置为userId。

iOS SDK

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

Android SDK

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

Unity

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

Unity4SLS.UpdateExtensions(extensions);

Windows SDK

//获取配置类。
AliNetworkDiagConfig& config = AliNetworkDiagConfig::getNetworkDiagConfig();

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

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

配置策略下发域名

一般情况下无需调用此接口，仅当不希望直连阿里云IP地址时，通过这个接口可以套一层域名。

重要

如果要使用该功能，需在SDK初始化之前完成设置。

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");

配置证书校验全局回调

当时HTTP探测，且为控制台下发的策略出发的探测时，支持通过全局回调函数来获取凭证。

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

隐私合规

通过SDK发起网络探测请求后，SDK会采集网络信息、App信息、设备信息等。这些信息中主要包含：

用户设备出口IP、设备私网IP
App版本号信息
系统类型及版本号信息
设备型号

为了保障您的App顺利通过监管机构的合规检测，SDK提供了合规使用方案。

第一步：确保您的App有《隐私政策》，并且在用户首次启动App时弹出《隐私政策》取得用户同意。

第二步：务必告知用户您选择使用日志服务（SLS）SDK，请在《隐私政策》增加如下参考条款：

使用SDK名称：日志服务（SLS）SDK。
服务类型：网络质量数据分析。
手机个人信息类型：设备出口IP、私网 IP，App版本号信息，系统类型及版本号信息，设备型号信息等。
隐私权政策链接：日志服务（SLS）SDK隐私权政策

第三步：务必做SDK延迟初始化配置，确保用户同意《隐私政策》之后，再初始化SDK。

为保证您正在集成SDK之后，能够满足工信部相关合规要求，您应确保在App安装后首次冷启动时按照如下方式进行SDK的初始化。

在合适的位置调用预初始化函数（可参考上文SDK接入章节）。预初始化函数不会采集设备信息。

iOS SDK

// 预初始化，功能可正常使用，但敏感信息不会采集
[[SLSCocoa sharedInstance] preInit:credentials configuration:configuration];

Android SDK

// 预初始化，功能可正常使用，但敏感信息不会采集
SLSAndroid.preInit(this, credentials, optionConfiguration);

Windows SDK

void demoPreInit(){
    //开始初始化。
    printf("start preInit sdk
");                   
    AliNetworkDiagConfig& config = AliNetworkDiagConfig::getNetworkDiagConfig();
  	//设置其他参数...

    //预初始化SDK，功能可正常使用，但敏感信息不会采集
    config.preInit();
    
    //初始化完成。
    printf("end preInit sdk
");            
}

确保App首次冷启动时，在用户阅读您的《隐私政策》并取得用户授权之后，才调用正式初始化函数。正式初始化函数调用后，SDK会采集设备IP、设备型号等相关信息。如果用户不同意《隐私政策》授权，则不能调用正式初始化函数。
iOS SDK
```
[[SLSCocoa sharedInstance] initialize:credentials configuration:configuration];
```
Android SDK
```
SLSAndroid.initialize(context, credentials, optionConfiguration)
```

内容没看懂？不太想学习？想快速解决？有偿解决：联系专家

阿里云企业补贴进行中：马上申请

腾讯云限时活动1折起，即将结束：马上收藏

 同尘科技为腾讯云授权服务中心。

购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠

转转请注明出处：https://www.yunxiaoer.com/163054.html

阿里云日志服务SLSSDK插件使用说明-云淘科技

SDK接入

iOS SDK接入

Android SDK接入

Unity插件接入

Windows SDK接入

下载地址

SDK初始化

扩展功能

处理AccessKey失效

iOS SDK

Android SDK

Unity

Windows SDK

主动探测

PING

iOS SDK

Android SDK

Unity

Windows SDK

TCPPING

iOS SDK

Android SDK

Unity

Windows SDK

HTTP

iOS SDK

Android SDK

Unity

Windows SDK

MTR

iOS SDK

Android SDK

Unity

Windows SDK

DNS

iOS SDK

Android SDK

Unity

Windows SDK

UDP

Windows SDK

更新扩展业务字段

iOS SDK

Android SDK

Unity

Windows SDK

配置策略下发域名

iOS SDK

Android SDK

Unity

Windows SDK

配置证书校验全局回调

iOS SDK

Android SDK

隐私合规

第一步：确保您的App有《隐私政策》，并且在用户首次启动App时弹出《隐私政策》取得用户同意。

第二步：务必告知用户您选择使用日志服务（SLS）SDK，请在《隐私政策》增加如下参考条款：

第三步：务必做SDK延迟初始化配置，确保用户同意《隐私政策》之后，再初始化SDK。

iOS SDK

Android SDK

Windows SDK

iOS SDK

Android SDK

联系我们

400-800-8888