Configuration (jaeger-core 1.2.0 API)

java.lang.Object
- io.jaegertracing.Configuration

```
public class Configuration
extends java.lang.Object
```
This class is designed to provide JaegerTracer or JaegerTracer.Builder when Jaeger client configuration is provided in environmental or property variables. It also simplifies creation of the client from configuration files.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Configuration.CodecConfiguration` CodecConfiguration can be used to support additional trace context propagation codec.
`static class`	`Configuration.Propagation` The supported trace context propagation formats.
`static class`	`Configuration.ReporterConfiguration`
`static class`	`Configuration.SamplerConfiguration` SamplerConfiguration allows to configure which sampler the tracer will use.
`static class`	`Configuration.SenderConfiguration` Holds the configuration related to the sender.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`JAEGER_AGENT_HOST` The host name used to locate the agent.
`static java.lang.String`	`JAEGER_AGENT_PORT` The port used to locate the agent.
`static java.lang.String`	`JAEGER_AUTH_TOKEN` The Auth Token to be added as "Bearer" on Authorization headers for requests sent to the endpoint
`static java.lang.String`	`JAEGER_ENDPOINT` The full URL to the `traces` endpoint, like https://jaeger-collector:14268/api/traces
`static java.lang.String`	`JAEGER_PASSWORD` The Basic Auth password to be added on Authorization headers for requests sent to the endpoint
`static java.lang.String`	`JAEGER_PREFIX` Prefix for all properties used to configure the Jaeger tracer.
`static java.lang.String`	`JAEGER_PROPAGATION` Comma separated list of formats to use for propagating the trace context.
`static java.lang.String`	`JAEGER_REPORTER_FLUSH_INTERVAL` The flush interval when reporting spans remotely.
`static java.lang.String`	`JAEGER_REPORTER_LOG_SPANS` Whether the reporter should log the spans.
`static java.lang.String`	`JAEGER_REPORTER_MAX_QUEUE_SIZE` The maximum queue size for use when reporting spans remotely.
`static java.lang.String`	`JAEGER_SAMPLER_MANAGER_HOST_PORT` The sampler manager host:port.
`static java.lang.String`	`JAEGER_SAMPLER_PARAM` The sampler parameter (number).
`static java.lang.String`	`JAEGER_SAMPLER_TYPE` The sampler type.
`static java.lang.String`	`JAEGER_SENDER_FACTORY` When there are multiple service providers for the `SenderFactory` available, this var is used to select a `SenderFactory` by matching it with `SenderFactory.getType()`.
`static java.lang.String`	`JAEGER_SERVICE_NAME` The service name.
`static java.lang.String`	`JAEGER_TAGS` The tracer level tags.
`static java.lang.String`	`JAEGER_TRACEID_128BIT` Opt-in to use 128 bit traceIds.
`static java.lang.String`	`JAEGER_USER` The Basic Auth username to be added on Authorization headers for requests sent to the endpoint

Constructor Summary

Constructors
Constructor and Description

Configuration(java.lang.String serviceName)

Constructors
Constructor and Description
`Configuration(java.lang.String serviceName)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeTracer()`
`protected JaegerTracer.Builder`	`createTracerBuilder(java.lang.String serviceName)`
`static Configuration`	`fromEnv()`
`static Configuration`	`fromEnv(java.lang.String serviceName)`
`Configuration.CodecConfiguration`	`getCodec()`
`MetricsFactory`	`getMetricsFactory()`
`Configuration.ReporterConfiguration`	`getReporter()`
`Configuration.SamplerConfiguration`	`getSampler()`
`java.lang.String`	`getServiceName()`
`JaegerTracer`	`getTracer()`
`JaegerTracer.Builder`	`getTracerBuilder()`
`java.util.Map<java.lang.String,java.lang.String>`	`getTracerTags()`
`Configuration`	`withCodec(Configuration.CodecConfiguration codecConfig)`
`Configuration`	`withMetricsFactory(MetricsFactory metricsFactory)`
`Configuration`	`withReporter(Configuration.ReporterConfiguration reporterConfig)`
`Configuration`	`withSampler(Configuration.SamplerConfiguration samplerConfig)`
`Configuration`	`withServiceName(java.lang.String serviceName)`
`Configuration`	`withTraceId128Bit(boolean useTraceId128Bit)`
`Configuration`	`withTracerTags(java.util.Map<java.lang.String,java.lang.String> tracerTags)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JAEGER_PREFIX
```
public static final java.lang.String JAEGER_PREFIX
```
    Prefix for all properties used to configure the Jaeger tracer.
    
    See Also:
    
    Constant Field Values
  - JAEGER_ENDPOINT
```
public static final java.lang.String JAEGER_ENDPOINT
```
    The full URL to the traces endpoint, like https://jaeger-collector:14268/api/traces
    
    See Also:
    
    Constant Field Values
  - JAEGER_AUTH_TOKEN
```
public static final java.lang.String JAEGER_AUTH_TOKEN
```
    The Auth Token to be added as "Bearer" on Authorization headers for requests sent to the endpoint
    
    See Also:
    
    Constant Field Values
  - JAEGER_USER
```
public static final java.lang.String JAEGER_USER
```
    The Basic Auth username to be added on Authorization headers for requests sent to the endpoint
    
    See Also:
    
    Constant Field Values
  - JAEGER_PASSWORD
```
public static final java.lang.String JAEGER_PASSWORD
```
    The Basic Auth password to be added on Authorization headers for requests sent to the endpoint
    
    See Also:
    
    Constant Field Values
  - JAEGER_AGENT_HOST
```
public static final java.lang.String JAEGER_AGENT_HOST
```
    The host name used to locate the agent.
    
    See Also:
    
    Constant Field Values
  - JAEGER_AGENT_PORT
```
public static final java.lang.String JAEGER_AGENT_PORT
```
    The port used to locate the agent.
    
    See Also:
    
    Constant Field Values
  - JAEGER_REPORTER_LOG_SPANS
```
public static final java.lang.String JAEGER_REPORTER_LOG_SPANS
```
    Whether the reporter should log the spans.
    
    See Also:
    
    Constant Field Values
  - JAEGER_REPORTER_MAX_QUEUE_SIZE
```
public static final java.lang.String JAEGER_REPORTER_MAX_QUEUE_SIZE
```
    The maximum queue size for use when reporting spans remotely.
    
    See Also:
    
    Constant Field Values
  - JAEGER_REPORTER_FLUSH_INTERVAL
```
public static final java.lang.String JAEGER_REPORTER_FLUSH_INTERVAL
```
    The flush interval when reporting spans remotely.
    
    See Also:
    
    Constant Field Values
  - JAEGER_SAMPLER_TYPE
```
public static final java.lang.String JAEGER_SAMPLER_TYPE
```
    The sampler type.
    
    See Also:
    
    Constant Field Values
  - JAEGER_SAMPLER_PARAM
```
public static final java.lang.String JAEGER_SAMPLER_PARAM
```
    The sampler parameter (number).
    
    See Also:
    
    Constant Field Values
  - JAEGER_SAMPLER_MANAGER_HOST_PORT
```
public static final java.lang.String JAEGER_SAMPLER_MANAGER_HOST_PORT
```
    The sampler manager host:port.
    
    See Also:
    
    Constant Field Values
  - JAEGER_SERVICE_NAME
```
public static final java.lang.String JAEGER_SERVICE_NAME
```
    The service name.
    
    See Also:
    
    Constant Field Values
  - JAEGER_TAGS
```
public static final java.lang.String JAEGER_TAGS
```
    The tracer level tags.
    
    See Also:
    
    Constant Field Values
  - JAEGER_PROPAGATION
