Package zipkin2.elasticsearch

Class ElasticsearchStorage

java.lang.Object

zipkin2.Component

zipkin2.storage.StorageComponent

zipkin2.elasticsearch.ElasticsearchStorage

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class ElasticsearchStorage
extends StorageComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElasticsearchStorage.Builder
static interface	ElasticsearchStorage.LazyHttpClient	This defers creation of an WebClient.

Method Summary

Modifier and Type	Method	Description
AutocompleteTags	autocompleteTags()
CheckResult	check()	This is blocking so that we can determine if the cluster is healthy or not
void	clear()	This is an internal blocking call, only used in tests.
void	close()
abstract boolean	flushOnWrites()
abstract zipkin2.elasticsearch.internal.IndexNameFormatter	indexNameFormatter()
boolean	isOverCapacity(Throwable e)	Internal code and api responses coerce to RejectedExecutionException when work is rejected.
abstract int	namesLookback()
static ElasticsearchStorage.Builder	newBuilder(ElasticsearchStorage.LazyHttpClient lazyHttpClient)	The lazy http client supplier will be closed on close()
abstract String	pipeline()
ServiceAndSpanNames	serviceAndSpanNames()
SpanConsumer	spanConsumer()
SpanStore	spanStore()
abstract boolean	strictTraceId()
final String	toString()
Traces	traces()
BaseVersion	version()	Returns the Elasticsearch / OpenSearch version of the connected cluster.

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static ElasticsearchStorage.Builder newBuilder(ElasticsearchStorage.LazyHttpClient lazyHttpClient)

The lazy http client supplier will be closed on close()

pipeline

@Nullable
public abstract String pipeline()

flushOnWrites

public abstract boolean flushOnWrites()

strictTraceId

public abstract boolean strictTraceId()

indexNameFormatter

public abstract zipkin2.elasticsearch.internal.IndexNameFormatter indexNameFormatter()

namesLookback

public abstract int namesLookback()

spanStore

public SpanStore spanStore()

Specified by:

spanStore in class StorageComponent

traces

public Traces traces()

Overrides:

traces in class StorageComponent

serviceAndSpanNames

public ServiceAndSpanNames serviceAndSpanNames()

Overrides:

serviceAndSpanNames in class StorageComponent

autocompleteTags

public AutocompleteTags autocompleteTags()

Overrides:

autocompleteTags in class StorageComponent

spanConsumer

public SpanConsumer spanConsumer()

Specified by:

spanConsumer in class StorageComponent

version

@Memoized
public BaseVersion version()

Returns the Elasticsearch / OpenSearch version of the connected cluster. Internal use only

clear

public void clear()
           throws IOException

This is an internal blocking call, only used in tests.

Throws:

IOException

isOverCapacity

public boolean isOverCapacity(Throwable e)

Internal code and api responses coerce to RejectedExecutionException when work is rejected. We also classify ResponseTimeoutException as a capacity related exception even though capacity is not the only reason (timeout could also result from a misconfiguration or a network problem).

Overrides:

isOverCapacity in class StorageComponent

check

public CheckResult check()

This is blocking so that we can determine if the cluster is healthy or not

Overrides:

check in class Component

toString

public final String toString()

Overrides:

toString in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class Component