VuTelemetry class

Entry point for the vuTelemetry RUM SDK.

Call initialize once during app startup to boot the native pipeline, wire up automatic error/crash capture (when enabled), and register the global tracer provider. The remaining static helpers add custom attributes and manual click instrumentation. Use action for scoped custom-action spans and error for handled/custom errors.

Constructors

VuTelemetry()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

actionWindowDuration Duration
The configured action-window duration. Defaults to 500ms until initialize runs. Read by the interaction/navigation openers.
no setter
initializationParams InitializationParams
The params passed to the last initialize call.
no setter
isInitialised bool
Whether initialize has completed.
no setter

Static Methods

flushSpans() Future<void>
Drains Dart-buffered spans to native and persists the native bridge queue to disk. Completes when the spans are durable.
initialize({required InitializationParams params}) Future<void>
Boots the SDK: initialises the native layer, optionally installs automatic error handlers / HTTP overrides / jank monitoring per InitializationParams.instrumentations, and registers the global tracer provider (routing spans through the native bridge).
logInteraction(String widgetName, {String interactionType = InteractionTypes.tap, Map<String, String>? attributes}) → void
Records an instantaneous ui.interaction span for widgetName and opens the action window so spans created in the next actionWindowDuration parent to this interaction.
logTabChange(String name, {String? group, String? trigger, bool foldIntoScreenName = true}) → void
Records a tab / bottom-nav destination change by name.
observeTabController(TabController controller, {List<String>? tabNames, String? group, bool foldIntoScreenName = true}) TabObservation
Reports every selection change on controller as a ui.navigation tab_switch span, and — unless foldIntoScreenName is false — folds the selected tab into screen.name.
setCustomAttribute(String key, String value) → void
Set a single custom attribute. See setCustomAttributes.
setCustomAttributes(Map<String, String> attributes) → void
Set multiple custom attributes. Pushed to the native layer, which merges them into its global attribute set and applies them to every subsequent span — native-origin and bridged Dart spans alike.

Constants

action → const VuActionApi
Custom-action factories (VuTelemetry.action.startAction / withAction).
error → const VuErrorApi
Manual custom-error recording (VuTelemetry.error.record(...)).
version → const String