Package zipkin2.reporter.okhttp3

Class OkHttpSender

java.lang.Object

zipkin2.reporter.Component

zipkin2.reporter.Sender

zipkin2.reporter.internal.SenderAdapter

zipkin2.reporter.okhttp3.OkHttpSender

All Implemented Interfaces:

Closeable, AutoCloseable, BytesMessageSender

public final class OkHttpSender
extends zipkin2.reporter.internal.SenderAdapter

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

Nested classes/interfaces inherited from interface zipkin2.reporter.BytesMessageSender

BytesMessageSender.Base

Method Summary

Modifier and Type	Method	Description
static OkHttpSender	create(String endpoint)	Creates a sender that posts Encoding.JSON messages.
protected BytesMessageSender	delegate()
static OkHttpSender.Builder	newBuilder()
OkHttpSender.Builder	toBuilder()	Creates a builder out of this object.

Methods inherited from class zipkin2.reporter.internal.SenderAdapter

check, close, encoding, messageMaxBytes, messageSizeInBytes, messageSizeInBytes, send, sendSpans, 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 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.

delegate

protected BytesMessageSender delegate()

Specified by:

delegate in class zipkin2.reporter.internal.SenderAdapter