回捞支持日志回捞和自定义回捞，通过打印自定义日志和业务自定义文件，帮助单点追查和定位问题。日志文件在本地加密、压缩保存时，利用系统mmap机制保证日志写入的效率，且支持根据日志等级写入文件。 ## 使用场景 * 初始化时打开日志回捞功能，业务通过指定类打印自定义日志，日志会保存在本地磁盘。 * 日志查询通过采样上报性能和交互数据，且采样率一般较低，出现问题进行排查时无法查到对应的日志。为了解决这个问题，SDK内置了APMPlus日志，通过自定义日志全量采集核心数据保存在本地。您可以通过回捞的形式获取日志，辅助分析无用户数据的性能问题和特殊的退出问题。 ## 使用限制 APMPlus日志支持的模块如列表所示： * Android端 * 交互：启动日志、页面加载、用户使用时长、网络分析、事件。 * 稳定性：应用退出、自定义异常、崩溃、Dart异常。 * 性能：CPU、内存。 * iOS端 * 启动耗时、页面加载耗时、网络耗时、事件埋点、自定义异常、CPU指标、内存指标、FPS、丢帧。 :::tip Harmony系统仅支持**自定义日志**类型，不支持 APMPlus日志。 ::: ## 任务的触发条件以下条件满足一个即可触发回捞任务： * 网络良好，重新启动App * 网络良好，前后台切换 * 网络良好，APP保持运行状态，会定时触发（5分钟内） ## 日志回捞 ### 前提条件 * 已接入日志回捞。iOS端请参见[日志回捞](https://www.volcengine.com/docs/6431/1175759#5e60c23f)，Android端请参见[日志回捞](https://www.volcengine.com/docs/6431/1175079#1dc51677)，Harmony端请参见[回捞](https://www.volcengine.com/docs/6431/1264701#f1c76fdc)。 * 已配置崩溃分析。详情请参见[SDK上报配置](https://www.volcengine.com/docs/6431/126085)。 ### 新建日志回捞任务 1. 登录[应用性能监控全链路版控制台](https://console.volcengine.com/apmplus)。 2. 在顶部导航栏，选择目标地域。 3. 在左侧目录选择**客户端监控**，然后查找并单击目标应用名称。 4. 单击目标应用下的**App端监控**。 5. 在控制台左上角选择**全部功能 \> 回捞**，然后单击**新建任务**。 6. 在**新建任务**页面，完成以下配置，然后单击**保存**。 ![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/84afd858a1254f9ca03eae88e7f7ec08~tplv-goo7wpa0wc-image.image =700x) |**配置区域** |**参数** |**说明** | |---|---|---| |基本信息 |任务名称 |自定义名称，用于标识该任务。 | |^^|系统 |选择操作系统，支持Android、iOS和Harmony。 | |^^|任务说明 |填写任务说明，例如该任务的使用场景。 | |任务配置 |回捞类型 |选择回捞类型：日志回捞。|\ | | |日志回捞是回捞端上打印的自定义日志。 | |^^|日志类型 |* APMPlus日志：APMPlus SDK内置打点的异常、性能、网络、事件等日志数据|\ | | |* 自定义日志：业务自己打点的日志数据|\ | | ||\ | | |:::tip|\ | | |为Harmony系统创建日志回捞任务时，日志类型仅支持自定义日志。|\ | | ||\ | | |:::| |^^|拉取时间范围 |配置需要拉取日志文件所在的时间范围。 | |^^|设备选择 |配置需要拉取哪个设备的日志文件。支持根据**DID**和**UID**设置目标设备。|\ | | |:::tip|\ | | |DID和UID的取值应和初始化的SDK配置保持一致。|\ | | ||\ | | |:::| |通知配置 |飞书webhook |如果想在任务完成时，有飞书消息通知，请输入飞书webhook。|\ | | |仅支持添加一个地址。 | |^^|企业微信webhook |如果想在任务完成时，有企业微信消息通知，请输入企业微信webhook。|\ | | |仅支持添加一个地址。 | |^^|钉钉webhook |如果想在任务完成时，有钉钉消息通知，请输入钉钉webhook。|\ | | |仅支持添加一个地址。 | |^^|邮件通知组 |如果想在任务完成时，有邮件通知，请从下拉列表中选择目标接收组。您也可以新建接收组并添加邮件地址。|\ | | |在接收组中可以添加多个邮件地址。 | ### 查看自定义日志 1. 登录[应用性能监控全链路版控制台](https://console.volcengine.com/apmplus)。 2. 在顶部导航栏，选择目标地域。 3. 在左侧目录选择**客户端监控**，然后查找并单击目标应用名称。 4. 单击目标应用下的**App端监控**。 5. 在控制台左上角选择**全部功能 \> 回捞**。 6. 在**回捞**页面，在任务列表中找到目标任务名称，然后单击**任务详情**。 ![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/e03616f0cbd641bca4b6646ab617daaf~tplv-goo7wpa0wc-image.image =800x) * 设备：如果是一次拉取多个用户，可以通过设备筛选不同的用户。 * 任务信息：展示了任务概要信息，包括任务名称、创建人、执行时间、任务进度、回捞范围等任务信息。 * 日志列表： * 支持根据时间、日志关键词、日志级别和日志类型筛选日志。 :::tip Harmony系统日志回捞仅支持**业务日志**类型。 ::: * 支持在线查看日志，也可以下载日志文件到本地。 ## 自定义回捞 ### 前提条件 * 已接入自定义回捞。iOS端请参见[自定义回捞](https://www.volcengine.com/docs/6431/1175759#601121a2)，Android端请参见[自定义回捞](https://www.volcengine.com/docs/6431/1175079#f076a974)。 * 已配置自定义文件。详情请参见[SDK上报配置](https://www.volcengine.com/docs/6431/126085)。 ### 新建自定义回捞任务 1. 登录[应用性能监控全链路版控制台](https://console.volcengine.com/apmplus)。 2. 在顶部导航栏，选择目标地域。 3. 在左侧目录选择**客户端监控**，然后查找并单击目标应用名称。 4. 单击目标应用下的**App端监控**。 5. 在控制台左上角选择**全部功能 \> 回捞**，然后单击**新建任务**。 6. 在**新建任务**页面，完成以下配置，然后单击**保存**。 |**配置区域** |**参数** |**说明** | |---|---|---| |基本信息 |任务名称 |自定义名称，用于标识该任务。 | |^^|系统 |选择操作系统。|\ | | ||\ | | |* Android和iOS系统支持创建自定义回捞任务。|\ | | |* Harmony系统不支持创建自定义回捞任务。 | |^^|任务说明 |填写任务说明，例如该任务的使用场景。 | |任务配置 |回捞类型 |选择回捞类型：自定义回捞。|\ | | |自定义回捞下发业务配置的命令，业务接收命令后返回自定义的文件，平台可以下载自定义的文件排查问题。 | |^^|回捞参数 |配置回捞参数。详情请参见[iOS自定义回捞配置](https://www.volcengine.com/docs/6431/1175759#601121a2)和[安卓自定义回捞配置](https://www.volcengine.com/docs/6431/1175079#f076a974)。|\ | | |Android端输入只支持JSON格式，SDK接入方自主设置代码解析。 | |^^|设备选择 |配置需要拉取哪个设备的日志文件。支持根据**DID**和**UID**设置目标设备。|\ | | |:::tip|\ | | |DID和UID的取值应和初始化的SDK配置保持一致。|\ | | ||\ | | |:::| |通知配置 |飞书webhook |如果想在任务完成时，有飞书消息通知，请输入飞书webhook。|\ | | |仅支持添加一个地址。 | |^^|企业微信webhook |如果想在任务完成时，有企业微信消息通知，请输入企业微信webhook。|\ | | |仅支持添加一个地址。 | |^^|钉钉webhook |如果想在任务完成时，有钉钉消息通知，请输入钉钉webhook。|\ | | |仅支持添加一个地址。 | |^^|邮件通知组 |如果想在任务完成时，有邮件通知，请从下拉列表中选择目标接收组。您也可以新建接收组并添加邮件地址。|\ | | |在接收组中可以添加多个邮件地址。 | ### 查看自定义文件 1. 登录[应用性能监控全链路版控制台](https://console.volcengine.com/apmplus)。 2. 在顶部导航栏，选择目标地域。 3. 在左侧目录选择**客户端监控**，然后查找并单击目标应用名称。 4. 单击目标应用下的**App端监控**。 5. 在控制台左上角选择**全部功能 \> 回捞**。 6. 在**回捞**页面，在任务列表中找到目标任务名称，然后单击**任务详情**。 ![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/7fda43a1fab5443399a423f02a43ed08~tplv-goo7wpa0wc-image.image =800x) * 设备：如果是一次拉取多个用户，可以通过设备筛选不同的用户。 * 任务信息：展示了任务概要和自定义日志，可以在线查看，也可以下载日志到本地分析。 * 回捞内容： * 回捞文件`common_params.txt`：端上的基础参数文件 * 回捞文件`files-cloudMsg.zip`：端上业务自己返回的文件 * 字符串：端上业务自己返回的回捞内容 ## 查看任务列表 ### 列表说明新建任务后，可以在列表中查看到当前正在执行的任务。 ![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/1580b57ce60748d38a028d8e64eb4a40~tplv-goo7wpa0wc-image.image =800x) 任务列表中展示任务名称、日志类型、创建人、创建时间、任务进度。 * **任务进度**：表明了当前任务所处的状态。 * **完成**：单击**任务详情**查看详细的日志信息分析问题。 * **失败**：获取日志失败，详情页面有具体失败原因。 * **未下发**：处于App尚未拉取到命令的状态。 * **任务详情**：单击进入**任务详情**页，查看任务信息和日志列表。 * **创建副本**：单击进入**新建任务**页，在原任务的配置上进行编辑，然后生成新的任务。 * **编辑**：单击进入**编辑任务**页，在原任务的配置上进行编辑，修改原来的任务。 * **删除**：删除该日志回捞任务。 ### 异常排查如果任务一直处于未下发状态，可能是SDK上报参数和日志回捞设置不匹配导致。请执行以下步骤排查： 1. 检查控制台和SDK设置的UID/DID是否一致。在**日志回捞**页面，单击**任务详情**，检查设备是否带标识。 * DID：不带标识，显示为*设备名称*。 * UID：带标识，显示为*设备名称*（uid）。 ![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/799eb2bc966e4f37b2266b3c14f18c87~tplv-goo7wpa0wc-image.image =400x) 比较控制台设置的UID/DID和SDK是否一致： * 一致：请执行步骤2。 * 不一致：请修改一致后再执行步骤2。修改SDK配置，请参见[如何在SDK中配置DID和UID？](https://www.volcengine.com/docs/6431/129435)。 2. 通过抓包确认控制台上设备的取值和SDK配置是否一致。抓包路径：https://apmplus.volces.com/monitor/collect/c/cloudcontrol/get。比较抓包信息中请求携带的UID/DID和控制台是否一致： * 一致：任务进度仍为**未上报**，请提交工单反馈。 * 不一致：在**日志回捞**页面编辑修改或者修改SDK配置。修改SDK配置，请参见[如何在SDK中配置DID和UID？](https://www.volcengine.com/docs/6431/129435)。