mirror of https://github.com/dart-lang/sdk synced 2024-09-15 21:10:22 +00:00

History

Devon Carew 8cba879f46 Add additional validations to the pkg/ package pubspecs. TEST=these are additional validations that we run on the bots Redux of https://dart-review.googlesource.com/c/sdk/+/161040 Change-Id: Ia32ced5d48fbfeafacfa9e51dc4774d2e9425091 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/174601 Reviewed-by: Konstantin Shcheglov <scheglov@google.com> Commit-Queue: Devon Carew <devoncarew@google.com>		2020-12-02 17:27:18 +00:00
..
lib	Update the isRunningOnBot() check in telemetry.dart for Travis, check for env.containsKey('BOT'), instead of env['BOT'] == true	2020-06-22 20:49:46 +00:00
test	[analysis_server] Report to both prod & staging crash reporting	2020-05-04 18:11:54 +00:00
analysis_options.yaml	Test out no_implicit_casts on the analyzer source base.	2018-06-28 02:20:43 +00:00
LICENSE
pubspec.yaml	Add additional validations to the pkg/ package pubspecs.	2020-12-02 17:27:18 +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.