Kubesense Tracking HTTP Client Plugin

A plugin for use with the Kubesense SDK, used to track performance of HTTP calls and enable Kubesense Distributed Tracing.

Getting started

To use this plugin, enable it during configuration of your SDK. In order to enable Kubesense Distributed Tracing, you also need to set the firstPartyHosts property in your configuration object.

import 'package:kubesense_tracking_http_client/kubesense_tracking_http_client.dart';

final configuration = KubesenseConfiguration(
  // configuration
  firstPartyHosts: ['example.com'],
)..enableHttpTracking()

Note that the Kubesense Tracking HTTP Client modifies [HttpOverrides.global](). If you need to provide your own HttpOverrides, make sure to initialize it prior to initializing Kubesense. During initialization, Kubesense will check the value of HttpOverrides.current and use this for client creation if it exists.

Using http.Client wrapping

This package also supplies a composable client usable with the http pub package called KubesenseClient. For most scenarios, Kubesense recommends you use the HTTP tracking method above, but there are a few scenarios where using KubesenseClient might make more sense:

• If you are using native HTTP libraries like cronet_http or cupertino_http, which do not work with the above tracking method.
• If you only want to track specific resource requests.

If you are using cronet_http or cupertino_http, you can combine KubesenseClient with the above tracking method. Otherwise, the two methods may interfere with each other.

To use the KubesenseClient, create and compose the Client from the http package:

import 'package:kubesense_tracking_http_client/kubesense_tracking_http_client.dart';
import 'package:http/http.dart' as http;

final configuration = KubesenseConfiguration(
  // specifying firstPartyHosts is still necessary to
  // enable distributed tracing
  firstPartyHosts: ['example.com'],
)

final httpClient = http.Client()
final kubesenseClient = KubesenseClient(kubesenseSdk: KubesenseSdk.instance, innerClient: httpClient);

The innerClient parameter is optional. If it is not supplied, KubesenseClient will create a Client for you with default options.

Flutter 2.8 support

Flutter 3.0 updated to Dart 2.17, which added two methods to HttpClient.

Currently, version 1.1.x sets a version constraint to Dart >= 2.17. If you need to support versions of Flutter prior to 3.0, back to flutter 2.8, use version 1.0.x instead. There is no difference between these versions other than support for lower versions of Dart.

License

Apache License, v2.0