```
public static final java.lang.String JAEGER_PROPAGATION
```
    Comma separated list of formats to use for propagating the trace context. Default will the standard Jaeger format. Valid values are jaeger and b3.
    
    See Also:
    
    Constant Field Values
  - JAEGER_SENDER_FACTORY
```
public static final java.lang.String JAEGER_SENDER_FACTORY
```
    When there are multiple service providers for the SenderFactory available, this var is used to select a SenderFactory by matching it with SenderFactory.getType().
    
    See Also:
    
    Constant Field Values
  - JAEGER_TRACEID_128BIT
```
public static final java.lang.String JAEGER_TRACEID_128BIT
```
    Opt-in to use 128 bit traceIds. By default, uses 64 bits.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Configuration
```
public Configuration(java.lang.String serviceName)
```
- Method Detail
  - fromEnv
```
public static Configuration fromEnv()
```
    Returns:
    
    Configuration object from environmental variables
  - fromEnv
```
public static Configuration fromEnv(java.lang.String serviceName)
```
  - getTracerBuilder
```
public JaegerTracer.Builder getTracerBuilder()
```
  - createTracerBuilder
```
protected JaegerTracer.Builder createTracerBuilder(java.lang.String serviceName)
```
  - getTracer
```
public JaegerTracer getTracer()
```
  - closeTracer
```
public void closeTracer()
```
  - withMetricsFactory
```
public Configuration withMetricsFactory(MetricsFactory metricsFactory)
```
    Parameters:
    
    metricsFactory - the MetricsFactory to use on the JaegerTracer to be built
  - withServiceName
```
public Configuration withServiceName(java.lang.String serviceName)
```
  - withReporter
```
public Configuration withReporter(Configuration.ReporterConfiguration reporterConfig)
```
  - withSampler
```
public Configuration withSampler(Configuration.SamplerConfiguration samplerConfig)
```
  - withCodec
```
public Configuration withCodec(Configuration.CodecConfiguration codecConfig)
```
  - withTraceId128Bit
```
public Configuration withTraceId128Bit(boolean useTraceId128Bit)
```
  - withTracerTags
```
public Configuration withTracerTags(java.util.Map<java.lang.String,java.lang.String> tracerTags)
```
  - getServiceName
```
public java.lang.String getServiceName()
```
  - getReporter
```
public Configuration.ReporterConfiguration getReporter()
```
  - getSampler
```
public Configuration.SamplerConfiguration getSampler()
```
  - getCodec
```
public Configuration.CodecConfiguration getCodec()
```
  - getMetricsFactory
```
public MetricsFactory getMetricsFactory()
```
  - getTracerTags
```
public java.util.Map<java.lang.String,java.lang.String> getTracerTags()
```

Class Configuration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JAEGER_PREFIX

JAEGER_ENDPOINT

JAEGER_AUTH_TOKEN

JAEGER_USER

JAEGER_PASSWORD

JAEGER_AGENT_HOST

JAEGER_AGENT_PORT

JAEGER_REPORTER_LOG_SPANS

JAEGER_REPORTER_MAX_QUEUE_SIZE

JAEGER_REPORTER_FLUSH_INTERVAL

JAEGER_SAMPLER_TYPE

JAEGER_SAMPLER_PARAM

JAEGER_SAMPLER_MANAGER_HOST_PORT

JAEGER_SERVICE_NAME

JAEGER_TAGS

JAEGER_PROPAGATION

JAEGER_SENDER_FACTORY

JAEGER_TRACEID_128BIT

Constructor Detail

Configuration

Method Detail

fromEnv

fromEnv

getTracerBuilder

createTracerBuilder

getTracer

closeTracer

withMetricsFactory

withServiceName

withReporter

withSampler

withCodec

withTraceId128Bit

withTracerTags

getServiceName

getReporter

getSampler

getCodec

getMetricsFactory

getTracerTags