Flutter

Requirements#

• Flutter 3.19 or later, Dart 3.3 or later
• Android minSdk 24 or higher
• A public ingest key from the Codeskop dashboard

1. 1

   Add the plugin

   Add it to pubspec.yaml, then run flutter pub get.

   pubspec.yamlCopy

   1dependencies:2  codeskop_tracker: ^0.3.0

   The plugin brings in the native Android SDK for you. Don't add tracker-android to your Gradle files separately.

2. 2

   Initialize and wrap your app

   Call Codeskop.runGuarded once, around runApp.

   lib/main.dartCopy

   1import 'package:codeskop_tracker/codeskop_tracker.dart';2import 'package:flutter/material.dart';3 4void main() {5  Codeskop.runGuarded(() async {6    await Codeskop.init(7      apiKey: 'cs_live_pk_YOUR_KEY',8      endpoint: 'https://api.codeskop.com',9    );10    runApp(const MyApp());11  });12}

   runGuarded calls WidgetsFlutterBinding.ensureInitialized() and sets up every Dart error hook for you: FlutterError.onError, PlatformDispatcher.onError, and a guarded zone for uncaught async errors. Flutter's usual red error screen and console output still work.

3. 3

   Identify your users

   Optional, but recommended.

   DartCopy

   1// After login2await Codeskop.identify(user.id, traits: {'plan': user.plan});3 4// On logout5await Codeskop.reset();

   Use your own stable user ID, never an email. As on native Android, call identify again when the app restarts with a signed-in user. See Identify users.

What's captured automatically#

• Uncaught Dart errors, reported as crashes, with the Dart stack trace
• Errors reported by the Flutter framework, reported as handled exceptions
• Native crashes and ANRs in the Android layer, from the native SDK (see Crash reporting and ANR monitoring)

Product analytics#

On Growth and Scale, record screens and events for funnels, retention and segments. Add the navigator observer so named routes become screens, and track what matters:

MaterialApp(navigatorObservers: [CodeskopNavigatorObserver()], ...); await Codeskop.track('order_completed', properties: {'value': 49.99, 'currency': 'KES'});

See Track events & screens.

Report handled errors#

1try {2  await checkout();3} catch (e, stack) {4  Codeskop.recordError(e, stack);   // reported as a handled exception5  showErrorBanner();6}

Report failed HTTP calls#

The plugin doesn't include an HTTP interceptor. Instead, call Codeskop.captureApiError from your own. With Dio, it looks like this:

1import 'package:codeskop_tracker/codeskop_tracker.dart';2import 'package:dio/dio.dart';3 4class CodeskopDioInterceptor extends Interceptor {5  @override6  void onError(DioException err, ErrorInterceptorHandler handler) {7    Codeskop.captureApiError(8      method: err.requestOptions.method,9      url: err.requestOptions.uri.toString(),10      status: err.response?.statusCode,11      errorKind: err.response == null ? 'network_error' : null,12    );13    handler.next(err);14  }15}16 17final dio = Dio()..interceptors.add(CodeskopDioInterceptor());

Query strings are removed from the URL before it's stored. Optional requestBytes and responseBytes arguments record payload sizes.

Advanced#

Managing the zone yourself

If you already run your app in your own runZonedGuarded, call registerErrorHooks() instead of runGuarded, and forward zone errors to recordError:

1void main() {2  runZonedGuarded(() async {3    WidgetsFlutterBinding.ensureInitialized();4    Codeskop.registerErrorHooks();5    await Codeskop.init(apiKey: 'cs_live_pk_YOUR_KEY', endpoint: 'https://api.codeskop.com');6    runApp(const MyApp());7  }, (error, stack) => Codeskop.recordError(error, stack, fatal: true));8}

Next steps#