Flutter AWS CloudWatch集成插件aws_cloudwatch的使用

aws_cloudwatch 插件概览

aws_cloudwatch 是一个简单、轻量级且即插即用的解决方案，用于与AWS CloudWatch进行日志记录。它允许开发者轻松地将应用程序的日志发送到AWS CloudWatch，以便于监控和故障排查。

关键特性

• 简易集成：只需几行代码即可开始发送日志。
• 自动创建日志组和流：无需预先配置，库会自动处理这些细节。
• 支持临时凭证：可以使用带有会话令牌的临时凭证进行身份验证。
• 错误捕捉：能够捕获未处理的Flutter错误并将其发送到CloudWatch。
• 灵活配置：提供多种参数以适应不同的网络状况和性能需求。

快速入门

添加依赖项

在你的pubspec.yaml文件中添加以下依赖：

dependencies:
  aws_cloudwatch: ^latest_version # 替换为最新版本号

然后运行 flutter pub get 来安装插件。

初始化CloudWatch实例

在应用中引入必要的包，并根据需要填写AWS访问密钥和其他信息：

import 'package:aws_cloudwatch/aws_cloudwatch.dart';
import 'package:intl/intl.dart';

const String _awsAccessKeyId = 'YOUR_ACCESS_KEY';
const String _awsSecretAccessKey = 'YOUR_SECRET_ACCESS_KEY';
const String _region = 'YOUR_REGION_CODE'; // (us-west-1, us-east-2, etc)
const String _logGroup = 'DESIRED_LOG_GROUP_NAME';
const String _errorGroup = 'DESIRED_ERROR_LOG_GROUP_NAME';

CloudWatchHandler logging = CloudWatchHandler(
  awsAccessKey: _awsAccessKeyId,
  awsSecretKey: _awsSecretAccessKey,
  region: _region,
);

发送日志

定义一个简单的日志函数来发送消息：

String logStreamName = '';

String _getLogStreamName() {
  if (logStreamName.isEmpty) {
    logStreamName = DateFormat('yyyy-MM-dd HH-mm-ss').format(
      DateTime.now().toUtc(),
    );
  }
  return logStreamName;
}

void log(String logString, {bool isError = false}) {
  logging.log(
    message: logString,
    logGroupName: isError ? _errorGroup : _logGroup,
    logStreamName: _getLogStreamName(),
  );
}

现在你可以在任何地方调用 log('Your message here'); 来发送日志了！

捕获所有Flutter错误

为了确保所有的异常都能被捕获并发送给CloudWatch，你可以修改main.dart文件如下所示：

import 'dart:async';
import 'app.dart';
import 'errorLog.dart';

void main() {
  runZonedGuarded<Future<void>>(() async {
    final Function originalOnError = FlutterError.onError;
    FlutterError.onError = (FlutterErrorDetails errorDetails) async {
      Zone.current.handleUncaughtError(errorDetails.exception, errorDetails.stack);
      originalOnError(errorDetails);
    };
    runApp(MyApp());
  }, (dynamic error, stackTrace) async {
    logFlutterSystemError(error, stackTrace);
    print(error.toString());
    throw error;
  });
}

同时，在errorLog.dart中定义 logFlutterSystemError 方法：

void logFlutterSystemError(dynamic logString, dynamic stackTrace) {
  log(
    'Auto Captured Error: ${logString.toString()}\n\n'
    'Auto Captured Stack Trace:\n${stackTrace.toString()}',
    isError: true,
  );
}

这样，所有的未捕获异常都会被自动上传到AWS CloudWatch中的错误日志组。

注意事项

• Android权限：请确保在android/app/src/main/AndroidManifest.xml中添加了互联网权限。

  <uses-permission android:name="android.permission.INTERNET" />
  

• API速率限制：注意避免超过AWS CloudWatch API的速率限制（每秒5个请求）。可以通过调整delay参数来控制请求频率。

• 重试机制：设置合理的重试次数可以帮助应对偶尔的失败请求。

• DNS查找失败：默认情况下，DNS查找失败会被静默处理。如果遇到问题，请检查提供的区域名称是否有误。

• 日志组和流的命名规则：遵循AWS规定的命名格式，避免使用非法字符。

• 消息大小限制：对于过大的消息，可以选择分页或截断的方式处理。

通过以上步骤，你应该能够在Flutter项目中顺利集成并使用aws_cloudwatch插件了。如果有任何疑问或者特殊需求，欢迎随时查阅官方文档或提交Issue寻求帮助。