BloomObservabilityConfig class

Configuration options for Bloom Error Observability and Telemetry SDK.

Example:

final config = BloomObservabilityConfig(
  enabled: true,
  sampleRate: 1.0,
  autoCaptureFlutterErrors: true,
  autoCaptureZoneErrors: true,
  transport: BloomHttpTelemetryTransport(
    endpoint: Uri.parse('https://telemetry.example.com/events'),
  ),
);

Constructors

BloomObservabilityConfig({bool enabled = true, double sampleRate = 1.0, bool autoCaptureFlutterErrors = true, bool autoCaptureZoneErrors = true, bool autoCaptureNativeCrashes = false, int maxBreadcrumbs = 100, BloomTelemetryTransport? transport, BeforeSendCallback? beforeSend, Map<String, dynamic> appInfo = const {}, Map<String, dynamic> tags = const {}, String? runtimeFingerprint, String? bloomVersion, String? flutterVersion, String? channel, String? activePatchId, String? buildNumber})
Creates a BloomObservabilityConfig options instance.

Properties

activePatchId → String?
Active Shorebird OTA patch identifier.
final
appInfo → Map<String, dynamic>
Application metadata dictionary.
final
autoCaptureFlutterErrors → bool
Whether to automatically capture Flutter widget framework errors.
final
autoCaptureNativeCrashes → bool
Whether to capture native iOS/Android crashes via native channel bridge.
final
autoCaptureZoneErrors → bool
Whether to automatically capture asynchronous zone errors via PlatformDispatcher.
final
beforeSend → BeforeSendCallback?
Optional filter / mutation callback invoked before sending an event.
final
bloomVersion → String?
Bloom framework version string.
final
buildNumber → String?
Application build number.
final
channel → String?
Release deployment channel.
final
enabled → bool
Whether observability telemetry capturing is enabled.
final
flutterVersion → String?
Flutter runtime version string.
final
hashCode → int
The hash code for this object.
no setterinherited
maxBreadcrumbs → int
Maximum capacity of in-memory breadcrumbs ring buffer.
final
runtimeFingerprint → String?
Active runtime binary fingerprint hash override.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sampleRate → double
Sampling rate between 0.0 (0%) and 1.0 (100%).
final
tags → Map<String, dynamic>
Global tags attached to all captured events.
final
transport → BloomTelemetryTransport
Telemetry transport used to transmit event payloads.
final

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