opentracing 1.0.1

Dart native js
Flutter Android iOS web

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

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

0
likes
75
pub points
85%
popularity

Publisher

workiva.com

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

Homepage

Documentation

API reference

License

Apache 2.0 (LICENSE)

Dependencies

meta

More

Packages that depend on opentracing