mirror of https://github.com/dart-lang/sdk synced 2024-07-19 20:17:27 +00:00

History

Devon Carew 3dbed884c2 [pkg] use package:lints when analying pkg/ Change-Id: Ib25573375ea1f54e07846af6fcd9cd74a8fefb7a Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/250784 Reviewed-by: Nate Bosch <nbosch@google.com> Commit-Queue: Devon Carew <devoncarew@google.com>		2022-07-07 14:29:22 +00:00
..
lib	move pkg/telemetry to using package:lints	2021-05-19 16:26:42 +00:00
test	move pkg/telemetry to using package:lints	2021-05-19 16:26:42 +00:00
analysis_options.yaml	[pkg] use package:lints when analying pkg/	2022-07-07 14:29:22 +00:00
LICENSE	Update LICENSE	2021-04-07 10:28:38 +00:00
OWNERS	[infra] Add OWNERS to the Dart SDK	2022-02-14 14:06:34 +00:00
pubspec.yaml	[pkg] prefer 'any' deps for package dev dependencies	2022-05-27 01:34:59 +00:00
README.md	Fix spelling errors in telemetry README.	2017-07-07 10:57:58 -07:00

README.md

telemetry

A library to facilitate reporting analytics and crash reports.

Analytics

This library is designed to allow all Dart SDK tools to easily send analytics information and crash reports. The tools share a common setting to configure sending analytics data. To use this library for a specific tool:

import 'package:telemetry/telemetry.dart';
import 'package:usage/usage.dart';

main() async {
  final String myAppTrackingID = ...;
  final String myAppName = ...;

  Analytics analytics = createAnalyticsInstance(myAppTrackingID, myAppName);
  ...
  analytics.sendScreenView('home');
  ...
  await analytics.waitForLastPing();
}

The analytics object reads from the correct user configuration file automatically without any additional configuration. Analytics will not be sent if the user has opted-out.

Crash reporting

To use the crash reporting functionality, import crash_reporting.dart, and create a new CrashReportSender instance:

import 'package:telemetry/crash_reporting.dart';

main() {
  Analytics analytics = ...;
  CrashReportSender sender = new CrashReportSender(analytics);
  try {
    ...
  } catch (e, st) {
    sender.sendReport(e, st);
  }
}

Crash reports will only be sent if the cooresponding [Analytics] object is configured to send analytics.