Package zipkin2.reporter.okhttp3

Class OkHttpSender

java.lang.Object

zipkin2.Component

zipkin2.reporter.Sender

zipkin2.reporter.okhttp3.OkHttpSender

All Implemented Interfaces:

Closeable, AutoCloseable

public final class OkHttpSender
extends Sender

Reports spans to Zipkin, using its POST endpoint.

Usage

This type is designed for the async reporter.

Here's a simple configuration, configured for json:

 sender = OkHttpSender.create("http://127.0.0.1:9411/api/v2/spans");
 

Here's an example that adds basic auth (assuming you have an authenticating proxy):

{@code
 credential = Credentials.basic("me", "secure");
 sender = OkHttpSender.newBuilder()
   .endpoint("https://authenticated-proxy/api/v2/spans")
   .clientBuilder().authenticator(new Authenticator() {

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OkHttpSender.Builder

Method Summary

Modifier and Type	Method	Description
zipkin2.CheckResult	check()	Sends an empty json message to the configured endpoint.
void	close()	Waits up to a second for in-flight requests to finish before cancelling them
static OkHttpSender	create(String endpoint)	Creates a sender that posts Encoding.JSON messages.
zipkin2.codec.Encoding	encoding()
int	messageMaxBytes()
int	messageSizeInBytes(int encodedSizeInBytes)
int	messageSizeInBytes(List<byte[]> encodedSpans)
static OkHttpSender.Builder	newBuilder()
zipkin2.Call<Void>	sendSpans(List<byte[]> encodedSpans)	The returned call sends spans as a POST to OkHttpSender.Builder.endpoint(String).
OkHttpSender.Builder	toBuilder()	Creates a builder out of this object.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static OkHttpSender create(String endpoint)

Creates a sender that posts Encoding.JSON messages.

newBuilder

public static OkHttpSender.Builder newBuilder()

toBuilder

public final OkHttpSender.Builder toBuilder()

Creates a builder out of this object. Note: if the OkHttpSender.Builder.clientBuilder() was customized, you'll need to re-apply those customizations.

messageSizeInBytes

public int messageSizeInBytes(List<byte[]> encodedSpans)

Specified by:

messageSizeInBytes in class Sender

messageSizeInBytes

public int messageSizeInBytes(int encodedSizeInBytes)

Overrides:

messageSizeInBytes in class Sender

encoding

public zipkin2.codec.Encoding encoding()

Specified by:

encoding in class Sender

messageMaxBytes

public int messageMaxBytes()

Specified by:

messageMaxBytes in class Sender

sendSpans

public zipkin2.Call<Void> sendSpans(List<byte[]> encodedSpans)

The returned call sends spans as a POST to OkHttpSender.Builder.endpoint(String).

Specified by:

sendSpans in class Sender

check

public zipkin2.CheckResult check()

Sends an empty json message to the configured endpoint.

Overrides:

check in class zipkin2.Component

close

public void close()

Waits up to a second for in-flight requests to finish before cancelling them

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class zipkin2.Component

toString

public final String toString()

Overrides:

toString in class Object