runFullstoryApp function

void runFullstoryApp(Widget app, { LogLevel logLevel = LogLevel.note, bool logScanMetrics = kDebugMode, bool shortenSelectors = true, bool captureImages = false, Set<Rasterizer<RenderBox>> rasterizers = const {}, })

Runs the given app inside a Fullstory-instrumented binding.

This is equivalent to calling the standard runApp, but allows Fullstory to capture data needed for session replay using FullstoryBinding.

logScanMetrics indicates whether to log view scan metrics to the console. This is intended for debugging and performance tuning, and will negatively impact performance if enabled in production. By default, enabled in debug only.

shortenSelectors indicates whether some widgets which are typically implementation details of others are hidden from the selectors created during scans. This defaults to true, and typically should only be set to false for debugging, as there is a performance cost associated with deeper selectors.

captureImages controls whether images and chart painters are rasterized into color grids for playback. Adds CPU overhead (~50% in profiling). Defaults to false while the feature stabilizes; set to true to enable.

rasterizers configures render objects that should be captured as raster images, for custom-drawn widgets (such as third-party charts) that Fullstory can't otherwise capture. Empty by default, and only applies when captureImages is true. See Rasterizer for what is safe to rasterize.

logLevel is deprecated. Instead, set the logLevel for the Android and iOS SDKs.

Implementation

void runFullstoryApp(
  Widget app, {
  LogLevel logLevel = LogLevel.note,
  bool logScanMetrics = kDebugMode,
  bool shortenSelectors = true,
  bool captureImages = false,
  Set<Rasterizer> rasterizers = const {},
}) {
  final WidgetsBinding binding = FullstoryBinding.ensureInitialized();
  Kernel.instance
    ?..init()
    ..logScanMetrics = logScanMetrics
    ..hideElements = shortenSelectors
    ..captureImages = captureImages
    ..rasterizers = rasterizers;

  _runWidget(
    binding.wrapWithDefaultView(app),
    binding,
    'runFullstoryApp',
    logLevel: logLevel,
  );
}