zipkin.storage.elasticsearch.http

Class ElasticsearchHttpStorage.Builder

java.lang.Object

zipkin.storage.elasticsearch.http.ElasticsearchHttpStorage.Builder

All Implemented Interfaces:

StorageComponent.Builder

Enclosing class:

ElasticsearchHttpStorage

public abstract static class ElasticsearchHttpStorage.Builder
extends Object
implements StorageComponent.Builder

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

hosts

public final ElasticsearchHttpStorage.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 ElasticsearchHttpStorage.Builder hostsSupplier(ElasticsearchHttpStorage.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 ElasticsearchHttpStorage.Builder maxRequests(int maxRequests)

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

pipeline

public abstract ElasticsearchHttpStorage.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 ElasticsearchHttpStorage.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).

index

public final ElasticsearchHttpStorage.Builder index(String index)

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

dateSeparator

public final ElasticsearchHttpStorage.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-2016-03-19'. When the date separator is '.', the index would be 'zipkin-2016.03.19'.

indexShards

public abstract ElasticsearchHttpStorage.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 ElasticsearchHttpStorage.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 ElasticsearchHttpStorage.Builder strictTraceId(boolean strictTraceId)

Specified by:

strictTraceId in interface StorageComponent.Builder

build

public abstract ElasticsearchHttpStorage build()

Specified by:

build in interface StorageComponent.Builder