Flutter性能监控插件datadog_flutter的使用

Flutter性能监控插件datadog_flutter的使用

准备工作

在开始使用 datadog_flutter 插件之前，请确保你已经生成了一个客户端令牌（Client Token），并将其添加到你的项目中。你需要从 Datadog 的设置面板中获取这个令牌。

初始化

首先，在你的应用启动时初始化 Datadog 插件。以下是初始化的基本步骤：

import 'package:datadog_flutter/datadog_flutter.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化 Datadog 插件
  await DatadogFlutter.initialize(
    androidRumApplicationId: 'YOUR_ANDROID_RUM_APP_ID',
    clientToken: 'YOUR_CLIENT_TOKEN',
    environment: 'production',
    iosRumApplicationId: 'YOUR_IOS_RUM_APP_ID',
    serviceName: 'my-app-name',
    trackingConsent: TrackingConsent.granted,
  );

  // 初始化跟踪插件
  await DatadogTracing.initialize();

  // 捕获 Flutter 错误
  FlutterError.onError = DatadogRum.instance.addFlutterError;

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

日志记录

接下来，你可以配置日志记录。默认情况下，日志数据将通过 Logger 记录器发送到 Datadog。请注意，print 语句可能不会被捕捉。

import 'package:datadog_flutter/datadog_logger.dart';
import 'package:logging/logging.dart';

void main() async {
  // 配置日志记录
  Logger.root.level = Level.FINEST;
  final _logger = DatadogLogger(loggerName: 'Root Logger');
  Logger.root.onRecord.listen(_logger.onRecordCallback);

  // 设置主机名
  await DatadogFlutter.setUserInfo(id: 'HOST_NAME');
  _logger.addAttribute('hostname', 'HOST_NAME');
  await DatadogRum.instance.addAttribute('hostname', 'HOST_NAME');
}

实时用户监控

实时用户监控（RUM）可以用来跟踪错误、事件和屏幕。以下是如何启用 RUM 的基本步骤：

import 'package:datadog_flutter/datadog_observer.dart';
import 'package:flutter/material.dart';

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,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      routes: {
        '/logs': (_) => const Logs(),
        '/rum': (_) => const Rum(),
        '/tracing': (_) => Tracing(),
      },
      home: const Logs(),
      navigatorObservers: [
        DatadogObserver(), // 添加观察者以自动跟踪屏幕
      ],
    );
  }
}

手动跟踪事件

你也可以手动跟踪额外的事件或错误。例如，当用户点击某个按钮时，你可以记录一个事件：

GestureDetector(
  onTap: () {
    DatadogRum.instance.addUserAction('EventTapped');
  },
)

跟踪网络请求

你可以手动跟踪网络请求或资源加载：

import 'package:datadog_flutter/datadog_rum.dart';

void someFunction() async {
  await DatadogRum.startResourceLoading(
    'unique_id',
    url: 'https://example.com',
    method: RUMResources.get,
  );
  await DatadogRum.stopResourceLoading(
    'unique_id',
    statusCode: 500,
    errorMessage: 'Internal Server Error',
  );
}

常见问题解答

如何在本地开发时禁用日志记录？

默认情况下，DatadogFlutter 会将所有日志发送到 Datadog。为了在本地开发时禁用日志记录，你可以使用以下方法：

DatadogLogger(bindOnRecord: false)

// 后续条件性地记录日志
Logger.root.onRecord.listen((record) async {
  if (shouldSendToDatadog) {
    ddLogger.onRecordCallback(record);
  } else {
    print(record);
  }
});

完整示例

下面是完整的示例代码，展示了如何在 Flutter 应用中使用 datadog_flutter 插件进行性能监控：

import 'dart:async';
import 'package:datadog_flutter/datadog_logger.dart';
import 'package:datadog_flutter/datadog_observer.dart';
import 'package:datadog_flutter/datadog_rum.dart';
import 'package:datadog_flutter/datadog_tracing.dart';
import 'package:flutter/material.dart';
import 'package:logging/logging.dart';

import 'package:datadog_flutter/datadog_flutter.dart';

import 'config.dart';
import 'rum.dart';
import 'logs.dart';
import 'tracing.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await DatadogFlutter.initialize(
    androidRumApplicationId: ANDROID_RUM_APPLICATION_ID,
    clientToken: DATADOG_CLIENT_TOKEN,
    environment: ENVIRONMENT,
    iosRumApplicationId: IOS_RUM_APPLICATION_ID,
    serviceName: SERVICE_NAME,
    trackingConsent: TrackingConsent.granted,
  );

  await DatadogTracing.initialize();

  // 捕获 Flutter 错误
  FlutterError.onError = DatadogRum.instance.addFlutterError;

  Logger.root.level = Level.FINEST;
  final _logger = DatadogLogger(loggerName: 'Root Logger');
  Logger.root.onRecord.listen(_logger.onRecordCallback);

  // 设置主机名
  await DatadogFlutter.setUserInfo(id: HOST_NAME);
  _logger.addAttribute('hostname', HOST_NAME);
  await DatadogRum.instance.addAttribute('hostname', HOST_NAME);

  // 捕获错误不崩溃应用
  runZonedGuarded(() {
    runApp(const MyApp());
  }, (error, stackTrace) {
    DatadogRum.instance.addError(error, stackTrace);
  });

  runApp(const 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,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      routes: {
        '/logs': (_) => const Logs(),
        '/rum': (_) => const Rum(),
        '/tracing': (_) => Tracing(),
      },
      home: const Logs(),
      navigatorObservers: [
        DatadogObserver(), // 添加观察者以自动跟踪屏幕
      ],
    );
  }
}