ispect library

Classes

AnalyticsLog
AnalyticsLog - This class contains the analytics log.
AnsiPen
Pen attributes for foreground and background colors.
BaseLogsFile
Abstract base class for cross-platform log file operations.
CompositeRedactionStrategy
Runs multiple strategies in order and returns the first redaction result.
ConsoleUtils
A utility class for console output formatting.
CurlUtils
Utility class for generating cURL commands from HTTP request data.
DefaultISpectLoggerHistory
The default implementation of ILogHistory for managing log history.
DraggablePanel
DraggablePanel is a widget that can be dragged around the screen and can be docked to the nearest edge of the screen. It can be used to create a floating panel that can be used to show additional information or actions.
DraggablePanelButtonItem
Represents a button item in the draggable panel.
DraggablePanelButtonThemeData
Theme data for panel action buttons.
DraggablePanelController
A controller to manage the state and behavior of a draggable panel.
DraggablePanelHandleThemeData
Theme data for the draggable handle (the visual indicator on the button).
DraggablePanelItem
Represents an item in the draggable panel.
DraggablePanelItemThemeData
Theme data for panel item badges (icon cells in the grid).
DraggablePanelTheme
Defines the visual properties of a DraggablePanel.
DraggablePanelTooltipThemeData
Theme data for tooltip snackbars shown on long-press.
FileLogHistory
Extended interface for log history with daily file system support.
Filter<T>
An abstract class defining a filter interface.
GoodLog
GoodLog - This class contains the basic structure of the log.
ILogHistory
An abstract class representing a log history storage.
ISpect
The main entry point for initializing and managing logging/error handling.
ISpectActionItem
ISpectBaseLogger
ISpectBuilder
A widget that wraps your app with ISpect debugging tools.
ISpectColumnBuilder
  • ISpectColumnBuilder - This widget is designed to build a column layout with a specified number of child widgets, which are generated dynamically based on an IndexedWidgetBuilder function.
    • ISpectDateTimeFormatter
    A utility class for formatting DateTime objects into readable strings.
    ISpectDynamicColor
    ISpectErrorHandler
    A utility class for handling errors and exceptions in ISpectLogger.
    ISpectFileUtils
    A utility class for file-related operations on Web platforms.
    ISpectFilter
    A composite filter that combines multiple filtering criteria.
    ISpectGeneratedLocalization
    Callers can lookup localized strings with an instance of ISpectGeneratedLocalization returned by ISpectGeneratedLocalization.of(context).
    ISpectLocalization
    Localization class which is used to localize app. This class provides handy methods and tools.
    ISpectLocalizations
    ISpectLogData
    A model class representing a structured log entry.
    ISpectLogDataJsonUtils
    Utility class for ISpectLogData JSON operations.
    ISpectLogError
    ISpectLogException
    ISpectLogger
    A customizable logging and inspection utility for mobile applications.
    ISpectLoggerOptions
    Configuration options for ISpectLogger logging.
    ISpectLogOptions
    Options for configuring ISpect's log handling capabilities.
    ISpectNavigatorObserver
    A custom NavigatorObserver for logging navigation events.
    ISpectObserver
    An abstract observer class for monitoring ISpectLogger events.
    ISpectOptions
    A configuration class for ISpect, defining various options including locale settings, feature toggles, action items, and panel configurations.
    ISpectPanelButtonItem
    A labelled button displayed in the ISpect expanded panel menu.
    ISpectPanelItem
    An item displayed in the ISpect floating panel.
    ISpectScopeController
    Provides the ISpectScopeModel to the widget tree.
    ISpectScopeModel
    A model class that holds the state of the ISpect scope.
    ISpectSettingsState
    Represents the current state of ISpect settings.
    ISpectShareRequest
    Describes content to pass into a custom share handler.
    ISpectTheme
    Defines the theme configuration for ISpect, including colors, icons, and log descriptions.
    ISpectToaster
    A utility class for displaying various types of toast notifications using SnackBar.
    JsonScreen
    JsonTruncatorService
    Service to pretty-print JSON objects with a maximum depth limit. Deeper nested values are replaced with "...".
    KeyBasedRedaction
    Redacts values based on sensitive key names.
    LogDetails
    LoggerSettings
    Configuration settings for ISpectLogger logger.
    LogsFileFactory
    Factory class for creating platform-appropriate log file handlers.
    LogsJsonService
    Service for managing JSON export/import operations for logs.
    LogTypeKeyFilter
    A filter that checks whether an ISpectLogData item matches any of the specified log type keys.
    MultiValueListenableBuilder
    A widget that rebuilds when any of multiple ValueListenables change.
    NativeLogsFile
    Native platform implementation for log file operations.
    NetworkErrorLog
    NetworkLogPrintOptions
    Abstraction describing print preferences and color configuration for network-related logs.
    NetworkPayloadSanitizer
    Provides reusable sanitization helpers for network payloads.
    NetworkRequestLog
    NetworkResponseLog
    NetworkTransaction
    Groups a correlated HTTP request with its response or error.
    PatternBasedRedaction
    Redacts based on content patterns (tokens, JWTs, base64, binary).
    PrintLog
    PrintLog - This class contains the print log.
    ProviderLog
    ProviderLog - This class contains the provider log.
    RedactionRuntime
    Provides redaction helpers and configuration to strategies at runtime.
    RedactionService
    A configurable service that redacts sensitive values in headers and payloads.
    RedactionStrategy
    Redaction strategy interface.
    RequestIdGenerator
    Generates lightweight, unique request IDs for correlating network request/response/error logs within a session.
    RouteLog
    RouteLog - This class contains the route log.
    SearchFilter
    A filter that performs a case-insensitive search within the message, textMessage, or additionalData fields of ISpectLogData.
    SessionStatistics
    Comprehensive statistics about the current log session.
    TitleFilter
    A filter that checks whether an ISpectLogData item matches any of the specified titles.
    TooltipSnackBar
    Custom SnackBar widget for showing tooltips in DraggablePanel.
    TypeFilter
    A filter that checks whether an ISpectLogData item matches any of the specified runtime types.
    WebLogsFile
    Web platform implementation for log file operations.

    Enums

    DockType
    Defines how the draggable panel button docks to screen edges.
    ISpectLogType
    Enum representing various log types used in the ISpectLogger library.
    LogLevel
    PanelState
    Represents the current state of the draggable panel.
    SessionCleanupStrategy
    Strategy for cleaning up old log files when session limit is exceeded.

    Mixins

    BaseNetworkInterceptor
    Mixin providing common functionality for network interceptors.

    Extensions

    HistoryListFlutterText on List<ISpectLogData>
    Extension on List<ISpectLogData> to format history text output.
    ISpectDataX on ISpectLogData
    Extension on ISpectLogData for additional functionalities.
    ISpectFlutter on ISpectLogger
    Extension on ISpectLogger for Flutter-specific configurations.
    ISpectLogDataSerialization on ISpectLogData
    Extension for ISpectLogData to add JSON serialization support.
    ISpectLogTypeExt on ISpectLogType
    ISpectStringExtension on String?
    An extension on nullable String to provide additional utility methods.
    LogLevelX on LogLevel
    StringBufferExtension on StringBuffer
    Extension on StringBuffer to conditionally write a line.

    Constants

    ansi_default → const String
    ansi_esc → const String
    ansiDefault → const String
    Reset all colors and options for current SGRs to terminal defaults.
    ansiEscape → const String
    ANSI Control Sequence Introducer, signals the terminal for new settings.
    ansiResetBackground → const String
    Ansi codes that default the terminal's background color without altering the foreground, when printed.
    ansiResetForeground → const String
    Ansi codes that default the terminal's foreground color without altering the background, when printed.
    encoder → const JsonEncoder
    JSON encoder with indentation for pretty-printing.
    kDefaultSensitiveKeys → const Set<String>
    The canonical set of sensitive key names used for redaction across all ispect packages. This is the single source of truth — other packages (e.g. ispectify_db) reference this constant instead of maintaining their own lists.
    kISpectEnabled → const bool
    Compile-time constant to enable/disable ISpect via --dart-define.
    kRequestIdKey → const String
    Key used to store the request ID in ISpectLogData.additionalData.

    Properties

    ansiColorDisabled ↔ bool
    Globally enable or disable AnsiPen settings.
    getter/setter pair
    color_disabled ↔ bool
    getter/setter pair

    Typedefs

    ISpectLoadLogContentCallback = Future<String?> Function(BuildContext context)
    ISpectLogDataBuilder = Widget Function(BuildContext context, ISpectLogData data)
    Signature for build custom ISpectLogData widgets
    ISpectLogErrorBuilder = Widget Function(BuildContext context, ISpectLogError data)
    Signature for build custom ISpectLogError messages in showing Snackbar or another widgets
    ISpectLogExceptionBuilder = Widget Function(BuildContext context, ISpectLogException data)
    Signature for build custom ISpectLogException messages in showing Snackbar or another widgets
    ISpectObserverDisposer = void Function()
    ISpectOpenFileCallback = Future<void> Function(String path)
    ISpectSettingsChangedCallback = void Function(ISpectSettingsState settings)
    Called when ISpect settings change (logger options, enabled log types, etc.).
    ISpectShareCallback = Future<void> Function(ISpectShareRequest request)
    LoggerOutput = void Function(String message, {Object? error, LogLevel? logLevel, StackTrace? stackTrace, DateTime? time})
    A logger class for structured and formatted logging.
    PositionListener = void Function(double x, double y)
    Signature for position change listeners.