AquabaseLogs class
Client-side log collector with auto-batching over WebSocket.
Buffers log entries in memory, flushing them as a single binary frame (OP_LOG_PUSH) when the buffer reaches batchSize entries or flushInterval elapses.
- Mixed-in types
Constructors
- AquabaseLogs({required String apiKey, String? projectId, String? jwt, String serverUrl = aquabaseDefaultServerUrl, int batchSize = 500, Duration flushInterval = const Duration(milliseconds: 1000), bool captureErrors = true, int maxBufferSize = 10000})
-
Creates a log client. Only
apiKeyis required. - AquabaseLogs.withUri({required Uri wsUri, String? jwt, int batchSize = 500, Duration flushInterval = const Duration(milliseconds: 1000), bool captureErrors = true, int maxBufferSize = 10000})
- Advanced: provide a raw WebSocket URI directly.
Properties
- batchSize → int
-
final
- bufferedCount → int
-
no setter
- captureErrors → bool
-
final
- defaultSource → String
-
The auto-detected source string for this device.
Available after connect completes.
no setter
- flushInterval → Duration
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isConnected → bool
-
no setter
- maxBufferSize → int
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
captureFlutterErrors(
) → void - Installs global error handlers that forward uncaught Flutter errors and platform exceptions to this log client.
-
connect(
) → Future< void> - Connect to the server. Auto-called on first push if needed.
-
debug(
String channel, String message, {String source = ''}) → void -
didChangeAccessibilityFeatures(
) → void -
Called when the system changes the set of currently active accessibility
features.
inherited
-
didChangeAppLifecycleState(
AppLifecycleState state) → void -
Called when the system puts the app in the background or returns
the app to the foreground.
override
-
didChangeLocales(
List< Locale> ? locales) → void -
Called when the system tells the app that the user's locale has
changed. For example, if the user changes the system language
settings.
inherited
-
didChangeMetrics(
) → void -
Called when the application's dimensions change. For example,
when a phone is rotated.
inherited
-
didChangePlatformBrightness(
) → void -
Called when the platform brightness changes.
inherited
-
didChangeTextScaleFactor(
) → void -
Called when the platform's text scale factor changes.
inherited
-
didChangeViewFocus(
ViewFocusEvent event) → void -
Called whenever the PlatformDispatcher receives a notification that the
focus state on a view has changed.
inherited
-
didHaveMemoryPressure(
) → void -
Called when the system is running low on memory.
inherited
-
didPopRoute(
) → Future< bool> -
Called when the system tells the app to pop the current route, such as
after a system back button press or back gesture.
inherited
-
didPushRoute(
String route) → Future< bool> -
Called when the host tells the application to push a new route onto the
navigator.
inherited
-
didPushRouteInformation(
RouteInformation routeInformation) → Future< bool> -
Called when the host tells the application to push a new
RouteInformation and a restoration state onto the router.
inherited
-
didRequestAppExit(
) → Future< AppExitResponse> -
Called when a request is received from the system to exit the application.
inherited
-
dispose(
) → void - Dispose and release all resources.
-
error(
String channel, String message, {String source = ''}) → void -
flush(
) → Future< void> - Flush buffered entries to the server immediately.
-
handleCancelBackGesture(
) → void -
Called when a predictive back gesture is canceled, indicating that no
navigation should occur.
inherited
-
handleCommitBackGesture(
) → void -
Called when a predictive back gesture is finished successfully, indicating
that the current route should be popped.
inherited
-
handleStartBackGesture(
PredictiveBackEvent backEvent) → bool -
Called at the start of a predictive back gesture.
inherited
-
handleStatusBarTap(
) → void -
Called when the user taps the status bar on iOS, to scroll a scroll
view to the top.
inherited
-
handleUpdateBackGestureProgress(
PredictiveBackEvent backEvent) → void -
Called when a predictive back gesture moves.
inherited
-
info(
String channel, String message, {String source = ''}) → void -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
push(
LogEntry entry) → void - Push a single log entry. Buffered until auto-flush.
-
query(
[LogQueryOptions opts = const LogQueryOptions()]) → Future< List< LogRecord> > - Query logs from the server.
-
toString(
) → String -
A string representation of this object.
inherited
-
trace(
String channel, String message, {String source = ''}) → void -
warn(
String channel, String message, {String source = ''}) → void
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited