com.github.kristofa.brave.zipkin

Class ZipkinSpanCollectorParams

java.lang.Object

com.github.kristofa.brave.zipkin.ZipkinSpanCollectorParams

public class ZipkinSpanCollectorParams
extends Object

Optional parameters for ZipkinSpanCollector.

If not specified we will use the default values. We support following parameters:

• queue size: Size of the queue that is used as buffer between producers of spans and the thread(s) that submit the spans to collector.
• batch size: The maximum number of spans that is submitted at once to collector of spans.
• number of threads: The number of parallel threads for submitting spans to collector.
• socket time out: Time in milliseconds after which our socket connections will time out. When it times out an exception will be thrown.
• fail on setup: Indicates if ZipkinSpanCollector should fail on creation when connection with collector can't be established or just log error message.

Author:

kristof

Field Summary

Fields

Modifier and Type	Field and Description
int	DEFAULT_BATCH_SIZE
int	DEFAULT_NR_OF_THREADS
int	DEFAULT_QUEUE_SIZE
int	DEFAULT_SOCKET_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ZipkinSpanCollectorParams() Create a new instance with default values.

Method Summary

Modifier and Type	Method and Description
boolean	failOnSetup() Indicates if ZipkinSpanCollector should fail on creation when connection with collector can't be established.
int	getBatchSize() Gets the maximum batch size.
int	getNrOfThreads() Gets the number of threads.
int	getQueueSize() Gets queue size.
int	getSocketTimeout() Gets the socket time out.
void	setBatchSize(int batchSize) Sets the batch size.
void	setFailOnSetup(boolean failOnSetup) Sets fail on setup value.
void	setNrOfThreads(int nrOfThreads) Sets the number of parallel threads for submitting spans to collector.
void	setQueueSize(int queueSize) Sets the size of the queue that is used as buffer between producers of spans and the thread(s) that submit the spans to collector.
void	setSocketTimeout(int socketTimeout) Sets the socket time out in milliseconds.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_QUEUE_SIZE

public int DEFAULT_QUEUE_SIZE

DEFAULT_BATCH_SIZE

public int DEFAULT_BATCH_SIZE

DEFAULT_NR_OF_THREADS

public int DEFAULT_NR_OF_THREADS

DEFAULT_SOCKET_TIMEOUT

public int DEFAULT_SOCKET_TIMEOUT

Constructor Detail

ZipkinSpanCollectorParams

public ZipkinSpanCollectorParams()

Create a new instance with default values.

Method Detail

getQueueSize

public int getQueueSize()

Gets queue size.

Returns:

queue size.

setQueueSize

public void setQueueSize(int queueSize)

Sets the size of the queue that is used as buffer between producers of spans and the thread(s) that submit the spans to collector.

Parameters:

queueSize - Queue size.

getBatchSize

public int getBatchSize()

Gets the maximum batch size.

Returns:

Maximum queue size.

setBatchSize

public void setBatchSize(int batchSize)

Sets the batch size. The batch size is the maximum number of spans that is submitted at once to the collector.

Parameters:

batchSize - Maximum batch size.

getNrOfThreads

public int getNrOfThreads()

Gets the number of threads.

Returns:

Number of threads.

setNrOfThreads

public void setNrOfThreads(int nrOfThreads)

Sets the number of parallel threads for submitting spans to collector.

Parameters:

nrOfThreads - Number of parallel threads for submitting spans to collector.

getSocketTimeout

public int getSocketTimeout()

Gets the socket time out.

Returns:

Returns the socket time out in milliseconds.

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

Sets the socket time out in milliseconds.

Parameters:

socketTimeout - Socket time out in milliseconds. Should be >= 100;

setFailOnSetup

public void setFailOnSetup(boolean failOnSetup)

Sets fail on setup value.

Parameters:

failOnSetup - true in case ZipkinSpanCollector will throw exception when connection can't be established during setup. Or false in case we should log message but not throw exception.

failOnSetup

public boolean failOnSetup()

Indicates if ZipkinSpanCollector should fail on creation when connection with collector can't be established.

Returns:

true in case ZipkinSpanCollector will throw exception when connection can't be established during setup. Or false in case we should log message but not throw exception. Default value = true.