Flutter Awesome Logger 🚀 #

A comprehensive Flutter logging package that makes debugging a breeze!

Features a floating logger, automatic API logging with Dio interceptor, and a beautiful UI for viewing logs.

📖 Documentation • 🚀 Installation • 💡 Examples • 🎨 Customization

📋 Table of Contents #

✨ Features
📸 Screenshots
🚀 Getting Started
🔧 Configuration Options
📚 Advanced Usage
🎨 Customization
🤝 Contributing
📝 License
🐛 Issues & Support
📞 Connect With Us

✨ Features #

Feature	Description
📱 Floating Logger Button	Always accessible debug button that floats over your app - drag to reposition, auto-snaps to edges
👆 Long Press Floating Button	Tap: Opens logger UI instantly • Long Press: Shows quick actions menu • Drag: Repositions button • Double Tap: Toggles pause/resume logging
🤳 Shake to Toggle	Shake your device to show/hide the floating logger button - perfect for quick access during testing
🤳 Shake to Enable	Shake your device to enable the logger when disabled - ideal for production builds with hidden debug access
🌐 Automatic API Logging	Built-in Dio interceptor for seamless API logging - captures requests, responses, errors, and timing automatically
🎨 Beautiful UI	Clean, modern interface with syntax highlighting - dark/light themes, collapsible sections, and intuitive navigation
📊 Multiple Log Levels	Support for debug, info, warning, error, and verbose logs - color-coded with filtering and search capabilities
💾 Smart Storage	Logs stored only when logger is enabled - conserves memory and respects privacy settings
⏸️ Pause/Resume Logging	Temporarily pause all logging with visual indicators - useful for focusing on specific app sections
🔍 Search & Filter	Easily find specific logs with advanced filtering - search by text, level, timestamp, or source file
🎯 Simple Configuration	Single `enabled` property controls both UI and storage - async support for conditional initialization
📱 Responsive Design	Works perfectly on all screen sizes - adaptive layouts for phones, tablets, and different orientations

📸 Screenshots #

🖼️ App Screenshots Gallery #

🎯 Floating Logger Button Always accessible debug interface	🌐 API Logs View Comprehensive API request/response logging

📊 General Logs View Beautiful log interface with filtering	🔍 Log Details Detailed log inspection with syntax highlighting

🚀 Getting Started #

Installation #

📦 Add to your `pubspec.yaml`

dependencies:
  flutter_awesome_logger: ^latest_version

🔄 Install the package

# Using Flutter CLI
flutter pub get

# Or using Dart CLI
dart pub get

📱 Import in your Dart code

import 'package:flutter_awesome_logger/flutter_awesome_logger.dart';

Basic Usage #

⚡ Easiest Setup (Just 2 Lines!)

The absolute simplest way to get started - just wrap your app:

import 'package:flutter/material.dart';
import 'package:flutter_awesome_logger/flutter_awesome_logger.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: FlutterAwesomeLogger(
        child: YourHomePage(), // Your existing home page
      ),
    );
  }
}

That's it! 🎉 The logger is now active with default settings. You'll see:

📱 Floating logger button on your screen
🤳 Shake-to-toggle functionality enabled
📊 Both API logs and general logs tabs ready

📋 How to Get Logs in Each Tab #

🌐 API Logs Tab #

For HTTP requests and responses

To populate the API Logs tab with your HTTP requests, add the Dio interceptor:

Step 1: Add the interceptor to your Dio instance

import 'package:dio/dio.dart';
import 'package:flutter_awesome_logger/flutter_awesome_logger.dart';

final dio = Dio();
dio.interceptors.add(FlutterAwesomeLoggerDioInterceptor());

// Now all API calls are automatically logged!
final response = await dio.get('https://api.example.com/data');

What you get:

✅ Automatic capture - All requests and responses logged automatically
✅ cURL generation - Copy-paste ready cURL commands for testing
✅ Error handling - Network errors and HTTP errors captured
✅ Performance timing - Request duration tracking
✅ Advanced filtering - Filter by status code, method, or endpoint
✅ Search functionality - Search through URLs, headers, and response content

📊 General Logs Tab #

For application logs and debugging

To populate the General Logs tab with your application logs:

Step 1: Create a logger instance // Create global logger instance (recommended: make a new file eg. my_logger.dart)

import 'package:flutter_awesome_logger/flutter_awesome_logger.dart';

final logger = FlutterAwesomeLogger.loggingUsingLogger;

Step 2: Use the logger throughout your app

import 'my_logger.dart';

class MyService {
  void performOperation() {
    // Debug information (development only)
    logger.d('Starting complex operation with parameters: $params');
    
    // General information (important events)
    logger.i('User logged in successfully');
    
    // Warnings (potential issues)
    logger.w('API rate limit approaching: ${remaining} requests left');
    
    // Errors (with full context)
    try {
      // Your code here
    } catch (e, stackTrace) {
      logger.e('Failed to process user data', error: e, stackTrace: stackTrace);
    }
  }
}

What you get:

✅ Multiple log levels - DEBUG (grey), INFO (blue), WARNING (orange), ERROR (red)
✅ Stack trace support - Full error context with file paths and line numbers
✅ Source tracking - See exactly which file and method generated each log
✅ Advanced filtering - Filter by log level, source file, or search content
✅ Export capabilities - Copy individual logs or export entire filtered sets
✅ Real-time updates - Logs appear instantly as your app runs

