Package zipkin2.reporter

Class HttpEndpointSuppliers

java.lang.Object

zipkin2.reporter.HttpEndpointSuppliers

public final class HttpEndpointSuppliers
extends Object

Built-in HttpEndpointSupplier implementations.

Since:

3.3

Constructor Summary

Constructors

Constructor	Description
HttpEndpointSuppliers()

Method Summary

Modifier and Type	Method	Description
static HttpEndpointSupplier.Factory	constantFactory()	Returns a HttpEndpointSupplier.Factory which calls newConstant(String) for each input.
static HttpEndpointSupplier.Constant	newConstant(String endpoint)	sender implementations look for a HttpEndpointSuppliers.Constant to avoid the overhead of dynamic lookups on each call to BaseHttpSender.postSpans(Object, Object).
static HttpEndpointSupplier	newRateLimited(HttpEndpointSupplier input, int intervalSeconds)	Dynamic HttpEndpointSuppliers can guard against abuse by rate-limiting them.
static HttpEndpointSupplier.Factory	newRateLimitedFactory(HttpEndpointSupplier.Factory input, int intervalSeconds)	Returns a HttpEndpointSupplier.Factory which calls newRateLimited(HttpEndpointSupplier, int) for each input.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpEndpointSuppliers

public HttpEndpointSuppliers()

Method Detail

constantFactory

public static HttpEndpointSupplier.Factory constantFactory()

Returns a HttpEndpointSupplier.Factory which calls newConstant(String) for each input.

Since:

3.3

newConstant

public static HttpEndpointSupplier.Constant newConstant(String endpoint)

sender implementations look for a HttpEndpointSuppliers.Constant to avoid the overhead of dynamic lookups on each call to BaseHttpSender.postSpans(Object, Object).

Since:

3.3

newRateLimitedFactory

public static HttpEndpointSupplier.Factory newRateLimitedFactory(HttpEndpointSupplier.Factory input,
                                                                 int intervalSeconds)

Returns a HttpEndpointSupplier.Factory which calls newRateLimited(HttpEndpointSupplier, int) for each input.

Parameters:

intervalSeconds - amount of time to wait *after* calls to get before trying again.

Returns:

a factory that returns rate-limited suppliers unless the input was a HttpEndpointSupplier.Constant.

Throws:

IllegalArgumentException - if intervalSeconds is less than one.

Since:

3.3

newRateLimited

public static HttpEndpointSupplier newRateLimited(HttpEndpointSupplier input,
                                                  int intervalSeconds)

Dynamic HttpEndpointSuppliers can guard against abuse by rate-limiting them.

Calling this will invoke HttpEndpointSupplier.get() on the input. This ensures at least one successful call or an error.

Note: errors that occur during get will be logged and ignored. This allows the sender to attempt a prior endpoint vs erring on repeat.

Parameters:

input - what to rate-limit.

intervalSeconds - amount of time to wait *after* calls to get before trying again.

Returns:

a rate-limited supplier unless the input was a HttpEndpointSupplier.Constant.

Throws:

IllegalArgumentException - if intervalSeconds is less than one.

Since:

3.3