firebase_analytics_monitor 1.0.0

A command-line tool to monitor Firebase Analytics events from logcat.

🔥 Firebase Analytics Monitor (famon)

[coverage]

A powerful command-line tool for real-time monitoring and filtering of Firebase Analytics events from Android logcat. Perfect for developers and QA engineers working with Firebase Analytics implementations.

✨ Features

• 🔍 Real-time monitoring: Stream Firebase Analytics events as they happen
• 🎯 Smart filtering: Hide noisy events or show only specific ones
• 🎨 Beautiful output: Colorized, well-formatted event display with emoji icons
• 📊 Smart suggestions: Get recommendations for filtering based on session data
• 📈 Session statistics: Track event frequency and patterns
• ⚡ Event parsing: Comprehensive parsing of parameters and item arrays
• 🛠 Developer-friendly: Designed for debugging and analytics validation

---

🚀 Installation

Global Installation via Pub

dart pub global activate firebase_analytics_monitor

Local Development Installation

dart pub global activate --source=path <path to this package>

From Source

git clone <repository-url>
cd firebase_analytics_monitor
dart pub get
dart compile exe bin/famon.dart -o famon
# Move famon to your PATH

📋 Prerequisites

Before using famon, ensure you have:

• ✅ Android SDK platform-tools installed
• ✅ adb command available in your PATH
• ✅ Android device or emulator connected
• ✅ USB debugging enabled on your device
• ✅ App with Firebase Analytics running

Verify your setup:

adb devices  # Should show your connected device
adb logcat -s FA-SVC | head  # Should show Firebase Analytics logs

🎯 Usage

Basic Monitoring

Monitor all Firebase Analytics events:

famon monitor

Filter Events

Hide specific noisy events:

famon monitor --hide screen_view --hide _vs

Show only specific events (e.g., e-commerce events):

famon monitor --show-only purchase --show-only add_to_cart
# or using short form:
famon monitor -s purchase -s add_to_cart

Advanced Options

Monitor with smart suggestions and statistics:

famon monitor --suggestions --stats

Disable colors (useful for CI/CD or logging):

famon monitor --no-color

Get Help

famon help           # Detailed help with examples
famon --help         # Basic usage information
famon --version      # Show version

📊 Example Output

🔥 Firebase Analytics Monitor Started
📱 Connecting to adb logcat...
Press Ctrl+C to stop monitoring

🛒 [12-25 10:30:45.123] purchase
   Parameters:
     💰 currency: USD
     💰 value: 29.99
     💰 transaction_id: txn_abc123
     method: credit_card
   📦 Items:
     Item 1:
       item_id: sku_123
       item_name: Premium T-Shirt
       🔸 item_customization: Large, Blue
       price: 29.99
   ────────────────────────────────────────

📱 [12-25 10:31:15.456] screen_view
   Parameters:
     screen_name: ProductDetail
     screen_class: MainActivity
   ────────────────────────────────────────

💡 Smart Suggestions:
   Most frequent events: screen_view, _vs, app_update, user_engagement
   Consider hiding: screen_view, _vs
   Use: famon monitor --hide screen_view --hide _vs

📊 Session Stats:
   Unique Events: 8
   Total Events: 45
   Most Frequent: screen_view (23)

🎨 Event Types & Icons

The tool automatically assigns relevant emoji icons to different event types:

• 🛒 E-commerce events: purchase, add_to_cart, begin_checkout, etc.
• ❤️ Engagement: add_to_wishlist
• 📱 App events: screen_view, app_open
• 📊 Generic events: All other Firebase Analytics events

🔧 Command Reference

Monitor Command

famon monitor [OPTIONS]

Options:

• --hide EVENT_NAME: Hide specific event names (can be used multiple times)
• -s, --show-only EVENT_NAME: Only show specified events (can be used multiple times)
• --no-color: Disable colored output
• --suggestions: Show smart filtering suggestions based on session data
• --stats: Display session statistics periodically
• --help: Show help for the monitor command

Global Options

• -v, --version: Show version information
• --verbose: Enable verbose logging
• --help: Show general help

🧪 Testing Your Setup

1. Test adb connection:

   adb devices
   

2. Test Firebase Analytics logs:

   adb logcat -s FA-SVC | head -20
   

3. Test with sample events:

   • Open your app with Firebase Analytics
   • Navigate through screens or trigger events
   • Run famon monitor to see events in real-time

🐛 Troubleshooting

"adb: command not found"

• Install Android SDK platform-tools
• Add platform-tools to your PATH

"No devices found"

• Connect your Android device via USB
• Enable USB debugging in Developer Options
• Try adb kill-server && adb start-server

"No Firebase Analytics events"

• Ensure your app has Firebase Analytics integrated
• Check that events are being sent (may have delays)
• Verify Firebase Analytics is properly configured

"Permission denied" errors

• Check USB debugging permissions on device
• Try different USB cable or port

"Not all event parameters are showing"

If you're seeing events but missing parameters, this could be due to:

1. Log format variations: Firebase Analytics uses different log formats
2. Parameter parsing issues: Complex parameter structures may need adjustment

To debug parameter parsing:

# First, check the raw Firebase Analytics logs
adb logcat -s FA-SVC | head -10

# Look for patterns like:
# Logging event: origin=app,name=EVENT_NAME,params=Bundle[{param1=value1, param2=value2}]

Common log formats supported:

• Logging event: origin=app,name=EVENT_NAME,params=Bundle[{...}]
• Event logged: EVENT_NAME params:Bundle[{...}]
• FA-SVC event_name:EVENT_NAME

If parameters are still missing:

1. Check if the Bundle format in your logs matches the expected patterns
2. Some newer Firebase SDK versions may use different formats
3. Parameters with special characters or nested objects may need additional parsing

Example of expected vs actual log format:

Expected:

Logging event: origin=app,name=view_cart,params=Bundle[{value=0, currency=GBP, login_mode=email_login}]

If your logs look different, please open an issue with a sample log line for format support.

🤝 Contributing

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

Development Setup

git clone <repository-url>
cd firebase_analytics_monitor
dart pub get
dart pub run build_runner build  # Generate model files

Running Tests

dart test                           # Run all tests
dart test --coverage=coverage      # Run with coverage
dart pub run test                  # Alternative test command

To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov)
.

```sh
# Generate Coverage Report
$ genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
$ open coverage/index.html

---