Flutter性能监控与网络请求插件dynatrace_flutter_plugin_dio的使用

简介

Dynatrace Flutter Plugin 支持通过 dynatrace_flutter_plugin_dio 插件来增强对 Dio HTTP 客户端的监控。该插件允许自动标记和计时通过 Dio 发起的网络请求，从而在 Dynatrace 中进行详细的性能分析。

要求

• Dynatrace Flutter Plugin
• Flutter 版本 >= 1.12.0
• Dart 版本 >= 2.15
• Dio 版本 >= 5.0.0
• Gradle: >= 5.x
• Android API Level >= 21
• iOS SDK >= 12

使用方法

基本使用

首先需要导入必要的包，并初始化 Dio 实例：

import 'package:dynatrace_flutter_plugin_dio/dynatrace_flutter_plugin_dio.dart';
import 'package:dynatrace_flutter_plugin/dynatrace_flutter_plugin.dart';

final dio = Dio();
dio.instrument();

创建一个用户操作并关联到 Dio 请求中：

void _dioRequestWithAction() async {
  final dio = Dio();
  dio.instrument();

  var url = 'https://dynatrace.com';
  DynatraceRootAction dioAction = Dynatrace().enterAction('Dio Action - $url');

  try {
    await dio.get(url);
  } catch (error) {
    // 错误处理
  } finally {
    dioAction.leaveAction();
  }
}

如果未创建用户操作，插件会自动创建一个名为 “Dio Request” 的用户操作，并将请求包含在其瀑布分析中。

请求和响应大小计算

默认情况下，插件会报告请求和响应的字节数。但是，某些情况下可能需要自定义设置以确保准确性：

Map<String, String> _myNewDefaultHeaders = {
  "User-Agent": "Dart/X.X (dart:io)"
};
DynatraceClientAdapterOptions _options = DynatraceClientAdapterOptions(
  _myNewDefaultHeaders,
  exclusionList: ['url-to-exclude.com']
);

final dio = Dio();
dio.instrument(options: _options);

示例 Demo

以下是一个完整的 Flutter 应用示例，展示了如何集成 dynatrace_flutter_plugin_dio 插件：

import 'package:dio/dio.dart';
import 'package:dynatrace_flutter_plugin_dio/dynatrace_flutter_plugin_dio.dart';
import 'package:dynatrace_flutter_plugin/dynatrace_flutter_plugin.dart';
import 'package:flutter/material.dart';

main() {
  // 配置 Dynatrace 插件，请参考官方文档
  Dynatrace().start(MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Dynatrace Dio Example'),
    );
  }
}

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> {
  void _dioRequestWithAction() async {
    final dio = Dio();
    dio.instrument();

    var url = 'https://dynatrace.com';
    DynatraceRootAction dioAction = Dynatrace().enterAction('Dio Action - $url');

    try {
      await dio.get(url);
    } catch (error) {
      // 错误处理
    } finally {
      dioAction.leaveAction();
    }
  }

  void _dioRequestWithoutAction() async {
    final dio = Dio();
    dio.instrument();

    try {
      await dio.get('https://dynatrace.com');
    } catch (error) {
      // 错误处理
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'Dio Request Examples',
            ),
            FloatingActionButton(
              onPressed: _dioRequestWithAction,
              tooltip: 'Dio Request With Action',
              child: const Icon(Icons.add),
            ),
            FloatingActionButton(
              onPressed: _dioRequestWithoutAction,
              tooltip: 'Dio Request Without Action',
              child: const Icon(Icons.check),
            ),
          ],
        ),
      ),
    );
  }
}