Unreal接入指引(Linux DS)
本文是介绍Linux DS平台的Unreal SDK详细文档，包含了基本的接入流程，和高级的接口使用介绍。
1 Unreal引擎接入方案
1.1 导入 CrashSight UE Plugin
1.2 将CrashSight加入依赖项
在项目主模块的Build.cs中添加：
PrivateDependencyModuleNames.AddRange(new string[] { "CrashSight" });
1.3 执行初始化
选择第一个场景，或者主场景（scene）， 在尽可能较早加载的脚本中调用如下代码进行初始化：#include "CrashSightAgent.h" //请包含该头文件
#if DEBUG
CrashSightAgent::ConfigDebugMode (true);
#endif
// 设置上报域名，请根据项目 发行需求进行填写。（必填）
CrashSightAgent::ConfigCrashServerUrl("UploadUrl");
// 设置上报所指向的APP ID、APP Key和版本号, 并进行初始化。APP ID和APP Key可以在管理端更多->产品设置->产品信息中找到。
CrashSightAgent::Init(CrashSightAppId, CrashSightAppKey, AppVersion);
国内公有云：pc.crashsight.qq.com
海外公有云：pc.crashsight.wetest.net
2 接口说明
2.1 初始化
static void InitWithAppId(const char* app_id);
| 参数 | 类型 | 说明 |
|---|---|---|
| app_id | const char* | 已注册项目的APP ID |
2.2 上报错误
static void ReportException(int type, const char* name, const char* reason, const char* stack_trace, const char* extras, bool quit, int dump_native_type = 0);
| 参数 | 类型 | 说明 |
|---|---|---|
| type | int | 异常类型, C#: 4, js: 5, lua: 6 |
| name | const char * | 异常名称 |
| reason | const char * | 异常信息 |
| stack_trace | const char * | 堆栈 |
| extras | const char * | 其他信息 |
| quit | bool | 是否退出 |
| dump_native_type | int | 无效，填0即可 |
页面查看：
extras：崩溃详情页->附件下载->extraMessage.txt
2.3 设置用户ID
static void SetUserId(const char* user_id);
| 参数 | 类型 | 说明 |
|---|---|---|
| user_id | const char * | 用户ID |
2.4 添加自定义数据
static void AddSceneData(const char* key, const char* value);
说明：设置用户自定义的 Key-Value 数据，将在发送 Crash 时随异常信息一起上报。总长度最多支持128k。
页面查看：崩溃详情页->附件下载->valueMapOthers.txt
| 参数 | 类型 | 说明 |
|---|---|---|
| key | const char * | 键 |
| value | const char * | 值 |
2.5 设置应用版本
static void SetAppVersion(const char* app_version);
说明：设置应用版本号
| 参数 | 类型 | 说明 |
|---|---|---|
| app_version | const char * | 版本号 |
2.6 上报域名设置
static void ConfigCrashServerUrl(const char* crash_server_url);
说明：设置上报域名。
备注：需要在Init接口之前调用。
上报域名如下：
国内公有云：pc.crashsight.qq.com
海外公有云：pc.crashsight.wetest.net
直接接入CrashSight域名与MSDK转接不同，请务必重新依照上述域名配置。其他环境域名请咨询接入接口人。
| 参数 | 类型 | 说明 |
|---|---|---|
| crash_server_url | const char * | 要上报的域名 |
2.7 设置上传日志路径
static void SetLogPath(const char* log_path);
说明：设置崩溃后上传的日志路径，需要可读权限。附件最大支持8MB。
| 参数 | 类型 | 说明 |
|---|---|---|
| log_path | const char * | 日志绝对路径 |
2.8 debug使能开关
static void ConfigDebugMode(bool enable);
说明：是否开启debug模式，默认为关。开启后会打印一定量的日志，但是可以方便测试期间的问题定位。
备注：需要在Init接口之前调用。
| 参数 | 类型 | 说明 |
|---|---|---|
| enable | bool | debug使能开关 |
2.9 设置设备ID
static void SetDeviceId(const char* device_id);
说明：设置设备ID，默认采用uuid作为设备ID
备注：需要在Init接口之前调用。
| 参数 | 类型 | 说明 |
|---|---|---|
| device_id | const char * | 设备ID |
2.10 自定义日志
static void PrintLog(LogSeverity level, const char* format, ...);
说明：自定义日志，限制30KB
| 参数 | 类型 | 说明 |
|---|---|---|
| level | LogSeverity | 日志级别 |
| format | const char * | 日志格式 |
| args | params object[] | 可变参数 |
自定义日志查看：问题详情->自定义日志（来自接口）
2.11 设置所有记录文件的路径
static void SetRecordFileDir(const char* record_dir);
说明：设 置所有记录文件的路径，包括SDK日志和dump文件，默认为当前可执行文件的目录下。
| 参数 | 类型 | 说明 |
|---|---|---|
| record_dir | const char* | 记录文件路径 |
3.上传符号表
以上内容介绍了SDK的接入方法和接口使用细节，但要在页面上看到可读的还原堆栈，还需要上传对应的符号表。
3.1 所需文件
Unreal打包前须勾选 文件-打包项目-打包设置【包括调试文件】，上传符号表需要2个文件：
3.2 流水线插件上传符号表
DS项目目前只支持蓝盾流水线上传符号表，请搜索并添加CrashSight符号表上传工具，并根据以下指示进行配置：