Flutter性能监控插件newrelic_mobile的使用

New Relic Flutter Agent允许你在Flutter应用中通过原生的New Relic Android和iOS代理来收集崩溃、网络流量和其他信息。

特性

• 捕获Dart错误
• 网络请求跟踪
• 分布式追踪
• Future错误跟踪
• 捕获交互及其创建顺序
• 传递用户信息到New Relic以跟踪用户会话
• 通过NavigationObserver进行屏幕跟踪
• 捕获print和debug print语句作为日志
• 捕获离线事件和异常
• 捕获后台报告事件

当前支持

• Android API 24+
• iOS 10
• 依赖于New Relic iOS/XCFramework和Android代理

安装

在你的pubspec.yaml文件中添加newrelic_mobile插件：

dependencies:
  newrelic_mobile: ^1.1.4

Flutter设置

初始化NewRelic

在main.dart中初始化NewRelic：

import 'package:newrelic_mobile/newrelic_mobile.dart';
import 'dart:io';

var appToken = "";

if (Platform.isAndroid) {
  appToken = "<android app token>";
} else if (Platform.isIOS) {
  appToken = "<ios app token>";
}

Config config = Config(
    accessToken: appToken,
    analyticsEventEnabled: true,
    networkErrorRequestEnabled: true,
    networkRequestEnabled: true,
    crashReportingEnabled: true,
    interactionTracingEnabled: true,
    httpResponseBodyCaptureEnabled: true,
    loggingEnabled: true,
    webViewInstrumentation: true,
    printStatementAsEventsEnabled: true,
    httpInstrumentationEnabled: true,
    distributedTracingEnabled: true,
    logLevel: LogLevel.DEBUG);

NewrelicMobile.instance.start(config, () {
  runApp(MyApp());
});

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorObservers: [NewRelicNavigationObserver()],
      home: HomePage(),
    );
  }
}

屏幕跟踪

为了跟踪导航事件，需要将NewRelicNavigationObserver添加到你的MaterialApp中：

MaterialApp(
  navigatorObservers: [
    NewRelicNavigationObserver(),
  ],
  // 其他参数
)

示例Demo

以下是一个完整的示例代码，展示了如何在Flutter应用中使用New Relic插件进行各种操作：

import 'package:flutter/material.dart';
import 'package:newrelic_mobile/newrelic_mobile.dart';
import 'dart:io';

void main() {
  var appToken = "";

  if (Platform.isAndroid) {
    appToken = "<android app token>";
  } else if (Platform.isIOS) {
    appToken = "<ios app token>";
  }

  Config config = Config(
      accessToken: appToken,
      analyticsEventEnabled: true,
      networkErrorRequestEnabled: true,
      networkRequestEnabled: true,
      crashReportingEnabled: true,
      interactionTracingEnabled: true,
      httpResponseBodyCaptureEnabled: true,
      loggingEnabled: true,
      webViewInstrumentation: true,
      printStatementAsEventsEnabled: true,
      httpInstrumentationEnabled: true,
      distributedTracingEnabled: true,
      logLevel: LogLevel.VERBOSE);

  NewrelicMobile.instance.start(config, () {
    runApp(const MyApp());
  });
}

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorObservers: [NewRelicNavigationObserver()],
      home: HomePage(),
    );
  }
}

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

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text("New Relic Demo")),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: () async {
                NewrelicMobile.instance.logInfo("This is an informational message");
              },
              child: Text('Log Info'),
            ),
            ElevatedButton(
              onPressed: () async {
                try {
                  var dio = Dio();
                  var response = await dio.get('https://reqres.in/api/users?delay=15');
                  print(response);
                  NewrelicMobile.instance.noticeHttpTransaction(
                      "https://reqres.in/api/users?delay=15",
                      "GET",
                      200,
                      1000,
                      2000,
                      100,
                      300,
                      null,
                      responseBody: "This is Test Payload");
                } catch (e) {
                  print(e);
                }
              },
              child: Text('Track HTTP Transaction'),
            ),
            ElevatedButton(
              onPressed: () async {
                var id = await NewrelicMobile.instance.startInteraction("Getting Data from Service");
                try {
                  var dio = Dio();
                  var response = await dio.get('https://reqres.in/api/users?delay=15');
                  print(response);
                  NewrelicMobile.instance.endInteraction(id);
                } catch (e) {
                  print(e);
                }
              },
              child: Text('Start Interaction'),
            ),
          ],
        ),
      ),
    );
  }
}

这个示例展示了如何记录信息日志、跟踪HTTP事务以及开始和结束交互。你可以根据自己的需求扩展这些功能。

故障排除

如果在New Relic UI中没有显示HTTP数据，请确保你没有在Flutter应用中覆盖HttpOverrides.global。

对于更多详细信息和配置，请参考New Relic文档。