Package com.helixframework.okhttp.tracing

Class DistributedTracingInterceptor

java.lang.Object

com.helixframework.okhttp.tracing.DistributedTracingInterceptor

All Implemented Interfaces:

okhttp3.Interceptor

public final class DistributedTracingInterceptor
extends Object
implements okhttp3.Interceptor

OkHttp interceptor that adds distributed tracing data to downstream requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DistributedTracingInterceptor.Builder	Builder for creating new instances of DistributedTracingInterceptor.

Nested classes/interfaces inherited from interface okhttp3.Interceptor

okhttp3.Interceptor.Chain, okhttp3.Interceptor.Companion

Field Summary

Fields inherited from interface okhttp3.Interceptor

Companion

Method Summary

Modifier and Type	Method	Description
static DistributedTracingInterceptor.Builder	builder()	Gets the builder for DistributedTracingInterceptor.
okhttp3.Response	intercept(okhttp3.Interceptor.Chain chain)
static DistributedTracingInterceptor	newDatadogInterceptor()	Builds a DistributedTracingInterceptor instance pre-configured to work with Datadog.
static DistributedTracingInterceptor	newZipkinTracingInterceptor()	Builds a DistributedTracingInterceptor instance pre-configured to work with any Zipkin compatible tracing system.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static DistributedTracingInterceptor.Builder builder()

Gets the builder for DistributedTracingInterceptor.

Returns:

a DistributedTracingInterceptor.Builder

newDatadogInterceptor

public static DistributedTracingInterceptor newDatadogInterceptor()

Builds a DistributedTracingInterceptor instance pre-configured to work with Datadog.

Returns:

an interceptor pre-configured to work with datadog

newZipkinTracingInterceptor

public static DistributedTracingInterceptor newZipkinTracingInterceptor()

Builds a DistributedTracingInterceptor instance pre-configured to work with any Zipkin compatible tracing system.

Returns:

an interceptor pre-configured to work with zipkin

intercept

@NotNull
public okhttp3.Response intercept(@NotNull
 okhttp3.Interceptor.Chain chain)
                           throws IOException

Specified by:

intercept in interface okhttp3.Interceptor

Throws:

IOException