zipkin2.elasticsearch

Class ElasticsearchStorage.Builder

java.lang.Object

zipkin2.storage.StorageComponent.Builder

zipkin2.elasticsearch.ElasticsearchStorage.Builder

Enclosing class:

ElasticsearchStorage

public abstract static class ElasticsearchStorage.Builder
extends StorageComponent.Builder

Method Summary

Modifier and Type	Method and Description
abstract ElasticsearchStorage	build()
ElasticsearchStorage.Builder	dateSeparator(char dateSeparator) The date separator to use when generating daily index names.
abstract ElasticsearchStorage.Builder	flushOnWrites(boolean flushOnWrites) Visible for testing
ElasticsearchStorage.Builder	hosts(List<String> hosts) A list of elasticsearch nodes to connect to, in http://host:port or https://host:port format.
abstract ElasticsearchStorage.Builder	hostsSupplier(ElasticsearchStorage.HostsSupplier hosts) Like hosts(List), except the value is deferred.
ElasticsearchStorage.Builder	index(String index) The index prefix to use when generating daily index names.
abstract ElasticsearchStorage.Builder	indexReplicas(int indexReplicas) The number of replica copies of each shard in the index.
abstract ElasticsearchStorage.Builder	indexShards(int indexShards) The number of shards to split the index into.
abstract ElasticsearchStorage.Builder	maxRequests(int maxRequests) Sets maximum in-flight requests from this process to any Elasticsearch host.
abstract ElasticsearchStorage.Builder	namesLookback(int namesLookback) Only return span and service names where all Span.timestamp() are at or after (now - lookback) in milliseconds.
abstract ElasticsearchStorage.Builder	pipeline(String pipeline) Only valid when the destination is Elasticsearch 5.x.
abstract ElasticsearchStorage.Builder	searchEnabled(boolean searchEnabled)
abstract ElasticsearchStorage.Builder	shutdownClientOnClose(boolean shutdownClientOnClose)
abstract ElasticsearchStorage.Builder	strictTraceId(boolean strictTraceId)

Methods inherited from class java.lang.Object

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

Method Detail

shutdownClientOnClose

public abstract ElasticsearchStorage.Builder shutdownClientOnClose(boolean shutdownClientOnClose)

hosts

public final ElasticsearchStorage.Builder hosts(List<String> hosts)

A list of elasticsearch nodes to connect to, in http://host:port or https://host:port format. Defaults to "http://localhost:9200".

hostsSupplier

public abstract ElasticsearchStorage.Builder hostsSupplier(ElasticsearchStorage.HostsSupplier hosts)

Like hosts(List), except the value is deferred.

This was added to support dynamic endpoint resolution for Amazon Elasticsearch. This value is only read once.

maxRequests

public abstract ElasticsearchStorage.Builder maxRequests(int maxRequests)

Sets maximum in-flight requests from this process to any Elasticsearch host. Defaults to 64

A backlog is not permitted. Once this number of requests are in-flight, future requests will drop until we are under maxRequests again. This allows the server to remain up during a traffic surge.

pipeline

public abstract ElasticsearchStorage.Builder pipeline(String pipeline)

Only valid when the destination is Elasticsearch 5.x. Indicates the ingest pipeline used before spans are indexed. No default.

See https://www.elastic.co/guide/en/elasticsearch/reference/master/pipeline.html

namesLookback

public abstract ElasticsearchStorage.Builder namesLookback(int namesLookback)

Only return span and service names where all Span.timestamp() are at or after (now - lookback) in milliseconds. Defaults to 1 day (86400000).

flushOnWrites

public abstract ElasticsearchStorage.Builder flushOnWrites(boolean flushOnWrites)

Visible for testing

index

public final ElasticsearchStorage.Builder index(String index)

The index prefix to use when generating daily index names. Defaults to zipkin.

dateSeparator

public final ElasticsearchStorage.Builder dateSeparator(char dateSeparator)

The date separator to use when generating daily index names. Defaults to '-'.

By default, spans with a timestamp falling on 2016/03/19 end up in the index 'zipkin:span-2016-03-19'. When the date separator is '.', the index would be 'zipkin:span-2016.03.19'. If the date separator is 0, there is no delimiter. Ex the index would be 'zipkin:span-20160319'

indexShards

public abstract ElasticsearchStorage.Builder indexShards(int indexShards)

The number of shards to split the index into. Each shard and its replicas are assigned to a machine in the cluster. Increasing the number of shards and machines in the cluster will improve read and write performance. Number of shards cannot be changed for existing indices, but new daily indices will pick up changes to the setting. Defaults to 5.

Corresponds to index.number_of_shards

indexReplicas

public abstract ElasticsearchStorage.Builder indexReplicas(int indexReplicas)

The number of replica copies of each shard in the index. Each shard and its replicas are assigned to a machine in the cluster. Increasing the number of replicas and machines in the cluster will improve read performance, but not write performance. Number of replicas can be changed for existing indices. Defaults to 1. It is highly discouraged to set this to 0 as it would mean a machine failure results in data loss.

Corresponds to index.number_of_replicas

strictTraceId

public abstract ElasticsearchStorage.Builder strictTraceId(boolean strictTraceId)

Specified by:

strictTraceId in class StorageComponent.Builder

searchEnabled

public abstract ElasticsearchStorage.Builder searchEnabled(boolean searchEnabled)

Specified by:

searchEnabled in class StorageComponent.Builder

build

public abstract ElasticsearchStorage build()

Specified by:

build in class StorageComponent.Builder