Class WebClientTelemetryTracing

java.lang.Object

io.helidon.webclient.telemetry.tracing.WebClientTelemetryTracing

All Implemented Interfaces:

NamedService, WebClientService

public class WebClientTelemetryTracing
extends Object
implements WebClientService

Implementation of OpenTelemetry semantic conventions for client tracing.

Nested Class Summary

Nested classes/interfaces inherited from interface WebClientService

WebClientService.Chain, WebClientService.TransportChain, WebClientService.WireProtocolChain

Modifier and Type	Interface	Description
static interface	WebClientService.Chain	Chain of services.
static interface	WebClientService.TransportChain	Terminal service chain that can expose transport response context after an invocation.
static interface	WebClientService.WireProtocolChain	Terminal service chain that exposes the currently selected wire protocol.

Method Summary

Modifier and Type	Method	Description
static WebClientTelemetryTracing	create()	Creates a new service instance to emit tracing spans compliant with OpenTelemetry semantic conventions for clients.
static WebClientTelemetryTracing	create(Config config)	Creates a new service instance to emit tracing spans compliant with OpenTelemetry semantic conventions for clients using the provided configuration.
static WebClientTelemetryTracing	create(Config config, Tracer tracer)	Creates a new service instance to emit tracing spans compliant with OpenTelemetry semantic conventions for clients using the provided configuration and tracer.
static WebClientTelemetryTracing	create(Config config, Supplier<Tracer> tracer)	Creates a new service instance to emit tracing spans compliant with OpenTelemetry semantic conventions for clients using the provided configuration and tracer supplier.
WebClientServiceResponse	handle(WebClientService.Chain chain, WebClientServiceRequest clientRequest)	Invoke a service, call WebClientService.Chain.proceed(io.helidon.webclient.api.WebClientServiceRequest) to call the next service in the chain.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface WebClientService

name, type

Modifier and Type	Method	Description
default String	name()	Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
default String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Method Details

create

public static WebClientTelemetryTracing create()

Creates a new service instance to emit tracing spans compliant with OpenTelemetry semantic conventions for clients.

Returns:

new tracing semantic conventions implementation

create

public static WebClientTelemetryTracing create(Config config)

Creates a new service instance to emit tracing spans compliant with OpenTelemetry semantic conventions for clients using the provided configuration.

Parameters:

config - telemetry tracing config

Returns:

new tracing semantic conventions implementation

create

public static WebClientTelemetryTracing create(Config config,
 Tracer tracer)

Creates a new service instance to emit tracing spans compliant with OpenTelemetry semantic conventions for clients using the provided configuration and tracer.

Parameters:

config - telemetry tracing config

tracer - fallback tracer when the request context does not contain one

Returns:

new tracing semantic conventions implementation

create

public static WebClientTelemetryTracing create(Config config,
 Supplier<Tracer> tracer)

Creates a new service instance to emit tracing spans compliant with OpenTelemetry semantic conventions for clients using the provided configuration and tracer supplier.

Parameters:

config - telemetry tracing config

tracer - supplier of the fallback tracer when the request context does not contain one

Returns:

new tracing semantic conventions implementation

handle

public WebClientServiceResponse handle(WebClientService.Chain chain,
 WebClientServiceRequest clientRequest)

Description copied from interface: WebClientService

Invoke a service, call WebClientService.Chain.proceed(io.helidon.webclient.api.WebClientServiceRequest) to call the next service in the chain.

Specified by:

handle in interface WebClientService

Parameters:

chain - to invoke next web client service, or the HTTP call if this is the last service

clientRequest - request from the client, or previous services

Returns:

response to be returned to the client