opentracing 0.2.1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 0

OpenTracing API for Dart

This library is the Open Tracing API written in Dart. It is intended for use both on the server and in the browser.

Required Reading

To fully understand this platform API, it's helpful to be familiar with the OpenTracing project and terminology more generally.

Quick Start

Add the package to your pubspec:

dependencies:
  opentracing: ^1.0.0

In your dart code, add instrumentation to the operations to be tracked. This is composed primarily of using "spans" around operations of interest and adding log statements to capture useful data relevant to those operations.

  var tracer = globalTracer();
  
  Span span = tracer.startSpan('http_request');

  HttpRequest.getString('http://httpstat.us/200').then((String result){
    span.log('data_received', payload: result);
  }).catchError((error){
    span.log('request_error', payload: error);
  }).whenComplete((){
    span.log('request_end');
    span.finish();
  });

The default behavior of the opentracing package is to act as a "no-op" implementation.

To capture and make the tracing data actionable, the Tracer object should be initialized with the OpenTracing implementation of your choice as in the example code below:

    initGlobalTracer(new CustomTracer());

Note: The underlying implementation object is shared between all inclusions of the opentracing package, so initGlobalTracer needs to only be called once during initialization.

Development Information

See the OpenTracing website for general information on contributing to OpenTracing.

The project examples are run by . Run:

pub serve --hostname=localhost --port=9000 example

Dart OpenTracing Implementations

OpenTracing tracer implementations

This section is intended for developers wishing to implement their own tracers. Developers who simply wish to use OpenTracing can safely ignore this information.

Custom tracer implementation

Implementations can implement Tracer, extend Span, and implement or extend the other API classes to build a OpenTracing tracer.

See basictracer-dart for an example.

API compatibility testing

Coming soon / todo

Changelog

1.0.0

  • Initial version

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  opentracing: ^0.2.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:opentracing/opentracing.dart';
  
Version Uploaded Documentation Archive
0.2.1 Jul 11, 2017 Go to the documentation of opentracing 0.2.1 Download opentracing 0.2.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
0
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
0
Overall:
Weighted score of the above. [more]
0
Learn more about scoring.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Issues and suggestions

Support Dart 2 in pubspec.yaml.

The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://www.dartlang.org/dart-2#migration.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.23.0 <2.0.0