Search packages, repositories and app categories

Package detailsv0.18.11

opentelemetry_wk

A framework for collecting OpenTelemetry traces from applications.

Web
30-day downloads
49.6K
Likes
2
Pub points
145

Install package

flutter pub add opentelemetry_wk

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

opentelemetry_wk is a Flutter/Dart package designed to collect OpenTelemetry traces from applications, enabling detailed observability of performance and behavior. Built by Workiva, it supports web platforms and integrates with the OpenTelemetry ecosystem for standardized telemetry data collection. The package allows developers to instrument their apps to capture spans, metrics, and logs, facilitating debugging, monitoring, and analysis across distributed systems. It is particularly useful in environments requiring compliance with observability standards. The source code is publicly available on GitHub for transparency and contribution.

Use cases

  • Application performance monitoring
  • Distributed tracing in web apps
  • Debugging latency issues
  • Compliance with observability standards
  • Integration with backend telemetry systems

Key features

  • Web platform support
  • OpenTelemetry standard compliance
  • Span collection and propagation
  • Integration with OpenTelemetry exporters
  • Lightweight and extensible design

Suitable for

  • Web-based Flutter applications
  • Teams using OpenTelemetry
  • Developers needing observability insights
  • Backend-integrated monitoring workflows
  • Real-time application diagnostics

Considerations

  • Limited to web platform
  • Requires additional setup for exporters
  • No native mobile support
  • Dependent on OpenTelemetry backend infrastructure
  • Learning curve for OpenTelemetry concepts

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

OpenTelemetry for Dart

This repository is the Dart implementation of the OpenTelemetry project. All contributions and designs should follow the OpenTelemetry specification.

Project Status

Signal Status
Traces Beta
Metrics Alpha
Logs Unimplemented

Getting Started

This section will show you how to initialize the OpenTelemetry SDK, capture a span, and propagate context.

Initialize the OpenTelemetry SDK
import 'package:opentelemetry/sdk.dart'
    show
        BatchSpanProcessor,
        CollectorExporter,
        ConsoleExporter,
        SimpleSpanProcessor,
        TracerProviderBase;
import 'package:opentelemetry/api.dart'
    show registerGlobalTracerProvider, globalTracerProvider;

void main(List<String> args) {
  final tracerProvider = TracerProviderBase(processors: [
    BatchSpanProcessor(
        CollectorExporter(Uri.parse('https://my-collector.com/v1/traces'))),
    SimpleSpanProcessor(ConsoleExporter())
  ]);

  registerGlobalTracerProvider(tracerProvider);
  final tracer = globalTracerProvider.getTracer('instrumentation-name');
}
Capture a Span
import 'package:opentelemetry/api.dart' show StatusCode, globalTracerProvider;

void main(List<String> args) {
  final tracer = globalTracerProvider.getTracer('instrumentation-name');

  final span = tracer.startSpan('main');
  try {
    // do some work
    span.addEvent('some work');
  } catch (e, s) {
    span
      ..setStatus(StatusCode.error, e.toString())
      ..recordException(e, stackTrace: s);
    rethrow;
  } finally {
    span.end();
  }
}
Propagate Context
Intra-process

In order to parent spans, context must be propagated. Propagation can be achieved by manually passing an instance of Context or by using Dart Zones.

See the attach detach context examplefor more information.

Inter-process

In order to parent spans between processes, context can be serialized and deserialized using a TextMapPropagator, TextMapSetter, and TextMapGetter.

See the W3C context propagation example for more information.

High Resolution Timestamps

A tracer provider can register a web-specific time provider that uses the browser's performance API instead of DateTime when recording timestamps for a span's start timestamp, end timestamp, and span events.

import 'package:opentelemetry/web_sdk.dart' as web_sdk;

final tracerProvider =
    web_sdk.WebTracerProvider(timeProvider: web_sdk.WebTimeProvider());

Important Note: Span timestamps may be inaccurate if the executing system is suspended for sleep. See https://github.com/open-telemetry/opentelemetry-js/issues/852 for more information.

Contributing

In order to generate protobuf definitions, you must have protoc installed and available in your path.

Publishing New Versions

Only Workiva maintainers can publish new versions of opentelemetry-dart. See Publishing opentelemetry-dart

Categories

Dependencies

Dependency list 9 items

Source repository

Projects using this package

No data available yet.

Rankings