Flutter远程日志记录插件flutter_feature_remote_logging的使用

Flutter远程日志记录插件flutter_feature_remote_logging的使用

Description

flutter_feature_remote_logging 是一个用于从远程记录设备日志的库。

日志记录平台

Google Cloud Logging

使用 Google Cloud Logging 平台进行远程日志记录。

构造函数

初始化方法

调用此函数在创建构造函数后初始化远程日志服务。

远程日志写入

将日志写入到指定的远程日志平台。

添加默认标签

为日志添加默认标签值。

移除默认标签

从默认标签中移除标签。

Betterstack

使用 Betterstack 平台进行远程日志记录。

构造函数

初始化方法

调用此函数在创建构造函数后初始化远程日志服务。

远程日志写入

将日志写入到指定的远程日志平台。

添加默认标签

为日志添加默认标签值。

移除默认标签

从默认标签中移除标签。

示例代码

以下是一个完整的示例代码，展示如何使用 flutter_feature_remote_logging 插件。

import 'dart:convert';
import 'dart:developer';
import 'dart:io';

import 'package:example/data/dto/model/feature_model.dart';
import 'package:example/presentation/widget/feature_widget.dart';
import 'package:flutter/material.dart';
import 'package:flutter_dotenv/flutter_dotenv.dart';
import 'package:flutter_feature_remote_logging/flutter_feature_remote_logging.dart';
import 'package:logger/logger.dart';

late GoogleCloudLoggingServiceImpl googleServiceImpl;
late FeatureBetterStackRemoteLoggingServiceImpl betterstackServiceImpl;

void main() {
  runApp(const MyApp());
}

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    WidgetsBinding.instance.addPostFrameCallback((timeStamp) {
      // 初始化 Google Cloud Logging
      try {
        DefaultAssetBundle.of(context).loadString('assets/example-learn-purpose-4dd93f634791.json').then((value) {
          final serviceAccount = json.decode(value) as Map<String, dynamic>;
          log("service-account: $serviceAccount");
          googleServiceImpl = GoogleCloudLoggingServiceImpl(
            serviceAccount: serviceAccount,
            env: "dev",
          );
          googleServiceImpl.init();
        });
      } catch (e) {
        log("failed init google service: $e");
      }

      // 初始化 Betterstack
      try {
        dotenv.load(fileName: '.env').then((value) {
          final sourceToken = dotenv.env['BETTERSTACK_SOURCE_TOKEN'];
          if (sourceToken == null) throw Exception('source token missing');
          betterstackServiceImpl = FeatureBetterStackRemoteLoggingServiceImpl(sourceToken: sourceToken);
          betterstackServiceImpl.init();
        });
      } catch (e) {
        log("failed init betterstack: $e");
      }

      Future.delayed(const Duration(seconds: 3), () {
        FeatureRemoteLogger.addLogListener((event) {
          googleServiceImpl.writeLog(level: event.level, message: event.message, labels: event.labels);
          betterstackServiceImpl.writeLog(level: event.level, message: event.message, labels: event.labels);
        });
      });
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Remote Logging',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Remote Logging Example'),
    );
  }
}

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

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  List<FeatureModel> features = [
    FeatureModel(
      title: 'Log something',
      desc: 'Log something',
      key: 'LOG_SOMETHING',
    ),
    FeatureModel(
      title: 'Google Cloud Add Default Label',
      desc: 'Google Cloud Add Default Label',
      key: 'GOOGLE_CLOUD_ADD_DEFAULT_LABEL',
    ),
    FeatureModel(
      title: 'Betterstack Add Default Label',
      desc: 'Betterstack Add Default Label',
      key: 'BETTERSTACK_ADD_DEFAULT_LABEL',
    ),
  ];

  [@override](/user/override)
  void initState() {
    super.initState();
    WidgetsBinding.instance.addPostFrameCallback((timeStamp) {
      Future.delayed(Duration(seconds: 5), () {
        FeatureRemoteLogger().log(Level.info, "start app");
      });
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Remote Logger')),
      body: ListView.builder(
        padding: const EdgeInsets.symmetric(horizontal: 20, vertical: 10),
        itemCount: features.length,
        itemBuilder: (_, index) {
          final feature = features[index];
          return GestureDetector(
            onTap: () async {
              switch (feature.key) {
                case "LOG_SOMETHING":
                  FeatureRemoteLogger().log(
                    Level.info,
                    "fadlurahmanfdev log something",
                  );
                  break;
                case "GOOGLE_CLOUD_ADD_DEFAULT_LABEL":
                  googleServiceImpl.addLabels(labels: {
                    'platform': Platform.operatingSystem,
                  });
                  break;
                case "BETTERSTACK_ADD_DEFAULT_LABEL":
                  betterstackServiceImpl.addLabels(labels: {
                    'platform': Platform.operatingSystem,
                  });
                  break;
              }
            },
            child: ItemFeatureWidget(feature: feature),
          );
        },
      ),
    );
  }
}