🔧 Configuration Options #

⚙️ Flexible Configuration System #

🎛️ FlutterAwesomeLogger Configuration

The enabled parameter supports both synchronous and asynchronous initialization:

🟢 Immediate Enable

enabled: true

Logger starts immediately

🔴 Immediate Disable

enabled: false

Logger is disabled

⏳ Async Enable

enabled: someFuture()

Waits for Future resolution

📊 AwesomeLoggerConfig

Core logging behavior configuration

Property	Type	Default	Description
`maxLogEntries`	`int`	`1000`	Maximum number of log entries to keep in memory
`showFilePaths`	`bool`	`true`	Display file paths in console output
`showEmojis`	`bool`	`true`	Show emojis in console output for better readability
`useColors`	`bool`	`true`	Enable colored console output
`stackTraceLines`	`int`	`0`	Number of stack trace lines to display

const AwesomeLoggerConfig({
  int maxLogEntries = 1000,
  bool showFilePaths = true,
  bool showEmojis = true,
  bool useColors = true,
  int stackTraceLines = 0,
});

🎨 FloatingLoggerConfig

Floating button UI and behavior configuration

Property	Type	Default	Description
`backgroundColor`	`Color`	`Colors.deepPurple`	Background color of the floating button
`icon`	`IconData`	`Icons.developer_mode`	Icon displayed on the floating button
`showCount`	`bool`	`true`	Display log count badge on button
`enableGestures`	`bool`	`true`	Enable drag gestures for repositioning
`autoSnapToEdges`	`bool`	`true`	Automatically snap button to screen edges
`size`	`double`	`60.0`	Size of the floating button
`enableShakeToShowHideFloatingButton`	`bool`	`true`	Enable shake-to-toggle button visibility
`enableShakeToEnableLogger`	`bool`	`true`	Enable shake-to-enable logger when disabled
`shakeSensitivity`	`int`	`8`	Shake sensitivity (1-15, higher = less sensitive)

const FloatingLoggerConfig({
  Color backgroundColor = Colors.deepPurple,
  IconData icon = Icons.developer_mode,
  bool showCount = true,
  bool enableGestures = true,
  bool autoSnapToEdges = true,
  double size = 60.0,
  bool enableShakeToShowHideFloatingButton = true,
  bool enableShakeToEnableLogger = true,
  int shakeSensitivity = 8,
});

📚 Advanced Usage #

Accessing Log History #

// Get all stored logs
final logs = FlutterAwesomeLogger.getLogs();

// Get logs by level
final errorLogs = FlutterAwesomeLogger.getLogsByLevel('ERROR');

// Get recent logs
final recentLogs = FlutterAwesomeLogger.getRecentLogs(
  duration: Duration(minutes: 10),
);

// Clear all logs
FlutterAwesomeLogger.clearLogs();

// Export logs as formatted text
String exportedLogs = FlutterAwesomeLogger.exportLogs();

Programmatically Show Logger UI #

// Show the logger history page
Navigator.push(
  context,
  MaterialPageRoute(
    builder: (context) => const LoggerHistoryPage(),
  ),
);

Pause/Resume Logging #

// Pause all logging (both console and storage)
FlutterAwesomeLogger.setPauseLogging(true);

// Resume logging
FlutterAwesomeLogger.setPauseLogging(false);

// Check if logging is paused
bool isPaused = FlutterAwesomeLogger.isPaused;

Control Floating Logger Visibility #

// Check if floating logger is visible
bool isVisible = FlutterAwesomeLogger.isVisible();

// Show/hide the floating logger
FlutterAwesomeLogger.setVisible(true);  // Show
FlutterAwesomeLogger.setVisible(false); // Hide

// Toggle visibility
FlutterAwesomeLogger.toggleVisibility();

Manage API Logs #

// Get all API logs
final apiLogs = FlutterAwesomeLogger.getApiLogs();

// Get API logs by type
final successLogs = FlutterAwesomeLogger.getApiLogsByType(ApiLogType.success);
final errorLogs = FlutterAwesomeLogger.getApiLogsByType(ApiLogType.serverError);

// Clear API logs
FlutterAwesomeLogger.clearApiLogs();

🎨 Customization #

The logger UI is highly customizable. You can:

Change colors and themes
Customize the floating button appearance
Configure log display formats
Add custom filters and search options
Pause/resume logging as needed
Control logging behavior with simple configuration
Enable/disable shake-to-toggle functionality
Enable/disable shake-to-enable functionality for production builds
Adjust shake sensitivity for different devices

🤝 Contributing #

We welcome contributions!

Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

🔧 Contribute • 📋 Issues • 💡 Feature Requests

📝 License #

This project is licensed under the MIT License - see the LICENSE file for details.

🐛 Issues & Support #

🐛 Bug Reports #

Found a bug? Let us know!

Report Bug

💡 Feature Requests #

Have an idea? Share it!

Request Feature

💬 Discussions #

Join the conversation!

Start Discussion

📞 Connect With Us #

⭐ Show Your Support #

If this package helped you, please consider giving it a ⭐ on GitHub!

_{Made with ❤️ by codeastartup01dev}

flutter_awesome_logger 1.1.1 flutter_awesome_logger: ^1.1.1 copied to clipboard

Metadata