Package com.lightstep.tracer.shared

Class Options.OptionsBuilder

java.lang.Object

com.lightstep.tracer.shared.Options.OptionsBuilder

Enclosing class:

Options

public static class Options.OptionsBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
OptionsBuilder()
OptionsBuilder(Options options)

Method Summary

Modifier and Type	Method	Description
Options	build()	Sets the defaults for values not provided and constructs a new Options object.
Options.OptionsBuilder	withAccessToken(java.lang.String accessToken)	Sets the unique identifier for this application.
Options.OptionsBuilder	withClockSkewCorrection(boolean clockCorrection)
Options.OptionsBuilder	withCollectorHost(java.lang.String collectorHost)	Sets the host to which the tracer will send data.
Options.OptionsBuilder	withCollectorPort(int collectorPort)	Sets the port to which the tracer will send data.
Options.OptionsBuilder	withCollectorProtocol(java.lang.String protocol)	Sets the protocol which will be used when sending data to the tracer.
Options.OptionsBuilder	withComponentName(java.lang.String name)	Sets the component name attribute.
Options.OptionsBuilder	withDisableReportingLoop(boolean disable)	If true, the background reporting loop will be disabled.
Options.OptionsBuilder	withMaxBufferedSpans(int maxBufferedSpans)	Sets the maximum number of finished Spans buffered locally before flushing.
Options.OptionsBuilder	withMaxReportingIntervalMillis(int maxReportingIntervalMillis)	Sets the maximum interval between reports.
Options.OptionsBuilder	withResetClient(boolean reset)	If true, the GRPC client connection will be reset at regular intevals Used to load balance on server side
Options.OptionsBuilder	withTag(java.lang.String key, java.lang.Object value)	Sets a user-defined key-value pair that should be associated with all of the data produced by this tracer.
Options.OptionsBuilder	withVerbosity(int verbosity)	Controls the amount of local output produced by the tracer.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionsBuilder

public OptionsBuilder()

OptionsBuilder

public OptionsBuilder(Options options)

Method Detail

withAccessToken

public Options.OptionsBuilder withAccessToken(java.lang.String accessToken)

Sets the unique identifier for this application.

Parameters:

accessToken - Your specific token for LightStep access.

withCollectorProtocol

public Options.OptionsBuilder withCollectorProtocol(java.lang.String protocol)

Sets the protocol which will be used when sending data to the tracer.

Parameters:

protocol - Either 'http' or 'https'

Throws:

java.lang.IllegalArgumentException - If the protocol argument is invalid.

withCollectorHost

public Options.OptionsBuilder withCollectorHost(java.lang.String collectorHost)

Sets the host to which the tracer will send data. If not set, will default to the primary LightStep collector address.

Parameters:

collectorHost - The hostname for the LightStep collector.

Throws:

java.lang.IllegalArgumentException - If the collectorHost argument is invalid.

withCollectorPort

public Options.OptionsBuilder withCollectorPort(int collectorPort)

Sets the port to which the tracer will send data. If not set, will default to DEFAULT_SECURE_PORT when the protocol is https and DEFAULT_PLAINTEXT_PORT when the protocol is http.

Parameters:

collectorPort - The port for the LightStep collector.

Throws:

java.lang.IllegalArgumentException - If the collectorPort is invalid.

withComponentName

public Options.OptionsBuilder withComponentName(java.lang.String name)

Sets the component name attribute. If not set, will default to the Java runtime command.

Parameters:

name - The name of the component being traced.

withTag

public Options.OptionsBuilder withTag(java.lang.String key,
                                      java.lang.Object value)

Sets a user-defined key-value pair that should be associated with all of the data produced by this tracer.

withMaxReportingIntervalMillis

public Options.OptionsBuilder withMaxReportingIntervalMillis(int maxReportingIntervalMillis)

Sets the maximum interval between reports.

Parameters:

maxReportingIntervalMillis - The maximum interval of time that will pass between reports.

withMaxBufferedSpans

public Options.OptionsBuilder withMaxBufferedSpans(int maxBufferedSpans)

Sets the maximum number of finished Spans buffered locally before flushing. This is a protective mechanism which bounds the memory usage of the LightStep library.

Parameters:

maxBufferedSpans - The maximum number of Spans buffered locally.

withVerbosity

public Options.OptionsBuilder withVerbosity(int verbosity)

Controls the amount of local output produced by the tracer. It does not affect which spans are sent to the collector. It is useful for diagnosing problems in the tracer itself. The default value is 1. 0 - never produce local output 1 - only the first error encountered will be echoed locally 2 - all errors are echoed locally 3 - all errors, warnings, and info statements are echoed locally 4 - all internal log statements, including debugging details

withDisableReportingLoop

public Options.OptionsBuilder withDisableReportingLoop(boolean disable)

If true, the background reporting loop will be disabled. Reports will only occur on explicit calls to Flush(); If not set, will default to DEFAULT_REPORTING_INTERVAL_MILLIS.

withResetClient

public Options.OptionsBuilder withResetClient(boolean reset)

If true, the GRPC client connection will be reset at regular intevals Used to load balance on server side

withClockSkewCorrection

public Options.OptionsBuilder withClockSkewCorrection(boolean clockCorrection)

build

public Options build()
              throws java.net.MalformedURLException

Sets the defaults for values not provided and constructs a new Options object.

Returns:

Options object configured with the built values.

Throws:

java.net.MalformedURLException - If the combination of collector protocol, host, and port are not valid