Flutter错误追踪插件groveman_sentry的使用

Flutter错误追踪插件groveman_sentry的使用

Groveman Sentry

它将您的日志发送到Sentry。

这与sentry-dart和sentry-flutter完美配合使用。

使用

在您的pubspec.yaml文件中添加依赖项：

dependencies:
  groveman:
  groveman_sentry:
  sentry: 
  // 或者
  sentry_flutter: 

在您想要使用它的位置导入它，例如在主文件中：

import 'package:groveman/groveman.dart';
import 'package:groveman_sentry/groveman_sentry.dart';

初始化Sentry并在应用程序启动时插入SentryTree：

import 'package:flutter/widgets.dart';
import 'package:groveman/groveman.dart';
import 'package:groveman_sentry/groveman_sentry.dart';
import 'package:sentry_flutter/sentry_flutter.dart';

void main() {
  Groveman.plantTree(DebugTree());
  Groveman.captureErrorInZone(() async {
    WidgetsFlutterBinding.ensureInitialized();
    await SentryFlutter.init(
      (options) {
        options.dsn = 'https://example@sentry.io/add-your-dsn-here';
      },
    );    
    if (kReleaseMode) {
      Groveman.plantTree(SentryTree());
    }
    Groveman.captureErrorInCurrentIsolate();
    runApp(const MyApp());
  });
}

通常，您只在生产环境中发送日志。

默认情况下，日志级别info、warning、error和fatal会被发送到Sentry。

Groveman.error(message, error: exception);

如果LogRecord.error不为空，则会通过captureEvent发送，否则使用addBreadcrumb。

LogRecord转换为SentryEvent：

• LogRecord.level -> SentryLevel
• LogRecord.message -> SentryMessage(message)
• LogRecord.extra -> extra
• LogRecord.error -> throwable
• LogRecord.tag -> tags

groveman作为logger被发送到SentryEvent。
LogRecord.stackTrace仅在captureEvent中发送。

LogRecord转换为Breadcrumb：

• LogRecord.level -> SentryLevel
• LogRecord.message -> message
• LogRecord.extra -> data

要自定义，创建SentryTree时传递所需的日志级别：

Groveman.plantTree(
  SentryTree(logLevels: [
    LogLevel.warning,
    LogLevel.info,
  ]),
);

许可证

版权所有 © 2025 Kauê Martins
该项目采用MIT许可证

示例代码

import 'package:flutter/material.dart';
import 'package:groveman/groveman.dart';
import 'package:groveman_sentry/groveman_sentry.dart';
import 'package:sentry_flutter/sentry_flutter.dart';

void main() {
  Groveman.plantTree(DebugTree(showColor: true));
  Groveman.captureErrorInZone(() async {
    await SentryFlutter.init(
      (options) {
        options.dsn = const String.fromEnvironment('SENTRY_DNS');
      },
    );
    Groveman.plantTree(SentryTree());
    Groveman.captureErrorInCurrentIsolate();
    runApp(const MyApp());
  });
}

class MyApp extends StatelessWidget {
  const MyApp({
    super.key,
  });

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({
    super.key,
    required this.title,
  });

  final String title;

  [@override](/user/override)
  // ignore: library_private_types_in_public_api
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
      Groveman.info(
        'Counter - $_counter',
        tag: 'counter',
        extra: {'my_counter': _counter},
      );
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: Column(
        mainAxisAlignment: MainAxisAlignment.end,
        children: [
          FloatingActionButton.extended(
            onPressed: () {
              Groveman.fatal(
                'Fatal',
                error: 'Fatal',
                stackTrace: StackTrace.current,
                extra: {'my_counter': _counter},
              );
            },
            label: const Text('Report fatal error'),
            icon: const Icon(Icons.bug_report),
          ),
          const SizedBox(
            height: 16,
          ),
          FloatingActionButton.extended(
            onPressed: () {
              Future.delayed(
                Duration.zero,
                () => throw Exception('Async error'),
              );
            },
            label: const Text('Report error'),
            icon: const Icon(Icons.error),
          ),
          const SizedBox(
            height: 16,
          ),
          FloatingActionButton.extended(
            onPressed: _incrementCounter,
            label: const Text('Increment'),
            icon: const Icon(Icons.add),
          ),
        ],
      ),
    );
  }
}