Flutter性能监控插件x_apm的使用

Flutter性能监控插件x_apm的使用

介绍

XPM SDK 能够全面监控Flutter端线上稳定性和性能的运行情况。目前SDK提供以下功能：

• 页面FPS监控
• 网络监控
• 页面性能监控（FP、FCP、FMP）
• Flutter/Dart 错误监控

使用

首先需要导入 x_apm 包并初始化插件。

import 'package:x_apm/x_apm.dart';

void main() {
  XApmManager.instance.init(
      config: ApmConfig(
          // 是否使用性能监控
          enable: true,
          handlers: [FloatWindowHandler(globalKey)],
          endpoint: 
              "https://hyperf.debug.591.com.hk/api/flutter/apm/save-record"));
  // 开启网络监控
  HttpOverrides.global = ApmHttpOverrides();
  // 错误收集
  XApm(appRunner: () => runApp(const MyApp()));
}

在 MyApp 类中设置 navigatorKey 和 navigatorObservers 以启用路由监控。

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  // This widget is the root of your application.
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      navigatorKey: globalKey,
      routes: generateRoutes(),
      theme: ThemeData(primarySwatch: Colors.blue, useMaterial3: false),
      // 添加路由监控
      navigatorObservers: [ApmNavigatorObserver.instance],
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

配置

X-APM支持以下配置选项：

/// 是否启用
final bool enable;

/// 打印器列表
final List<PrintlnHandler> handlers;

/// 上传地址
final String endpoint;

/// 用于外界筛选需要上传的数据，返回true则进行上传，false不上传
final bool Function(Data data)? filterFunction;

/// 用于外界对数据进行转换
final Transformer Function() transformer;

/// 用于外界对数据进行发送
final Sender Function() sender;

/// 用于外界自定义http请求
final http.Client Function() httpClient;

/// 发送数据的网络策略
final NetworkType networkTypePolicy;

/// 两次数据发送的最小时间间隔，单位毫秒
final int flushInterval = 15;

/// 本地缓存日志的最大条目数
final int flushBulkSize = 15;

完整示例代码

import 'dart:async';
import 'dart:io';

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:x_apm/x_apm.dart';
import 'package:x_apm_example/common/router.dart';
import 'package:x_apm_example/widgtes.dart';

GlobalKey<NavigatorState> globalKey = GlobalKey<NavigatorState>();

void main() {
  XApmManager.instance.init(
      config: ApmConfig(
          enable: true,
          handlers: [FloatWindowHandler(globalKey)],
          endpoint: 
              "https://hyperf.debug.591.com.hk/api/flutter/apm/save-record"));
  HttpOverrides.global = ApmHttpOverrides();

  XApm(appRunner: () => runApp(const MyApp()), ensureInitialized: true);
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  // This widget is the root of your application.
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      navigatorKey: globalKey,
      routes: generateRoutes(),
      theme: ThemeData(primarySwatch: Colors.blue, useMaterial3: false),
      navigatorObservers: [ApmNavigatorObserver.instance],
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

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

  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('通用版首页'),
        actions: <Widget>[
          IconButton(
            icon: const Icon(Icons.settings),
            tooltip: 'Setting',
            onPressed: () => Navigator.of(context).pushNamed('/setting'),
          ),
        ],
      ),
      body: Center(
        child: ListView(
          padding: const EdgeInsets.only(left: 16.0, right: 16.0, top: 8.0, bottom: 8.0),
          children: <Widget>[
            buildEntryButton(context, '异常测试', '/error_test'),
            buildEntryButton(context, '页面路由跳转测试', '/navigator_test/first_page'),
            buildEntryButton(context, '设备信息', '/navigator_test/device_info_page'),
            buildEntryButton(context, '网络测试', '/navigator_test/network_page'),
          ],
        ),
      ),
    );
  }
}