loggy 1.0.1

Logger for Dart applications, use mixin for easier separation when needed

Loggy

Customizable logger for dart.

Usage

To start using Loggy you first have to init Loggy, this will make RootLoggy without a name and set up all the options that other loggers in the app will follow.

import 'package:loggy/loggy.dart';

main() {
  // Call this as soon as possible (Above runApp)
  Loggy.initLoggy();
}

You can customize logger on init with following:

Loggy.initLoggy(
    // Different or custom printer.
    // Available printers are: DefaultPrinter, DeveloperPrinter and PrettyPrinter
    logPrinter: const PrettyPrinter(),
    
    // Set what log levels you would like to see in the app, levels are: all, debug, info, warning, error, off
    // Including caller info is expensive operation, that's why this defaults to false
    // You can also set [stackTraceLogLevel] that will fetch and show stack trace before the log was called
    logOptions: const LogLevel(
      LogLevel.all,
      includeCallerInfo: true,
      stackTraceLogLevel: LogLevel.warning
    ),
    
    // You can also blacklist some logger types, blacklisted loggers are not shown
    blacklist: [BlacklistedLoggy],

    // You can also whitelist some logger types, whitelisted loggers are the ONLY ones being shown
    whitelist: [NetworkLoggy],
  );

After that you can start using logger in your app, lib will provide you with 2 predefined LoggyTypes, you can also make custom one and use that instead.

class MyAppScreen with UiLoggy{
  MyAppScreen(){
    loggy.debug('DebugMessage');
    loggy.info('InfoMessage');
    loggy.warning('WarningMessage');
    loggy.error('ErrorMessage');
  }
}

If you have initialized the Loggy just with PrettyPrinter then your log should look something like this:

🐛 15:52:16.186827 DEBUG    UI Loggy - MyAppScreen - DebugMessage
👻 15:52:16.194803 INFO     UI Loggy - MyAppScreen - InfoMessage
⚠️ 15:52:16.194970 WARNING  UI Loggy - MyAppScreen - WarningMessage
‼️ 15:52:16.195113 ERROR    UI Loggy - MyAppScreen - ErrorMessage

You can pass closure to the Loggy as well, closure will get evaluated only if/when log gets called and should be shown.

loggy.info(() {
  /// You can do what you want here!
  const _s = 0 / 0;
  return List.generate(10, (_) => _s)
          .fold<String>('', (previousValue, element) => previousValue += element.toString()) +
      ' Batman';
});

Custom loggers

You can have as many custom loggers as you want, by default you are provided with 2 types: NetworkLoggy and UiLoggy

To make custom logger you just need to make new mixin that implements LoggyType and returns new logger with mixin type:

mixin CustomLoggy implements LoggyType {
  @override
  Loggy<CustomLoggy> get loggy => Loggy<CustomLoggy>('My Custom Loggy');
}

Then to use it just add with CustomLoggy to class where you want to use it.

Custom log levels and expanding existing printers

You can add new LogLevel to log like this:

extension WtfLevel on LogLevel {
  // LogLevel is just a class with `name` and `priority`. Priority can go from 1 - 99 inclusive.
  static const LogLevel wtf = LogLevel('WTF', 32);
}

When adding a new level it's also recommended extending the Loggy class as well to add quick function for that level.

extension WtfLoggy on Loggy {
  void wtf(dynamic message, [Object error, StackTrace stackTrace]) => log(WtfLevel.wtf, message, error, stackTrace);
}

More loggers?

Do you need more loggers? No problem! When you include with LoggyA you can make new loggers with loggy(name) or detachedLoggy(name).

Child logger

loggy(name) will create new child logger that will be connected to parent logger and share the same options.

Detached logger

detachedLoggy(name) is logger that has nothing to do with our RootLoggy and all options will be ignored. This can be helpful if you have small part of code you want to log but don't want to depend on other options or LogLevels.

Features and bugs

Please file feature requests and bugs at the issue tracker.