Flutter轨迹追踪插件flutter_paper_trail_plus的使用

Flutter轨迹追踪插件flutter_paper_trail_plus的使用

简介

Flutter Paper Trail Plus 是一个强大的日志记录和实时监控插件，可以帮助你无缝集成高级日志功能到你的 Flutter 项目中。通过增强的日志记录、可定制的输出和错误通知，你可以快速识别和优先处理问题。利用数据洞察和安全特性，简化调试过程，提升应用维护的效率。

使用方法

初始化

在使用 flutter_paper_trail_plus 之前，你需要先进行初始化。以下是一个完整的初始化示例：

import 'package:flutter_paper_trail_plus/flutter_paper_trail_plus.dart';

void main() {
  // 初始化日志记录器
  FlutterPaperTrailPlus.initLogger(
    hostName: "logs.papertrailapp.com",  // 替换为你的 Papertrail 主机名
    programName: "flutter-test-app",     // 应用名称
    port: 21358,                         // 端口号
    machineName: "Pixel 4",              // 设备名称，可以使用 DeviceInfoPlugin 获取
  );

  runApp(MyApp());
}

记录日志

flutter_paper_trail_plus 提供了多种日志级别，包括 logError、logInfo、logWarning 和 logDebug。你可以根据需要选择合适的方法来记录日志。

// 记录错误日志
FlutterPaperTrailPlus.logError("这是一个错误日志");

// 记录信息日志
FlutterPaperTrailPlus.logInfo("这是一个信息日志");

// 记录警告日志
FlutterPaperTrailPlus.logWarning("这是一个警告日志");

// 记录调试日志
FlutterPaperTrailPlus.logDebug("这是一个调试日志");

用户标识

当用户登录时，你可以设置用户的唯一标识符，以便在日志中区分不同的用户。

// 设置用户ID
FlutterPaperTrailPlus.setUserId("mufassal786");

完整示例代码

以下是一个完整的示例应用程序，展示了如何在 Flutter 项目中使用 flutter_paper_trail_plus 进行日志记录和用户标识。

import 'package:flutter/material.dart';
import 'package:flutter_paper_trail_plus/flutter_paper_trail_plus.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 异步初始化平台状态
  Future<void> initPlatformState() async {
    await FlutterPaperTrailPlus.initLogger(
      hostName: "logs.papertrailapp.com",  // 替换为你的 Papertrail 主机名
      programName: "flutter-test-app",     // 应用名称
      port: 21358,                         // 端口号
      machineName: "Pixel 4",              // 设备名称，可以使用 DeviceInfoPlugin 获取
    );
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        floatingActionButton: FloatingActionButton(
          onPressed: () async {
            // 记录不同级别的日志
            await FlutterPaperTrailPlus.logError("我爱在 Papertrail 上记录错误信息");
            await FlutterPaperTrailPlus.logInfo("我爱在 Papertrail 上记录信息");
            await FlutterPaperTrailPlus.logWarning("我爱在 Papertrail 上记录警告信息");
            await FlutterPaperTrailPlus.logDebug("我爱在 Papertrail 上记录调试信息");
          },
          tooltip: '记录到 Papertrail',
          child: Icon(Icons.add),
        ),
        appBar: AppBar(
          title: Text('Papertrail 日志示例'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: <Widget>[
              Text('点击 + 按钮测试记录日志到 Papertrail'),
              TextButton(
                child: Text('标识用户'),
                onPressed: () {
                  // 设置用户ID
                  FlutterPaperTrailPlus.setUserId("JohnDeer391");
                },
              ),
              Text('点击 + 按钮后再次标识用户'),
            ],
          ),
        ),
      ),
    );
  }
}

MIT License

flutter_paper_trail_plus 采用 MIT 许可证，具体内容如下：

Copyright (c) 2023 Mufassal Hussain

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.