Lumberdash Logging API

Lumberdash uses a plugin-based architecture where functionality is provided by LumberdashClient implementations. You can register multiple clients simultaneously to route logs to different destinations (e.g., printing to stdout with colors while also sending logs to a remote service like Firebase).

import 'package:lumberdash/lumberdash.dart';
import 'package:colorize_lumberdash/colorize_lumberdash.dart';
import 'package:firebase_lumberdash/firebase_lumberdash.dart';

void main() {
  putLumberdashToWork(withClients: [
    ColorizeLumberdash(),
    FirebaseLumberdash(
      firebaseAnalyticsClient: FirebaseAnalytics(),
      environment: 'development',
      releaseVersion: '1.0.0',
    ),
  ]);
  
  logWarning('Hello Warning');
}

To use print_lumberdash, add it to your project's dependencies. This plugin allows lumberdash to output logs directly to the terminal using the standard print function.

To initialize it, call putLumberdashToWork from the lumberdash package and pass an instance of PrintLumberdash() in the withClients list.

import 'package:lumberdash/lumberdash.dart';
import 'package:print_lumberdash/print_lumberdash.dart';

void main() {
  putLumberdashToWork(
    withClients: [PrintLumberdash()],
  );

  logWarning('Hello Warning');
  logFatal('Hello Fatal!');
  logMessage('Hello Message!');
  logError(Exception('Hello Error'));
}

To start using Lumberdash, call putLumberdashToWork and provide a list of LumberdashClient instances via the withClients parameter. Once initialized, you can use top-level logging functions like logWarning, logFatal, logMessage, and logError throughout your application.

import 'package:lumberdash/lumberdash.dart';
import 'package:colorize_lumberdash/colorize_lumberdash.dart';

void main() {
  putLumberdashToWork(withClients: [ColorizeLumberdash()]);
  logWarning('Hello Warning');
  logFatal('Hello Fatal!');
  logMessage('Hello Message!');
  logError(Exception('Hello Error'));
}

The colorize_lumberdash plugin enables colored log output in your terminal. It prints logs to stdout with different colors based on the severity level of the log message. To use it, add colorize_lumberdash to your project dependencies and pass an instance of ColorizeLumberdash() to the putLumberdashToWork function from the lumberdash package.

import 'package:colorize_lumberdash/colorize_lumberdash.dart';
import 'package:lumberdash/lumberdash.dart';

void main() {
  // Initialize lumberdash with the ColorizeLumberdash client
  putLumberdashToWork(withClients: [ColorizeLumberdash()]);

  // Logs will now appear in color based on severity
  logWarning('Hello Warning');
  logFatal('Hello Fatal!');
  logMessage('Hello Message!');
  logError(Exception('Hello Error'));
}

To customize the launch screen for the iOS version of the project, you can replace the existing image files in the LaunchImage.imageset directory with your own assets.

Alternatively, you can use Xcode to manage these assets:

1. Open the iOS workspace using open ios/Runner.xcworkspace.
2. In the Xcode Project Navigator, navigate to Runner/Assets.xcassets.
3. Drag and drop your desired images into the asset catalog.

To log data to the file system using file_lumberdash, add file_lumberdash to your project's dependencies. You must then instantiate FileLumberdash with a filePath and pass it to the putLumberdashToWork function from the core lumberdash package.

import 'package:lumberdash/lumberdash.dart';
import 'package:file_lumberdash/file_lumberdash.dart';

void main() {
  putLumberdashToWork(
    withClients: [
        FileLumberdash(filePath: yourFilePath)
    ],
  );
  logWarning('Hello Warning');
  logFatal('Hello Fatal!');
  logMessage('Hello Message!');
  logError(Exception('Hello Error'));
}

The FirebaseLumberdash class is used to bridge Lumberdash logs to Firebase Analytics. It accepts the following configuration parameters:

• firebaseAnalyticsClient: An instance of FirebaseAnalytics used to transmit the data.
• loggerName: A string identifier for the logger.
• environment: A string representing the current environment (e.g., 'development', 'production').
• releaseVersion: A string representing the current version of the application.

The FileLumberdash client requires a filePath parameter during initialization to specify where the log data should be written on the file system.

FileLumberdash(filePath: yourFilePath)

The following plugins are officially supported by BMW for various logging destinations and formatting:

• colorize_lumberdash: Prints logs to stdout with colors.
• firebase_lumberdash: Sends logs to Firebase.
• print_lumberdash: Standard printing.
• sentry_lumberdash: Sends logs to Sentry.