Flutter日志记录与错误追踪插件hemend_sentry_log_recorder的使用

hemend_sentry_log_recorder 是一个用于在 Flutter 应用中记录日志并进行错误追踪的插件。它基于 Hemend Async Log Recorder 和 Sentry，能够将应用的日志信息发送到 Sentry 平台，帮助开发者快速定位和解决应用中的问题。

使用步骤

1. 添加依赖

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

dependencies:
  hemend_sentry_log_recorder: ^1.0.0  # 确保使用最新版本

然后运行 flutter pub get 安装依赖。

2. 初始化插件

在应用启动时初始化 hemend_sentry_log_recorder 和 Sentry。首先，确保已经在 pub.dev 上注册了 Sentry，并获取了 DSN（数据源名称）。

import 'package:flutter/material.dart';
import 'package:hemend_sentry_log_recorder/hemend_sentry_log_recorder.dart';
import 'package:sentry_flutter/sentry_flutter.dart';

void main() async {
  // 初始化 Sentry
  await SentryFlutter.init(
    (options) {
      options.dsn = 'YOUR_SENTRY_DSN'; // 替换为你的 Sentry DSN
    },
    appRunner: () => runApp(MyApp()),
  );
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(),
    );
  }
}

3. 配置日志记录器

接下来，配置 Logger 来使用 hemend_sentry_log_recorder 插件。

import 'package:logger/logger.dart';
import 'package:hemend_sentry_log_recorder/hemend_sentry_log_recorder.dart';

final logger = Logger(
  printer: PrettyPrinter(), // 可选，用于格式化日志输出
);

void setupLogging() {
  // 初始化 Hemend Sentry Log Recorder
  HemendSentryLogRecorder.setup(
    levelFilter: LevelFilter.all, // 记录所有级别的日志
    sentryClient: Sentry.getCurrentHub().getClient(), // 使用当前 Sentry 客户端
  );

  // 将 Logger 的输出重定向到 Sentry
  logger.onRecord.listen((record) {
    HemendSentryLogRecorder.log(record);
  });
}

4. 记录日志和捕获错误

在应用中记录日志并捕获异常。例如，在按钮点击事件中记录日志或模拟错误。

class HomeScreen extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Hemend Sentry Log Recorder Demo'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            // 记录普通日志
            logger.i('这是一条信息日志');

            // 模拟错误并记录
            try {
              throw Exception('这是一个测试异常');
            } catch (e, stackTrace) {
              logger.e(e.toString(), e, stackTrace);
            }
          },
          child: Text('记录日志并触发错误'),
        ),
      ),
    );
  }
}

更多关于Flutter日志记录与错误追踪插件hemend_sentry_log_recorder的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

yibo5220 1楼•5 天前

更多关于Flutter日志记录与错误追踪插件hemend_sentry_log_recorder的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

hemend_sentry_log_recorder 是一个 Flutter 插件，它结合了日志记录和错误追踪功能，并将日志和错误信息发送到 Sentry 平台。Sentry 是一个流行的错误追踪和监控工具，可以帮助开发者捕获、记录和分析应用程序中的错误和异常。

以下是如何在 Flutter 项目中使用 hemend_sentry_log_recorder 插件的详细步骤：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 hemend_sentry_log_recorder 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  hemend_sentry_log_recorder: ^latest_version

然后运行 flutter pub get 来获取依赖。

2. 初始化插件

在你的 Flutter 应用程序中，通常是在 main.dart 文件中，初始化 hemend_sentry_log_recorder 插件。你需要提供 Sentry 的 DSN（Data Source Name），这是 Sentry 用于识别项目的唯一标识符。

import 'package:hemend_sentry_log_recorder/hemend_sentry_log_recorder.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化 Sentry
  await HemendSentryLogRecorder.initialize(
    dsn: 'https://your-sentry-dsn@your-sentry-project-id.ingest.sentry.io/your-sentry-project-id',
    environment: 'production', // 可选：设置环境
    release: '1.0.0', // 可选：设置发布版本
  );

  runApp(MyApp());
}

3. 记录日志

你可以使用 HemendSentryLogRecorder 提供的 log 方法来记录日志。日志级别可以是 debug、info、warning、error 或 fatal。

HemendSentryLogRecorder.log(
  level: SentryLevel.info,
  message: 'This is an info log message',
  logger: 'MyLogger',
  tags: {'tag1': 'value1'}, // 可选：添加标签
  extra: {'key': 'value'}, // 可选：添加额外信息
);

4. 捕获异常

你可以使用 HemendSentryLogRecorder 提供的 captureException 方法来捕获并发送异常到 Sentry。

try {
  // 可能会抛出异常的代码
} catch (e, stackTrace) {
  HemendSentryLogRecorder.captureException(
    exception: e,
    stackTrace: stackTrace,
    tags: {'tag1': 'value1'}, // 可选：添加标签
    extra: {'key': 'value'}, // 可选：添加额外信息
  );
}

5. 设置用户信息（可选）

你可以通过 HemendSentryLogRecorder 设置用户信息，这样在 Sentry 中可以看到哪个用户触发了错误。

HemendSentryLogRecorder.setUser(
  id: '12345',
  email: 'user@example.com',
  username: 'johndoe',
  ipAddress: '127.0.0.1', // 可选：设置用户 IP 地址
);

6. 处理未捕获的异常（可选）

你可以设置一个全局的异常处理程序，以便在应用程序崩溃时自动捕获未处理的异常并发送到 Sentry。

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await HemendSentryLogRecorder.initialize(
    dsn: 'https://your-sentry-dsn@your-sentry-project-id.ingest.sentry.io/your-sentry-project-id',
    environment: 'production',
    release: '1.0.0',
  );

  // 设置全局异常处理
  FlutterError.onError = (FlutterErrorDetails details) {
    HemendSentryLogRecorder.captureException(
      exception: details.exception,
      stackTrace: details.stack,
    );
  };

  runApp(MyApp());
}

7. 调试和测试

在开发过程中，你可以通过设置 debug 参数来启用调试模式，这样可以在控制台中看到 Sentry 发送的日志和错误信息。

await HemendSentryLogRecorder.initialize(
  dsn: 'https://your-sentry-dsn@your-sentry-project-id.ingest.sentry.io/your-sentry-project-id',
  environment: 'production',
  release: '1.0.0',
  debug: true, // 启用调试模式
);