instalog_flutter 0.1.2

Flutter plugin for Instalog analytics, logging, error tracking, and user feedback collection services.

Developed with 💙 by Instalog 🚀

A Flutter plugin for integrating Instalog analytics, logging, and crash reporting services into your Flutter applications. Instalog provides a comprehensive solution for monitoring app performance, user behavior, and error tracking.

Features

• Event Logging: Track custom events with flexible parameters
• User Identification: Associate events with specific users
• Crash Reporting: Automatically capture and report crashes
• Feedback Collection: In-app feedback modal for user input

Installation

Add instalog_flutter to your pubspec.yaml:

dependencies:
  instalog_flutter: ^0.1.2

Usage

Initialization

Initialize the Instalog SDK at the start of your app:

import 'package:instalog_flutter/instalog_flutter.dart';

// Initialize in main.dart
void main() {
  // Set up crash handling
  Instalog.instance.crash.setup(
    appRunner: () => runApp(const MyApp()),
  );
}

// Initialize with your API key in a widget
@override
void initState() {
  super.initState();
  Instalog.instance.initialize(apiKey: 'your_api_key_here');
}

Logging Events

Track custom events with optional parameters:

// Simple event
Instalog.instance.logEvent(event: 'button_clicked');

// Event with parameters
Instalog.instance.logEvent(
  event: 'user_login',
  params: {
    'user_id': '12345',
    'method': 'email',
    'timestamp': DateTime.now().toIso8601String(),
  },
);

Showing Feedback Modal

Display the in-app feedback modal to collect user input:

await Instalog.instance.showFeedbackModal();

Crash Reporting

Instalog automatically captures uncaught exceptions when set up with crash.setup(). To manually report a caught exception:

try {
  // Your code that might throw an exception
} catch (error, stack) {
  Instalog.instance.sendCrash(error, stack);
}

Platform-Specific Notes

iOS

Ensure you have added the necessary permissions to your Info.plist file if your app collects user data.

Android

If targeting Android 13 (API level 33) or higher, ensure you request the appropriate permissions for collecting user data.