Flutter分布式追踪插件opentracing的使用

Flutter分布式追踪插件opentracing的使用

此库是用Dart编写的OpenTracing API。它既可用于服务器端，也可用于浏览器端。

必读材料

要完全理解此平台API，最好熟悉OpenTracing项目及其通用术语。

快速入门

在您的pubspec.yaml文件中添加依赖项：

dependencies:
  opentracing: ^1.0.0

在您的Dart代码中，为要跟踪的操作添加仪器。这主要通过在感兴趣的操作周围使用“span”（跨度）来实现，并添加日志语句以捕获与这些操作相关的有用数据。

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();
});

opentracing包的默认行为是作为“no-op”实现。

要捕获并使跟踪数据具有可操作性，应该使用您选择的OpenTracing实现初始化Tracer对象，如以下示例代码所示：

initGlobalTracer(new CustomTracer());

注意：基础实现对象在所有包含的opentracing包之间共享，因此initGlobalTracer只需要在初始化期间调用一次。

开发信息

有关向OpenTracing贡献的更多信息，请参见OpenTracing网站。

项目示例由webdev_proxy运行。运行：

pub global activate webdev
pub global activate webdev_proxy
webdev_proxy serve -- example:8080

Dart OpenTracing实现

OpenTracing追踪器实现

本节面向希望实现自己的追踪器的开发人员。仅想使用OpenTracing的开发人员可以忽略此信息。

自定义追踪器实现

实现者可以实现Tracer，扩展Span，并实现或扩展其他API类来构建一个OpenTracing追踪器。

有关示例，请参阅basictracer-dart。

API兼容性测试

即将推出/待办事项

以下是完整的示例代码：

// Copyright 2016 Workiva Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import 'dart:html';

import 'package:opentracing/opentracing.dart';
import 'package:opentracing/src/global_tracer.dart';

import 'json_serializable_span.dart';

/// 全局追踪器
AbstractTracer tracer = globalTracer();

/// Span完成时的处理程序
void onFinished(Span span) {
  print(JsonSerializableSpan(span).toJson());
}

/// 运行成功案例
void runSuccessCase() {
  Span span = tracer.startSpan('http_request')!;
  span.whenFinished.then(onFinished);

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

/// 运行失败案例
void runFailureCase() {
  Span span = tracer.startSpan('http_request')!;
  span.whenFinished.then(onFinished);

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

void main() {
  runSuccessCase();
  runFailureCase();
}