TelemetryHttpClient class
A Client
that automatically forwards the details of all completed HTTP requests onto telemetryClient via
the TelemetryClient.trackRequest method.
Use an instance of TelemetryHttpClient, either directly or as part of composed HTTP middleware, to ensure all requests result in appropriate telemetry items being created via telemetryClient. All request telemetry items will include durations, response codes, and other relevant properties set.
Constructors
- TelemetryHttpClient({required Client inner, required TelemetryClient telemetryClient, bool appendHeader(String header)?})
-
Create an instance of TelemetryHttpClient that forwards HTTP requests onto
inner
and telemetry items ontotelemetryClient
.
Properties
- appendHeader → bool Function(String header)?
-
Callback that determines whether or not to append certain header.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- inner → Client
-
The inner HTTP client.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- telemetryClient → TelemetryClient
-
The telemetry client.
final
Methods
-
close(
) → void -
Closes the client and cleans up any resources associated with it.
inherited
-
delete(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> -
Sends an HTTP DELETE request with the given headers to the given URL.
inherited
-
get(
Uri url, {Map< String, String> ? headers}) → Future<Response> -
Sends an HTTP GET request with the given headers to the given URL.
inherited
-
head(
Uri url, {Map< String, String> ? headers}) → Future<Response> -
Sends an HTTP HEAD request with the given headers to the given URL.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
patch(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> -
Sends an HTTP PATCH request with the given headers and body to the given
URL.
inherited
-
post(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> -
Sends an HTTP POST request with the given headers and body to the given
URL.
inherited
-
put(
Uri url, {Map< String, String> ? headers, Object? body, Encoding? encoding}) → Future<Response> -
Sends an HTTP PUT request with the given headers and body to the given
URL.
inherited
-
read(
Uri url, {Map< String, String> ? headers}) → Future<String> -
Sends an HTTP GET request with the given headers to the given URL and
returns a Future that completes to the body of the response as a String.
inherited
-
readBytes(
Uri url, {Map< String, String> ? headers}) → Future<Uint8List> -
Sends an HTTP GET request with the given headers to the given URL and
returns a Future that completes to the body of the response as a list of
bytes.
inherited
-
send(
BaseRequest request) → Future< StreamedResponse> - Sends an HTTP request and asynchronously returns the response.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited