HarmonyOS NEXT (beta)客户端诊断

本文介绍了鸿蒙客户端诊断日志的写入及上报触发方式。

使用客户端诊断 API

工程引入依赖:@mpaas/trace-log,版本参考开发指南 基于已有工程使用 ohpmrc 接入

使用 API 的参考示例代码如下:

import {createLogger} from '@mpaas/trace-log';

export default class MPLog {

  private static DOMAIN : number = 0x0011;
  private static TAG: string = 'BizCustomTag';

  static info(msg: string): void {
    const logger = createLogger();
    logger.info(MPLog.DOMAIN, MPLog.TAG, msg);
  }

  static warn(msg: string): void {
    const logger = createLogger();
    logger.warn(MPLog.DOMAIN, MPLog.TAG, msg);
  }

  static error(msg: string, error?: Error): void {
    const logger = createLogger();
    if (!error) {
      logger.error(MPLog.DOMAIN, MPLog.TAG, msg);
    } else {
      logger.error(MPLog.DOMAIN, MPLog.TAG, msg + ' ' + error.message + ' ' + error.stack ?? '');
    }
  }
}

接入客户端诊断

支持通过后台推送消息的方式触发诊断日志上报的功能,用户需要接入后台推送的功能,推送 SDK 在收到上报诊断日志上报的指令后,将诊断日志上报到服务端,可参考消息推送接入 HarmonyOS NEXT(beta)的使用 SDK 文档来配置透传消息 Ability。

接入透传消息 Ability 后,即可完成消息推送通道的客户端日志诊断的接入。

在控制台拉取日志

您可以在控制台拉取使用 mPaaS 的日志工具打印的日志,从而快速便捷地分析 App 在指定机型或用户上出现的崩溃或异常问题。

步骤 1:创建日志拉取任务

  1. 进入 mPaaS 控制台,选择目标应用。

  2. 在左侧导航栏中,单击 移动分析 > 日志管理

  3. 拉取实时日志 标签页中,单击 添加 按钮。

  4. 填写任务信息。其中,用户 ID 为您的应用登录系统中用户的标识。通过消息推送上报用户 ID 的方法设置。

  5. 单击 确认,完成日志拉取任务的创建。

步骤 2:触发日志拉取任务

  1. 在日志拉取任务列表中,找到刚刚创建的任务,选择 触发通道 ,然后单击 操作 列的 触发

  2. 稍等片刻刷新页面,若任务状态为:

    • 任务处理完成:单击 查看 按钮即可下载诊断日志。

    • 调用 Push 服务成功:表示已下发上传诊断日志的消息,但客户端还未收到或收到但未上传日志。 针对此情况,请确认您的 App 进程在系统中仍然存在;如果不存在请重启 App。