layerx_debugger library
LayerX Debugger — a drop-in debugger and logger for Flutter and GetX.
Import this single library to access the entire public API:
import 'package:layerx_debugger/layerx_debugger.dart';
Future<void> main() async {
WidgetsFlutterBinding.ensureInitialized();
await LayerXDebugger.initialize();
runApp(const MyApp());
}
See the README for HTTP capture (and the optional Dio recipe), route observers, GetX integration, crash handling, performance profiling and the in-app log viewer.
Classes
- LayerXArchitectureDetector
- Best-effort, runtime architecture detection for LayerX.
- LayerXArchitectureReport
- The result of LayerX's best-effort architecture detection.
- LayerXBindings
- Registers the LayerX GetX services as permanent singletons.
- LayerXBlameEngine
- Analyzes a log entry and attributes the most likely owner of the problem.
- LayerXBlameInfo
- The result of a blame analysis: who most likely owns a failure and what QA should write in the bug report.
- LayerXController
-
A drop-in
GetxControllerwhose lifecycle is logged by LayerX. - LayerXCrashHandler
- Captures uncaught errors from every source and records them as log entries.
- LayerXCrashService
- A GetX service that owns global crash capture.
- LayerXDebugConfig
- Immutable configuration for LayerX, passed to LayerXDebugger.initialize.
- LayerXDebugger
- The entry point for LayerX — initialize it once and everything starts working automatically.
- LayerXDebugOverlay
- Hosts the in-app LayerX log viewer above your application.
- LayerXDebugService
- The orchestrating GetX service for the LayerX debugger.
- LayerXDebugSettingsButton
- A ready-made list tile that opens the LayerX log viewer.
- LayerXDebugWidget
- Wraps a widget and logs how many times it rebuilds.
- LayerXHttp
-
Thin logging wrappers around
package:http. - LayerXJourneyStep
- A single step in the reconstructed "journey" that led to a log entry.
- LayerXLog
- The primary logging entry point for LayerX.
- LayerXLogEntry
- A single, fully-structured log entry stored by LayerX.
- LayerXLoggerService
- A GetX service exposing LayerX logging via dependency injection.
- LayerXLogStore
- The global, in-memory store of every captured LayerXLogEntry.
- LayerXMasker
- Masks sensitive values (passwords, tokens, …) before they are logged.
- LayerXNetworkLogger
- The transport-agnostic core that turns an HTTP exchange into a structured LayerXLogEntry and a colored console box.
- LayerXNetworkService
- A GetX service exposing manual network logging.
- LayerXPerformanceService
- A GetX service exposing LayerX performance profiling.
- LayerXProfiler
- Measures how long operations take and logs the result.
- LayerXRouteMiddleware
-
A GetX
GetMiddlewarethat logs navigation to the pages it is attached to. - LayerXRouteObserver
- A NavigatorObserver that records route pushes, pops and replacements.
- LayerXRouteService
- A GetX service exposing the shared LayerXRouteObserver.
- LayerXSchemaChange
- One field-level difference between two API responses for the same endpoint.
- LayerXService
-
A drop-in
GetxServicewhose lifecycle is logged by LayerX.
Enums
- LayerXEdgeZone
- Where the edge-swipe gesture that opens the in-app viewer lives.
- LayerXEnvironment
- The runtime environment LayerX is operating in.
- LayerXLogLevel
- Severity levels recorded by LayerX, ordered from least to most severe.
- LayerXLogSource
- The most likely origin of a log entry.
- LayerXSchemaDiffType
- The kind of difference detected between two API responses for the same endpoint.
Mixins
- LayerXDebugMixin
- Adds LayerX lifecycle logging to any GetX controller or service.
Extensions
- LayerXLogX on Object?
- Convenience logging methods on any value.
Typedefs
- LayerXCrashCallback = void Function(Object error, StackTrace stackTrace, bool fatal)
- Signature for the optional crash-forwarding callback.