Configuration (jaeger-core 0.27.0 API)

java.lang.Object
- io.jaegertracing.Configuration

```
public class Configuration
extends java.lang.Object
```
This class is designed to provide Tracer or Tracer.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 double`	`DEFAULT_SAMPLING_PROBABILITY` Deprecated. use `ProbabilisticSampler.DEFAULT_SAMPLING_PROBABILITY` instead
`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_SERVICE_NAME` The service name.
`static java.lang.String`	`JAEGER_TAGS` The tracer level tags.
`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)`
`Configuration(java.lang.String serviceName, Configuration.SamplerConfiguration samplerConfig, Configuration.ReporterConfiguration reporterConfig)` Deprecated. use `Configuration(String)` and fluent API

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`closeTracer()`
`static Configuration`	`fromEnv()`
`Configuration.ReporterConfiguration`	`getReporter()`
`Configuration.SamplerConfiguration`	`getSampler()`
`io.opentracing.Tracer`	`getTracer()`
`Tracer.Builder`	`getTracerBuilder()`
`java.util.Map<java.lang.String,java.lang.String>`	`getTracerTags()`
`void`	`setStatsFactor(StatsFactory statsFactory)` Deprecated. Use `withMetricsFactory(MetricsFactory)` instead
`void`	`setStatsFactory(StatsFactory statsFactory)` Deprecated. Use `withMetricsFactory(MetricsFactory)` instead
`Configuration`	`withCodec(Configuration.CodecConfiguration codecConfig)`
`void`	`withMetricsFactory(MetricsFactory metricsFactory)`
`Configuration`	`withReporter(Configuration.ReporterConfiguration reporterConfig)`
`Configuration`	`withSampler(Configuration.SamplerConfiguration samplerConfig)`
`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
  - DEFAULT_SAMPLING_PROBABILITY
```
@Deprecated
public static final double DEFAULT_SAMPLING_PROBABILITY
```
    Deprecated. use ProbabilisticSampler.DEFAULT_SAMPLING_PROBABILITY instead
    
    See Also:
    
    Constant Field Values
  - 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
- Constructor Detail
  - Configuration
```
public Configuration(java.lang.String serviceName)
```
  - Configuration
```
@Deprecated
public Configuration(java.lang.String serviceName,
                                 Configuration.SamplerConfiguration samplerConfig,
                                 Configuration.ReporterConfiguration reporterConfig)
```
    Deprecated. use Configuration(String) and fluent API
- Method Detail
  - fromEnv
```
public static Configuration fromEnv()
```
    Returns:
    
    Configuration object from environmental variables
  - getTracerBuilder
```
public Tracer.Builder getTracerBuilder()
```
  - getTracer
```
public io.opentracing.Tracer getTracer()
```
  - closeTracer
```
public void closeTracer()
```
  - setStatsFactor
```
@Deprecated
public void setStatsFactor(StatsFactory statsFactory)
```
    Deprecated. Use withMetricsFactory(MetricsFactory) instead
    
    Parameters:
    
    statsFactory - the StatsFactory to use on the Tracer to be built
    
    See Also:
    
    withMetricsFactory(MetricsFactory)
  - setStatsFactory
```
@Deprecated
public void setStatsFactory(StatsFactory statsFactory)
```
    Deprecated. Use withMetricsFactory(MetricsFactory) instead
    
    Parameters:
    
    statsFactory - the StatsFactory to use on the Tracer to be built
    
    See Also:
    
    withMetricsFactory(MetricsFactory)
  - withMetricsFactory
```
public void withMetricsFactory(MetricsFactory metricsFactory)
```
    Parameters:
    
    metricsFactory - the MetricsFactory to use on the Tracer to be built
  - withReporter
```
public Configuration withReporter(Configuration.ReporterConfiguration reporterConfig)
```
  - withSampler
```
public Configuration withSampler(Configuration.SamplerConfiguration samplerConfig)
```
  - withCodec
```
public Configuration withCodec(Configuration.CodecConfiguration codecConfig)
```
  - withTracerTags
```
public Configuration withTracerTags(java.util.Map<java.lang.String,java.lang.String> tracerTags)
```
  - getReporter
```
public Configuration.ReporterConfiguration getReporter()
```
  - getSampler
```
public Configuration.SamplerConfiguration getSampler()
```
  - 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

DEFAULT_SAMPLING_PROBABILITY

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

Constructor Detail

Configuration

Configuration

Method Detail

fromEnv

getTracerBuilder

getTracer

closeTracer

setStatsFactor

setStatsFactory

withMetricsFactory

withReporter

withSampler

withCodec

withTracerTags

getReporter

getSampler

getTracerTags