Flutter性能监控与分析插件fullstory_flutter的使用

Flutter性能监控与分析插件fullstory_flutter的使用

Fullstory Flutter Package

Fullstory Flutter 插件允许您在Flutter应用中访问Fullstory Native Mobile SDK。此插件旨在与Fullstory for Mobile Apps配合使用。

注意：这是一个预览版本，发布1.0.0之前可能会有一些重大更改。

Quick Links

• Getting Started guide
• Usage examples
• Fullstory API
• Email us

What’s supported

大多数非视觉Fullstory API都支持：

• FS.event(String name, [Map<String, Object?> properties = const {}])
• FS.page(String pageName, [Map<String, Object?>? pageVars]) → FSPage
• FS.log({FSLogLevel level = FSLogLevel.info, required String message})
• FS.identify(String uid, [Map<String, Object?>? userVars])
• FS.setUserVars(Map<String, Object?> userVars)
• FS.anonymize()
• FS.shutdown()
• FS.restart()
• FS.setStatusListener(FSStatusListener? listener)
• FS.getCurrentSession → Future<String?>
• FS.getCurrentSessionURL({bool now = false}) → Future<String?>
• FS.fsVersion → Future<String?>
• FS.resetIdleTimer()

视觉会话回放目前不支持，但计划在未来版本中添加。

Getting Started

查看Fullstory for Flutter Mobile Apps入门指南。

此外，请参阅我们的示例应用以获取工作API使用示例。

示例代码

import 'package:flutter/material.dart';
import 'package:fullstory_flutter/fs.dart';

class CaptureStatus extends StatefulWidget {
  const CaptureStatus({
    super.key,
  });

  @override
  State<CaptureStatus> createState() => _CaptureStatusState();
}

class _CaptureStatusState extends State<CaptureStatus> with FSStatusListener {
  var status = "Loading...";
  var url = "";
  var id = "";
  var urlNow = "Press button to update";

  @override
  void initState() {
    super.initState();

    // grab the current session URL & ID in case it has already started
    FS.getCurrentSessionURL().then((url) =&gt; setState(() {
          if (url != null) {
            // if there is a url, we know the session started
            this.url = url;
            status = "Started";
          }
        }));
    FS.currentSession.then((id) =&gt; setState(() {
          this.id = id ?? "";
        }));

    // set the status listener to handle future changes
    FS.setStatusListener(this);
  }

  @override
  void dispose() {
    super.dispose();
    // clear the current status listener (there can be only one!)
    FS.setStatusListener(null);
  }

  // This comes from FSStatusListener - the default implementation is a no-op
  @override
  void onFSSession(String url) {
    setState(() {
      status = "Started";
      this.url = url;
      FS.currentSession.then((id) =&gt; setState(() {
            this.id = id ?? "";
          }));
    });
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      children: [
        Wrap(
          children: [
            TextButton(
                onPressed: () {
                  FS.shutdown();
                  // manually do this one since only the iOS SDK has a callback for it
                  setState(() {
                    status = "Shutdown";
                    url = "";
                    id = "";
                  });
                },
                child: const Text("Shutdown")),
            const TextButton(onPressed: FS.restart, child: Text("Restart")),
            TextButton(
                onPressed: () {
                  FS.getCurrentSessionURL(now: true).then((url) =&gt; setState(() {
                        urlNow = url ?? "";
                      }));
                },
                child: const Text("Update Timestamped URL"))
          ],
        ),
        SelectableText("Status: $status\nURL: $url\nNow: $urlNow\nID: $id"),
      ],
    );
  }
}

import 'package:flutter/material.dart';
import 'package:fullstory_flutter/fs.dart';

class Events extends StatelessWidget {
  const Events({
    super.key,
  });

  @override
  Widget build(BuildContext context) {
    return Wrap(
      children: [
        TextButton(
          onPressed: () => FS.event("Name-only event"),
          child: const Text("Name-only event"),
        ),
        TextButton(
          onPressed: () => FS.event("Many properties event", {
            "string_val": "a string value",
            "int_val": 42,
            "double_val": 0.1,
            "bool_val": true,
            "null_val": null,
            "list_val": [1, 2, 3],

            // in playback, this is displayed as:
            // map_val.nested_map.val_bool: true
            // map_val.nested_string_str: nested string
            "map_val": {
              "nested_string": "nested string",
              "nested_map": {"val": true},
            },
            //"mixed_list_val": [4, "a", false], // not supported, error in playback
          }),
          child: const Text("Many properties event"),
        ),
        TextButton(
          onPressed: () => FS.event('Order Completed', {
            'orderId': '23f3er3d',
            'products': [
              {'productId': '9v87h4f8', 'price': 20.00, 'quantity': 0.75},
              {'productId': '4738b43z', 'price': 12.87, 'quantity': 6},
            ],
          }),
          child: const Text('Order Completed event'),
        )
      ],
    );
  }
}

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:fullstory_flutter/fs.dart';

class FSVersion extends StatefulWidget {
  const FSVersion({super.key});
  @override
  State<FSVersion> createState() => _FSVersionState();
}

class _FSVersionState extends State<FSVersion> {
  String fsVersion = 'Unknown';
  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  Future<void> initPlatformState() async {
    String fsVersion;
    try {
      fsVersion = await FS.fsVersion ?? 'Unknown Fullstory version';
    } on PlatformException {
      fsVersion = 'Failed to get Fullstory version.';
    }

    if (!mounted) return;

    setState(() {
      this.fsVersion = fsVersion;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Text('Fullstory version: $fsVersion\n');
  }
}