mobile_telemetry_sdk Documentation

Overview

Collect application events and connect an exporter that sends them to the observability service you choose.

mobile_telemetry_sdk Collect application events and connect an exporter that sends them to the observability service you choose.

Telemetry

Events

Observability

Installation

Add the package to your Flutter project.

bash

flutter pub add mobile_telemetry_sdk:^1.0.0

Quick Start

Start with this small example, then connect it to your own application. Read the known limitations before using it with real data.

dart

import 'package:mobile_telemetry_sdk/mobile_telemetry_sdk.dart';

final telemetry = TelemetryClient(
  maxBatchSize: 10,
  exporter: (events) async {
    // Development preview only. Replace with your exporter.
    print('Received ' + events.length.toString() + ' events');
    return false; // No backend delivery in this example.
  },
);

This is a starting point, not a complete application. Add error handling and tests for your own backend and lifecycle.

Configuration

Keep configuration with the part of your application that owns the package instance. Connect authentication, storage, exporters or backend handlers explicitly rather than relying on hidden global state.

Use the versioned API reference for constructors and options. The starting example above focuses on a small integration surface; the repository example shows the surrounding application code.

Explore configuration in the API reference

Known Limitations

A failed exporter can lose buffered events in the current implementation. Do not rely on this release as a durable audit trail. Test exporter failures and apply your own privacy and consent policy.

API Reference

Explore the public classes, methods and constructors for version 1.0.0.

Open versioned API reference

Example & Tests

Use the repository example to explore the package in context. Run its tests locally, and add regression cases for the known limitations above. The SSL package’s device test results do not apply to this package.

bash

git clone https://github.com/lekthedeveloper/mobile_telemetry_sdk.git
cd mobile_telemetry_sdk
flutter pub get
flutter test

View repository example

Frequently Asked Questions

Can I use this package in a commercial app?

The package is MIT licensed. Follow the license terms and review the current limitations for your use case.

Where should I report a bug?

Open an issue in the package repository. Include the package and Flutter versions, a minimal reproduction and the expected behavior. Remove credentials and private data.

Are these packages all verified for production?

No blanket guarantee is made. Each guide documents its current limitations. Test your integration and use independent review for sensitive workflows.