debug_kit_dio 0.3.0

Dio network logging adapter for DebugKit. Automatically logs requests, responses, and errors with sanitization.

DebugKit Dio Adapter

A Dio network logging adapter for DebugKit.

Automatically logs Dio network requests, responses, and errors into the DebugKit in-app console with sanitization and lifecycle tracking.

Installation

Add both debug_kit and debug_kit_dio to your pubspec.yaml:

dependencies:
  debug_kit: ^0.6.0
  debug_kit_dio: ^0.3.0

Setup

Initialize DebugKit and pass a DebugKitDioAdapter in the adapters list:

import 'package:dio/dio.dart';
import 'package:debug_kit/debug_kit.dart';
import 'package:debug_kit_dio/debug_kit_dio.dart';

void main() {
  final dio = Dio();

  DebugKit.init(
    enabled: true,
    adapters: [
      DebugKitDioAdapter(dio),
    ],
  );

  runApp(const MyApp());
}

Alternatively, add the interceptor directly to an existing Dio instance:

dio.interceptors.add(DebugKitDioInterceptor(DebugKit.controller));

What is Logged

• HTTP method and sanitized URL (query params masked)
• HTTP path and request phase metadata for DebugKit Network Summary
• Response status code, duration, and phase updates
• Error type and message on failure
• Backend correlation IDs from allowlisted response headers only
• Cancelled request status

The adapter also feeds the DebugKit Network Summary tab with generic aggregates such as total requests, status families, slow endpoints, and backend correlation IDs.

What is NOT Logged

• Request bodies — never logged to prevent PII leakage
• Response bodies — never logged by default
• Binary or multipart payloads — always ignored
• Authorization, Cookie, Set-Cookie, or arbitrary response headers — not stored
• Raw backend headers outside the allowlist below

Security & Sanitization

• URLs: Sensitive query parameters (e.g., api_key, token, password) are masked using smart length-aware masking.
• Response headers: Only the allowlisted backend correlation headers below are captured, and values are sanitized and truncated to 64 characters.
• Bodies: Request and response bodies are never captured.

Allowlisted backend correlation headers

• x-request-id and request-id → backendRequestId
• x-correlation-id → backendCorrelationId
• x-trace-id and trace-id → backendTraceId

Performance

Zero overhead when DebugKit is disabled (enabled: false). The interceptor checks the enabled flag synchronously before any work and never blocks the Dio handler chain.

Limitations

• Request and response bodies are not logged. Opt-in body logging is not yet supported.
• Binary and multipart payloads are always ignored.

Links

• DebugKit Core
• Example App

Compatibility

debug_kit_dio	debug_kit
0.3.x	≥ 0.6.0

License

MIT