Flutter应用性能监控插件appdynamics_agent的使用

简介

AppDynamics Flutter Plugin 是 AppDynamics SDK 的扩展，允许您对 Flutter 应用进行性能监控并接收分析数据。此插件封装了原生 SDK，并需要有效的 AppDynamics 移动许可证。

功能特性

• 网络请求跟踪：通过 TrackedHTTPClient 和 RequestTracker 类。
• 自动崩溃报告：支持自定义崩溃报告配置。
• 屏幕跟踪：通过 NavigationObserver 和 WidgetTracker。
• ANR（应用程序无响应）检测和报告。
• 会话帧机制：跟踪自定义用户流。
• 错误和自定义指标报告。
• 自动捕获截图和用户触点（仅限 iOS）。
• 自定义用户数据：在网络请求、崩溃报告或会话中添加。
• 记录面包屑：跟踪 UI 组件或自定义用户交互。
• 计时器：跟踪跨越多个方法的事件。
• 方法执行标记。
• 多会话分割。
• 自动报告设备指标（内存、存储、电池）和连接转换事件。

快速开始

安装

您可以使用 flutter pub add appdynamics_agent 来安装插件。

对于 Android 应用，还需要额外的配置：

1. 在 android/build.gradle 文件中添加依赖：

   dependencies {
       classpath "com.appdynamics:appdynamics-gradle-plugin:22.2.2"
       // ... other dependencies
   }
   

2. 在 android/app/build.gradle 文件底部应用 adeum 插件：

   dependencies {
       // ... project dependencies
   }
   
   // Bottom of file
   apply plugin: 'adeum'
   

3. 在 AndroidManifest.xml 中添加权限：

   <manifest xmlns:android="http://schemas.android.com/apk/res/android"
       package="com.example.myawesomepackage">
   
       <!-- add these two permissions -->
       <uses-permission android:name="android.permission.INTERNET" />
       <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
   
       <!-- other permissions -->
   
       <application>
           <!-- other settings -->
       </application>
   </manifest>
   

开始监控

在 main.dart 中启动监控：

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

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

  final config = AgentConfiguration(
      appKey: "<EUM_APP_KEY>",
      loggingLevel: LoggingLevel.verbose, // 可选，用于更好的调试。
      collectorURL: "<COLLECTOR_URL>", // 可选，主要用于内部部署。
      screenshotURL: "<SCREENSHOT_URL>" // 可选，主要用于内部部署。
  );
  await Instrumentation.start(config);

  runApp(const MyApp());
}

示例代码

以下是一个完整的示例，展示了如何使用所有 Flutter agent 的功能：

/*
* Copyright (c) 2022. AppDynamics LLC and its affiliates.
* All rights reserved.
*
*/

/// Complete example with all Flutter agent's features.

import 'dart:async';

import 'package:appdynamics_agent/appdynamics_agent.dart';
import 'package:appdynamics_agent_example/routing/on_generate_route.dart';
import 'package:appdynamics_agent_example/routing/route_paths.dart';
import 'package:flutter/material.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 设置全局错误处理程序
  FlutterError.onError = Instrumentation.errorHandler;
  PlatformDispatcher.instance.onError = (error, stack) {
    final details = FlutterErrorDetails(exception: error, stack: stack);
    Instrumentation.errorHandler(details);
    return true;
  };
  
  // 自定义崩溃报告回调
  crashReportCallback(List<CrashReportSummary> summaries) async {
    // 处理崩溃报告
  }

  // 配置 Agent
  AgentConfiguration config = AgentConfiguration(
      appKey: "<EUM_APP_KEY>",
      loggingLevel: LoggingLevel.verbose,
      collectorURL: "https://www.<collector-url>.com",
      screenshotURL: "https://www.<screenshots-url>.com",
      crashReportCallback: crashReportCallback,
      screenshotsEnabled: true,
      crashReportingEnabled: true
  );

  // 启动监控
  await Instrumentation.start(config);

  // 运行应用
  runApp(const MyApp());
}

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
        initialRoute: RoutePaths.settings,
        onGenerateRoute: onGenerateRoute,
        navigatorObservers: [NavigationObserver()]);
  }
}

文档

您可以访问 pub.dev 文档 或查看 官方文档 获取更多关于代理自定义的信息。

通过以上步骤，您可以轻松地将 AppDynamics 的性能监控集成到您的 Flutter 应用中，确保应用的稳定性和性能得到全面监控。