远程日志 API-移动研发平台(EMAS)-阿里云帮助中心

本文档介绍移动监控 Flutter SDK 提供的远程日志 API，包括记录日志、调整日志级别等接口。

1. 创建日志实例

创建指定模块的远程日志 logger 实例，用于记录日志。

接口定义

class RemoteLog {
  factory RemoteLog.create(String moduleName);
}

创建日志实例参数说明

参数	类型	是否必填	说明
moduleName	String	是	模块名称

代码示例

final logger = RemoteLog.create('checkout');

2. 记录日志

通过 RemoteLog 实例接口，记录不同日志级别的日志。

接口定义

class RemoteLog {
  Future<void> debug(String message, {Object? error, StackTrace? stackTrace});
  Future<void> info(String message, {Object? error, StackTrace? stackTrace});
  Future<void> warn(String message, {Object? error, StackTrace? stackTrace});
  Future<void> error(String message, {Object? error, StackTrace? stackTrace});
}

记录日志参数说明

参数	类型	是否必填	说明
message	String	是	记录日志消息
error	Object	否	异常对象
stackTrace	StackTrace	否	堆栈

代码示例

await logger.debug('checkout page opened');
await logger.info('order created');
await logger.warn('retry payment request');

try {
  throw StateError('payment failed');
} catch (error, stackTrace) {
  await logger.error(
    'submit order failed',
    error: error,
    stackTrace: stackTrace,
  );
}

3. 调整日志级别

通过 RemoteLog 类接口，调整日志记录级别，默认是调试级别。

接口定义

enum RemoteLogLevel { off, error, warn, info, debug }

class RemoteLog {
  static Future<RemoteLogLevel> updateLogLevel(RemoteLogLevel level);
}

RemoteLogLevel 枚举说明

参数	说明
off	关闭级别
error	错误级别
warn	警告级别
info	信息级别
debug	调试级别

代码示例

await RemoteLog.updateLogLevel(RemoteLogLevel.debug);

4. 主动上报日志

通过 RemoteLog 类接口，主动上报当天打印的日志。

接口定义

class RemoteLog {
  static Future<void> uploadLog(String bizComment);
}

主动上报参数说明

参数	类型	是否必填	说明
bizComment	String	是	备注

代码示例

await RemoteLog.uploadLog('order_submit_failed');