Flutter性能监控插件keiser_metrics_connection的使用

Flutter性能监控插件keiser_metrics_connection的使用

该包的目的是为了方便地连接到Keiser Metrics服务器。它不提供任何表示服务器路由/模型的接口。

如果您正在寻找包含所有服务器路由映射的便捷函数和模型的SDK，请参阅keiser_metrics_sdk。

注意 - 此包是keiser_metrics_sdk的依赖项。

特性

  • Websocket

    • 主要的服务器通信方法。

  • REST

    • HTTP回退（如果未启用websocket）。

  • 请求队列

    • 在短时间内请求量超过一定数量时会开始排队请求。

  • 请求重试

    • 自动重试失败请求一定次数。

  • 保持活动状态

    • 认证后会自动发送keep-alive请求。

  • 基于事件

    • 暴露几个流，让您跟踪以下信息：
      • websocket连接状态
      • 服务器状态
      • 认证状态

开始使用

安装

在pubspec.yaml文件中添加以下依赖：

dart pub add keiser_metrics_connection

或者

flutter pub add keiser_metrics_connection
导入

在Dart文件中导入包：

import 'package:keiser_metrics_connection/keiser_metrics_connection.dart';

使用

以下是一个完整的示例，展示了如何使用keiser_metrics_connection插件来连接到Keiser Metrics服务器并监听状态变化：

import 'package:keiser_metrics_connection/keiser_metrics_connection.dart';

bool _isAuthenticated = false;
bool _isConnected = false;
bool _isServerOnline = false;

void main() {
  final connection = MetricsConnection(
    restEndpoint: 'http://192.168.208.191:8080/api',
    socketEndpoint: 'ws://192.168.208.191:8080/ws',
    requestRetryLimit: 1,
    socketTimeout: Duration(seconds: 5),
  );

  // 监听服务器状态变化
  connection.onServerStatusChange.listen((event) {
    _isServerOnline = event == ServerState.online;
    _printStatus();
  });

  // 监听websocket连接状态变化
  connection.onConnectionStatusChange.listen((event) {
    _isConnected = event == ConnectionState.connected;
    _printStatus();
  });

  // 监听认证状态变化
  connection.onAuthenticationStatusChange.listen((event) {
    _isAuthenticated = event == AuthenticationState.authenticated;
    _printStatus();
  });

  // 打开连接
  connection.open();
}

// 打印当前状态
void _printStatus() {
  print(_StatusEvent(
    isAuthenticated: _isAuthenticated,
    isConnected: _isConnected,
    isOnline: _isServerOnline,
  ));
}

// 状态事件类
class _StatusEvent {
  _StatusEvent({
    required this.isAuthenticated,
    required this.isConnected,
    required this.isOnline,
  });

  final bool isAuthenticated;
  final bool isConnected;
  final bool isOnline;

  @override
  String toString() =>
      '_StatusEvent(isAuthenticated: $isAuthenticated, isConnected: $isConnected, isOnline: $isOnline)';
}

额外信息

错误处理

当发生错误时，MetricsConnection会抛出MetricsApiError异常。该异常包含一些有用的信息，如错误代码、状态码、错误名称和错误消息。

class MetricsApiError implements Exception {

  // ...

  String? explanation;
  int code; // 内部API代码
  int status; // 标准服务器状态码（例如，200, 500等）
  String name; // 例如："TokenInvalid", "UnauthorizedResource"
  String message;

  // ...
}
状态事件

状态事件枚举用于描述不同状态：

enum ConnectionState { disconnected, connected } // websocket

enum ServerState { online, offline }

enum AuthenticationState { unauthenticated, authenticated, unknown }

更多关于Flutter性能监控插件keiser_metrics_connection的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter性能监控插件keiser_metrics_connection的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


在Flutter应用中进行性能监控是确保应用流畅运行和用户体验良好的关键步骤之一。keiser_metrics_connection 是一个专门用于Flutter应用的性能监控插件。虽然我不能提供具体的安装或配置建议（因为这通常依赖于项目的具体需求和环境），但我可以展示如何在Flutter应用中使用该插件进行性能监控的一个基本示例。

首先，确保你已经在pubspec.yaml文件中添加了keiser_metrics_connection依赖：

dependencies:
  flutter:
    sdk: flutter
  keiser_metrics_connection: ^最新版本号  # 请替换为实际的最新版本号

然后，运行flutter pub get来安装依赖。

接下来，你可以在你的Flutter应用中按照以下步骤进行性能监控的设置和使用：

  1. 初始化监控插件：

    在你的应用的主入口文件（通常是main.dart）中，初始化keiser_metrics_connection插件。

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

void main() {
  // 初始化 KeiserMetricsConnection
  KeiserMetricsConnection.initialize(
    endpoint: '你的监控服务端点',  // 替换为你的监控服务URL
    appIdentifier: '你的应用标识符',  // 替换为你的应用唯一标识符
  );

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

  1. 发送性能数据：

    在你的应用中，你可以在需要监控性能的地方调用KeiserMetricsConnection提供的方法来发送性能数据。例如，你可以监控页面加载时间、用户交互响应时间等。

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

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  @override
  void initState() {
    super.initState();
    // 模拟页面加载时间监控
    Future.delayed(Duration(seconds: 2), () {
      // 发送页面加载时间数据
      KeiserMetricsConnection.sendCustomEvent(
        eventName: 'page_load_time',
        properties: <String, dynamic>{
          'page': 'HomePage',
          'loadTime': 2000,  // 单位为毫秒
        },
      );
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Flutter Demo Home Page'),
      ),
      body: Center(
        child: Text('Hello, World!'),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          // 模拟用户交互响应时间监控
          DateTime startTime = DateTime.now();
          Future.delayed(Duration(seconds: 1), () {
            DateTime endTime = DateTime.now();
            Duration responseTime = endTime.difference(startTime);

            // 发送用户交互响应时间数据
            KeiserMetricsConnection.sendCustomEvent(
              eventName: 'button_click_response_time',
              properties: <String, dynamic>{
                'button': 'FAB',
                'responseTime': responseTime.inMilliseconds,  // 单位为毫秒
              },
            );
          });
        },
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }
}

在这个示例中，我们展示了如何在页面加载和按钮点击时发送自定义性能事件到监控服务。请注意，KeiserMetricsConnection.sendCustomEvent 方法允许你发送带有自定义事件名称和属性的性能数据。

注意：以上代码仅作为示例，实际使用时，你需要根据你的监控服务的要求来调整事件名称、属性和数据格式。同时，确保你的监控服务端点和应用标识符是正确配置的。

此外，keiser_metrics_connection 插件可能提供了更多的功能和配置选项，具体请参考该插件的官方文档以获取更多信息。

回到顶部