masamune_logger_firebase 3.3.0

Plug-in package to easily add Firebase Analytics, Performance and Crashlytics on Masamune Framework. The functionality is available by simply adding an Adapter.

Masamune Logger Firebase

---

[GitHub] | [YouTube] | [Packages] | [X] | [LinkedIn] | [mathru.net]

---

Masamune Logger Firebase

Usage

Installation

Add the package to your project.

flutter pub add masamune_logger_firebase

Run flutter pub get after editing pubspec.yaml manually.

Register the Adapter

Set up FirebaseLoggerMasamuneAdapter before running the app. This adapter provides both logging (FirebaseLoggerAdapter) and integration with Firebase services.

// lib/adapter.dart

import 'package:masamune/masamune.dart';
import 'package:masamune_logger_firebase/masamune_logger_firebase.dart';

/// Logger adapters used by the application.
final loggerAdapters = <LoggerAdapter>[
  const FirebaseLoggerAdapter(),  // Add Firebase logger
];

/// Masamune adapters used by the application.
final masamuneAdapters = <MasamuneAdapter>[
  const UniversalMasamuneAdapter(),
  
  const FirebaseLoggerMasamuneAdapter(
    options: DefaultFirebaseOptions.currentPlatform,  // From firebase_options.dart
  ),
];

Key Features:

• Initializes Firebase automatically
• Attaches Crashlytics error handling to FlutterError and PlatformDispatcher
• Adds navigation observers for automatic screen tracking
• Exposes FirebaseAnalytics, FirebaseCrashlytics, and FirebasePerformance instances

Access the adapter via FirebaseLoggerMasamuneAdapter.primary.

Logging Events

Use the logger API to send events to Firebase Analytics. The package provides pre-built loggable classes for common events.

Sign-In Events:

// Get the logger from your controller or page
final logger = LoggerAdapter.primary.first;

// Log user sign-in
await logger.send(const FirebaseAnalyticsSignInLoggable(
  userId: "user_123",
  providerId: "google.com",
));

// Log user registration
await logger.send(const FirebaseAnalyticsRegisterLoggable(
  userId: "user_456",
));

Purchase Events:

await logger.send(const FirebaseAnalyticsPurchasedLoggable(
  transactionId: "order-001",
  currency: "USD",
  price: 9.99,
  products: [
    FirebaseAnalyticsPurchaseProduct(
      id: "sku-1",
      name: "Premium Plan",
      price: 9.99,
      quantity: 1,
    ),
  ],
));

Tutorial Events:

// Tutorial started
await logger.send(const FirebaseAnalyticsTutorialStartLoggable());

// Tutorial completed
await logger.send(const FirebaseAnalyticsTutorialEndLoggable());

Custom Analytics Events

Send custom events through the existing Masamune logger:

await appLogger.sendRawData("goal_completed", parameters: {
  "variant": "control",
  "duration_seconds": 12.5,
  "count": 1,
});

A custom Loggable can also override name and return its parameters from toJson(). Existing screen, authentication, purchase and tutorial events keep their specialized Firebase mappings.

Custom names must start with a letter and contain at most 40 letters, digits or underscores. The prefixes firebase_, google_ and ga_ are reserved. Up to 25 parameters are accepted. Values must be strings of at most 100 characters or finite numbers; convert booleans explicitly to 0/1 when needed. Invalid names, nulls, collections and unsupported values raise ArgumentError before sending. SDK errors propagate to the caller. Respect the application's existing analytics consent settings and avoid including personal information in event parameters.

Performance Monitoring

Use performance traces to measure operation durations:

final logger = LoggerAdapter.primary.first;

// Start a trace
final trace = logger.trace("load_profile");
await trace.start();

// Execute the operation you want to measure
await loadUserProfile();

// Stop the trace
await trace.stop();

Crashlytics

Crash reports are captured automatically when the adapter is registered. The adapter hooks into FlutterError.onError and PlatformDispatcher.onError.

Test Crashlytics Integration:

// Force a test crash (only for testing!)
final logger = FirebaseLoggerAdapter.primary;
await logger.crash();

Manual Error Reporting:

try {
  // Your code
} catch (e, stackTrace) {
  await FirebaseCrashlytics.instance.recordError(e, stackTrace);
}

GitHub Sponsors

Sponsors are always welcome. Thank you for your support!

https://github.com/sponsors/mathrunet