Flutter日志追踪插件tracker_logger_bundle的使用

tracker_logger_bundle是一个用于加速开发和调试的Flutter插件包，它将多个信息、事件和错误跟踪器与日志库组合在一起。只需初始化一次并传入所有API密钥，即可在整个应用程序中无感知地使用。

目前支持以下库：

• MatomoTracker
• SentryFlutter
• FirebaseAnalytics
• FirebaseCrashlytics
• Logger （用于更美观的调试输出）

开始使用

初始化日志记录器

最简单的方式是在应用启动时初始化日志记录器实例。这通常在main.dart文件中完成，如下所示：

Future<void> main() async {
    // ...

    Log.instance.initialize();
    
    // ...
}

在initialize函数中可以添加你喜欢的插件。默认情况下，它只使用本地日志记录器。

如果使用了runZonedGuarded保护机制，可以在应用程序运行器周围包裹初始化代码。

在main.dart中，使用以下代码包裹在runZonedGuarded内：

Future<void> main() async {
  runZonedGuarded<
      Future<void>>(() async {
    WidgetsFlutterBinding.ensureInitialized();

    await Log.instance.initialize(
      matomoOptions: const MatomoOptions(siteId: 69, url: 'your matomo url'),
      sentryConfig: SentryConfig(
        optionsConfiguration: (options) {
          // options.dsn = kDebugMode ? '' : F.sentryKey;
          // 将tracesSampleRate设置为1.0以捕获100％的事务进行性能监控。
          // 在生产环境中建议调整此值。
          options.tracesSampleRate = 1.0;
        },
        appRunner: () => runApp(
          const AppEntry(),
        ),
      ),
    );
  }, 
  // 这将记录到你指定的所有插件
  (error, stack) async => Log.instance.logError(
    'Uncaught error in zonedGuarded',
    error: error,
    stackTrace: stack,
  ),
);
}

Firebase Analytics初始化

为了使插件正常工作，你需要先初始化Firebase核心。更多详细信息可以参考firebase analytics文档。

合作与贡献

如果有任何反馈、改进建议或想法，请随时联系。尽管这个包还远未完美，但我希望它能成为你在日常分析和错误日志记录中的实用助手。

路线图/待办事项

• 以智能方式添加同意管理功能。
• 添加更多的测试。
• 改进日志级别。
• 改进调试打印。

示例代码

以下是完整的示例代码，展示了如何使用tracker_logger_bundle插件。

// example/example.md
<h1 id="example" class="hash-header">Example <a href="#example" class="hash-link">#</a></h1>

<h2 id="getting-started" class="hash-header">Getting started <a href="#getting-started" class="hash-link">#</a></h2>

<p>最简单的初始化方式是在应用启动时初始化日志记录器实例。这通常在<code>main.dart</code>文件中完成，如下所示：</p>

```dart
Future<void> main() async {
    // ...

    Log.instance.initialize();
    
    // ...
}

在initialize函数中可以添加你喜欢的插件。默认情况下，它只使用本地日志记录器。

如果使用了runZonedGuarded保护机制，可以在应用程序运行器周围包裹初始化代码。

在main.dart中，使用以下代码包裹在runZonedGuarded内：

Future<void> main() async {
  runZonedGuarded<
      Future<void>>(() async {
    WidgetsFlutterBinding.ensureInitialized();

    await Log.instance.initialize(
      matomoOptions: const MatomoOptions(siteId: 69, url: 'your matomo url'),
      sentryConfig: SentryConfig(
        optionsConfiguration: (options) {
          // options.dsn = kDebugMode ? '' : F.sentryKey;
          // 将tracesSampleRate设置为1.0以捕获100％的事务进行性能监控。
          // 在生产环境中建议调整此值。
          options.tracesSampleRate = 1.0;
        },
        appRunner: () => runApp(
          const AppEntry(),
        ),
      ),
    );
  }, 
  // 这将记录到你指定的所有插件
  (error, stack) async => Log.instance.logError(
    'Uncaught error in zonedGuarded',
    error: error,
    stackTrace: stack,
  ),
);
}