6.7.1 收集日志
1.CSSDK拥有自己的日志文件SdkApi.log,它记录了您调用SDK接口的详细过程,以及更详细的错误结果。 集成的时候可以简单查看SdkApi.log中的日志来确认,如果无法定位问题,请及时反馈给我们。 对于日志所在目录: Windows平台:
%appdata%/Sangfor/aTrust/logs/SdkApi.log
Mac平台:
~/Library/Application\ Support/aTrust/logs
信创平台:
${HOME}/.aTrust/logs/SdkApi.log
2.由于CSSDK通过aTrust客户端实现真正的业务流程,因此aTrust客户端的日志也同样重要。使用收集日志接口可以将当前已经记录的上述两种日志进行打包,并返回搜集完成的日志压缩包路径。
3.当您与CSSDK集成相关的业务出现问题的时候,强烈建议集成日志收集接口,用于aTrust客户端使用过程中出现问题之后能够收集客户端全量日志定位问题。避免需要人工去对应目录下再去收集日志。
接口定义
atrust_error_code ATRUST_API atrust_collect_log(atrust_collect_log_data* data);
参数和返回值说明
参数名 | 类型 | 出参/入参 | 必须 | 说明 |
---|---|---|---|---|
data | atrust_collect_log_data | in | 是 | 日志收集数据 |
示例代码
atrust_collect_log_data data;
atrust_error_code ec = atrust_collect_log(&data);
switch (ec) {
// 成功
case atrust_error_code::OK:
// 日志导出成功!请前往以下路径获取日志文件:data.log_path
return;
case atrust_error_code::ATRUST_CONNECT_ERROR:
// aTrust客户端连接失败!如果重试任然失败,请检查aTrust客户端是否正确安装并运行。
return;
// 未知的业务执行过程失败
default:
// 接口调用失败!请在atrust_code.h中检查错误码,或尝试重试。错误码:ec
return;
}
6.7.2 错误码汇总
错误码 | KEY | 描述 |
---|---|---|
0 | OK | 操作成功 |
20002 | ATRUST_CONNECT_ERROR | 本地aTrustAgent服务连接错误,可能没有安装aTrust客户端 |
注意:除了上述错误码处理,你仍需要处理未知错误码场景。