flutter_sdk library
Public API for the vuTelemetry Flutter RUM SDK.
Import this library to initialise telemetry and add automatic/manual instrumentation:
- VuTelemetry / InitializationParams / InstrumentationsConfig — bootstrap and auto-instrumentation gates.
- VuTelemetry.action / VuAction — scoped custom-action spans.
- VuTelemetry.error — app-facing handled/custom error recording only (UI/platform capture is automatic and internal).
- VuTelemetry.logInteraction / InteractionTypes — manual user-interaction spans.
- RouteObserverService — automatic navigation spans, including nested
Navigators via RouteObserverService.nested. - VuTabScope / VuIndexScope / VuTelemetry.observeTabController / VuTelemetry.logTabChange — tab and bottom-nav switches, which produce no route event of their own.
- TrackedHttpClient / TrackedHttpOverrides — automatic HTTP spans.
- VuNetworkImage / VuImage — opt-in
image.loadspans for network images.
Dio instrumentation lives in the separate vunet_flutter_plugin_dio package.
cached_network_image instrumentation lives in
vunet_flutter_plugin_cached_network_image.
Classes
- InitializationParams
- Configuration passed to VuTelemetry.initialize.
- InstrumentationsConfig
- Dart-layer auto-instrumentation toggles for VuTelemetry.initialize.
- InteractionTypes
-
The set of
interaction.typevalues emitted onui.interactionspans. - RouteObserverService
-
A NavigatorObserver that emits a
ui.navigationspan on every top-level page transition and opens an action window so subsequent spans parent to the navigation. - ScreenNameSpanProcessor
- Stamps the current screen name onto every span at start time.
- TabObservation
- A live subscription to a TabController's selection.
- TrackedHttpClient
-
A
package:httpBaseClientwrapper that emits a client span for every request, injects W3C Trace Context Level 1 (traceparentversion00) into outbound headers, and records incubating HTTP catalog attributes and phase events. - TrackedHttpOverrides
-
HttpOverrides that instruments low-level
dart:ioHttpClient requests, emitting a client span with W3C Trace Context Level 1 (traceparentversion00) injected into headers. - VuAction
-
A scoped unit of work mapped to an OpenTelemetry span (Android/iOS
VuActionparity). - VuImage
- Thin widget helpers that use instrumented image providers.
- VuIndexScope
-
Instruments a tab surface driven by a plain index and
setState, where no controller exists — Material 3NavigationBar,BottomNavigationBar,IndexedStack, or aPageViewyou drive yourself. - VuNetworkImage
-
Drop-in ImageProvider that emits Android-parity
image.loadspans. - VuTabScope
- Instruments a TabController-driven tab surface.
- VuTelemetry
- Entry point for the vuTelemetry RUM SDK.
Enums
- SdkLogLevel
- Developer-facing verbosity for SDK diagnostic logs.
Functions
-
createInstrumentedHttpClient(
{SecurityContext? context}) → HttpClient -
Creates an HttpClient whose
connectionFactoryrecords DNS + TCP connect durations into the current HttpClientConnectTiming zone value.
Typedefs
-
HttpConnectionFactory
= Future<
ConnectionTask< Function(Uri url, String? proxyHost, int? proxyPort)Socket> > - Signature of HttpClient.connectionFactory.