custom_logger

Create a custom logger with different levels in just a few seconds.

Firebase Crashlytics integration

This brick adds the firebase_crashlytics package and implements this service inside the custom logger for you. (Native configuration is still needed to make it work so follow the official docs here)

How to use 🚀

mason make custom_logger --logger_name custom

Variables ✨

Outputs 📦

--logger_name custom 
├── custom_logger
│   ├── lib
│   │   ├── src
│   │   │   ├── contract
│   │   │   │   ├── custom_logger_contract.dart
|   |   |   ├── log_levels
│   │   │   │   ├── log_levels.dart
│   │   │   ├── custom_logger.dart
│   │   └── custom_logger.dart
│   ├── test
│   │   └── src
│   │       └── custom_logger_test.dart
│   ├── .gitignore
│   ├── analysis_options.yaml
│   ├── pubspec.yaml
│   └── README.md
└── ...

```dart
import 'dart:developer' as dev show log;

import 'package:firebase_crashlytics/firebase_crashlytics.dart';
import 'package:flutter/foundation.dart';
import 'contract/custom_contract.dart';
import 'log_levels/log_level.dart';

/// [CustomLogger] is a custom logger that can be used
/// to report errors to another service like Crashlytics
class CustomLogger implements CustomLoggerContract {
  /// [CustomLogger] constructor
  /// (here we initialize Firebase Crashlytics)
  CustomLogger({
    FirebaseCrashlytics? crashlytics,
  }) : _crashlytics = crashlytics ?? FirebaseCrashlytics.instance;

  /// Please complete native configuration before start using Crashlytics.
  /// For more info visit:
  /// https://firebase.google.com/docs/crashlytics/get-started?platform=flutter
  final FirebaseCrashlytics _crashlytics;

  @override
  void debug(String message) {
    _log(message, level: LogLevel.debug);
  }

  @override
  void info(String message) {
    _log(message, level: LogLevel.info);
  }

  @override
  void warning(String message) {
    _log(message, level: LogLevel.warning);
  }

  @override
  void error(String message) {
    _log(message, level: LogLevel.error);

    /// Collect the Crashlytics logs and send to server immediately, only
    /// for high serverity logs
    _throwAndReportError(message);
  }

  @override
  void critical(
    String message,
  ) {
    _log(message, level: LogLevel.critical);

    /// Collect the Crashlytics logs and send to server immediately, only
    /// for high serverity logs
    _throwAndReportError(message);
  }

  @override
  void exception(
    Object error,
    StackTrace stackTrace, {
    Object? reason,
    bool fatal = true,
  }) {
    _log('The following exception occurred: $error', level: LogLevel.critical);

    /// Avoid report while in debug mode
    if (kDebugMode) return;

    _crashlytics.recordError(
      error,
      stackTrace,
      reason: reason,
      fatal: fatal,
    );
  }

  void _log(String message, {LogLevel level = LogLevel.info}) {
    final currentTime = DateTime.now();
    dev.log(
      message,
      level: level.value,
      time: currentTime,
    );

    /// Avoid send log to an external service while in debug
    if (kDebugMode) return;
    _crashlytics.log('${level.name}(level): $message');
  }

  /// Simulate a "crash" so that we can collect the stack trace and report to
  /// crashlytics
  void _throwAndReportError(String message) {
    try {
      throw Exception(message);
    } catch (error, stackTrace) {
      /// Avoid report while in debug mode
      if (kDebugMode) return;

      _crashlytics.recordError(
        error,
        stackTrace,
        reason: message,
        fatal: true,
      );
    }
  }

  @override
  void recordFlutterFatalError(FlutterErrorDetails flutterErrorDetails) {
    /// Avoid report while in debug mode
    if (kDebugMode) return;
    _crashlytics.recordFlutterFatalError(flutterErrorDetails);
  }

  @override
  void recordFlutterError(FlutterErrorDetails flutterErrorDetails) {
    /// Avoid report while in debug mode
    if (kDebugMode) return;
    _crashlytics.recordFlutterError(flutterErrorDetails);
  }
}

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add custom_logger

# Install globally
mason add -g custom_logger

Usage 🚀

mason make custom_logger

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.26 <0.1.0"

0.1.8

• feat: we now create the custom logger as a package so that users can import and use it more easily.
• chore: add README.md to the new package structure.
• chore: update output example in README.md.
• refactor: improve post gen hooks commands.

0.1.7

• fix: remove typo and improve messages.

0.1.6

• chore: add link to crashlytics docs while using that service.
• chore: update readme logger example.

0.1.5

• feat: add recordFlutterFatalError and recordFlutterError methods while using Crashlytics.
• refactor: use dart format instead of the old flutter format (deprecated)

0.1.4

• docs: update README.md (outputs and description)

0.1.3

• fix: run hooks commands in the root folder

0.1.2

• chore: code refactor
• update: README.md

0.1.1

• update: add missing imports and dart fix hook

0.1.0

• update: avoid send logs/errors while in debug mode + TODO's and comments that indicates next steps while using Crashlytics integration or not.

0.0.9

• chore: implement a logger contract and extract log levels into a new folder.

0.0.8

• update: add missing doc in the logger constructor while using Firebase Crashlytics.

0.0.7

• feat: now we can add Firebase Crashlytics inside the logger.
• update: add doc strings and organize imports.

0.0.6

• update: update README.md.

0.0.5

• fix: Now you only need to put the logger name like "custom" and it will create a CustomLogger class.

0.0.4

• update: changelog version.

0.0.3

• update: add logger example in README.md + clean up doc strings.

0.0.2

• update: new default logger_name logger + new how to use section in README.md .

0.0.1

• Initial release: This brick provides a way to create a custom logger with different levels (debug,info,warning,error,critical and unknown).

MIT License

Copyright (c) 2022 Gonzalo Gauto

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.