Config (instrumentation-api 1.9.1-alpha API)

java.lang.Object
- io.opentelemetry.instrumentation.api.config.Config

```
public abstract class Config
extends Object
```
Represents the global agent configuration consisting of system properties, environment variables, contents of the agent configuration file and properties defined by the ConfigPropertySource SPI (see ConfigInitializer and ConfigBuilder).
In case any get*() method variant gets called for the same property more than once (e.g. each time an advice class executes) it is suggested to cache the result instead of repeatedly calling Config. Agent configuration does not change during the runtime so retrieving the property once and storing its result in e.g. static final field allows JIT to do its magic and remove some code branches.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Properties`	`asJavaProperties()`	Deprecated. Use `getAllProperties()` instead.
`static ConfigBuilder`	`builder()`	Start building a new `Config` instance.
`static Config`	`get()`	Returns the global agent configuration.
`abstract Map<String,String>`	`getAllProperties()`	Returns all properties stored in this instance.
`Boolean`	`getBoolean(String name)`	Returns a boolean-valued configuration property or `null` if a property with name `name` has not been configured.
`boolean`	`getBoolean(String name, boolean defaultValue)`	Returns a boolean-valued configuration property or `defaultValue` if a property with name `name` has not been configured.
`Double`	`getDouble(String name)`	Returns a double-valued configuration property or `null` if a property with name `name` has not been configured.
`double`	`getDouble(String name, double defaultValue)`	Returns a double-valued configuration property or `defaultValue` if a property with name `name` has not been configured or when parsing has failed.
`Duration`	`getDuration(String name)`	Returns a duration-valued configuration property or `null` if a property with name `name` has not been configured.
`Duration`	`getDuration(String name, Duration defaultValue)`	Returns a duration-valued configuration property or `defaultValue` if a property with name `name` has not been configured or when parsing has failed.
`Integer`	`getInt(String name)`	Returns a integer-valued configuration property or `null` if a property with name `name` has not been configured.
`int`	`getInt(String name, int defaultValue)`	Returns a integer-valued configuration property or `defaultValue` if a property with name `name` has not been configured or when parsing has failed.
`List<String>`	`getList(String name)`	Returns a list-valued configuration property or an empty list if a property with name `name` has not been configured.
`List<String>`	`getList(String name, List<String> defaultValue)`	Returns a list-valued configuration property or `defaultValue` if a property with name `name` has not been configured.
`Long`	`getLong(String name)`	Returns a long-valued configuration property or `null` if a property with name `name` has not been configured.
`long`	`getLong(String name, long defaultValue)`	Returns a long-valued configuration property or `defaultValue` if a property with name `name` has not been configured or when parsing has failed.
`Map<String,String>`	`getMap(String name)`	Returns a map-valued configuration property or an empty map if a property with name `name` has not been configured.
`Map<String,String>`	`getMap(String name, Map<String,String> defaultValue)`	Returns a map-valued configuration property or `defaultValue` if a property with name `name` has not been configured or when parsing has failed.
`String`	`getString(String name)`	Returns a string-valued configuration property or `null` if a property with name `name` has not been configured.
`String`	`getString(String name, String defaultValue)`	Returns a string-valued configuration property or `defaultValue` if a property with name `name` has not been configured.
`static void`	`internalInitializeConfig(Config config)`	Sets the agent configuration singleton.
`boolean`	`isAgentDebugEnabled()`
`boolean`	`isInstrumentationEnabled(Iterable<String> instrumentationNames, boolean defaultEnabled)`
`boolean`	`isInstrumentationPropertyEnabled(Iterable<String> instrumentationNames, String suffix, boolean defaultEnabled)`

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

- Method Detail
  - builder
```
public static ConfigBuilder builder()
```
    Start building a new Config instance.
  - internalInitializeConfig
```
public static void internalInitializeConfig(Config config)
```
    Sets the agent configuration singleton. This method is only supposed to be called once, from the agent classloader just before the first instrumentation is loaded (and before get() is used for the first time).
  - get
```
public static Config get()
```
    Returns the global agent configuration.
  - getAllProperties
```
public abstract Map<String,String> getAllProperties()
```
    Returns all properties stored in this instance. The returned map is unmodifiable.
  - getString
```
@Nullable
public String getString(String name)
```
    Returns a string-valued configuration property or null if a property with name name has not been configured.
  - getString
```
public String getString(String name,
                        String defaultValue)
```
    Returns a string-valued configuration property or defaultValue if a property with name name has not been configured.
  - getBoolean
```
@Nullable
public Boolean getBoolean(String name)
```
    Returns a boolean-valued configuration property or null if a property with name name has not been configured.
  - getBoolean
```
public boolean getBoolean(String name,
                          boolean defaultValue)
```
    Returns a boolean-valued configuration property or defaultValue if a property with name name has not been configured.
  - getInt
```
@Nullable
public Integer getInt(String name)
```
    Returns a integer-valued configuration property or null if a property with name name has not been configured.
    
    Throws:
    
    ConfigParsingException - if the property is not a valid integer.
  - getInt
```
public int getInt(String name,
                  int defaultValue)
```
    Returns a integer-valued configuration property or defaultValue if a property with name name has not been configured or when parsing has failed. This is the safe variant of getInt(String).
  - getLong
```
@Nullable
public Long getLong(String name)
```
    Returns a long-valued configuration property or null if a property with name name has not been configured.
    
    Throws:
    
    ConfigParsingException - if the property is not a valid long.
  - getLong
```
public long getLong(String name,
                    long defaultValue)
```
    Returns a long-valued configuration property or defaultValue if a property with name name has not been configured or when parsing has failed. This is the safe variant of getLong(String).
  - getDouble
```
@Nullable
public Double getDouble(String name)
```
    Returns a double-valued configuration property or null if a property with name name has not been configured.
    
    Throws:
    
    ConfigParsingException - if the property is not a valid long.
  - getDouble
```
public double getDouble(String name,
                        double defaultValue)
```
    Returns a double-valued configuration property or defaultValue if a property with name name has not been configured or when parsing has failed. This is the safe variant of getDouble(String).
  - getDuration
```
@Nullable
public Duration getDuration(String name)
```
    Returns a duration-valued configuration property or null if a property with name name has not been configured.
    Durations can be of the form "{number}{unit}", where unit is one of:
    
    ms
    s
    m
    h
    d
    
    If no unit is specified, milliseconds is the assumed duration unit.
    Throws:
    
    ConfigParsingException - if the property is not a valid long.
  - getDuration
```
public Duration getDuration(String name,
                            Duration defaultValue)
```
    Returns a duration-valued configuration property or defaultValue if a property with name name has not been configured or when parsing has failed. This is the safe variant of getDuration(String).
    Durations can be of the form "{number}{unit}", where unit is one of:
    
    ms
    s
    m
    h
    d
    
    If no unit is specified, milliseconds is the assumed duration unit.
  - getList
```
public List<String> getList(String name)
```
    Returns a list-valued configuration property or an empty list if a property with name name has not been configured. The format of the original value must be comma-separated, e.g. one,two,three.
  - getList
```
public List<String> getList(String name,
                            List<String> defaultValue)
```
    Returns a list-valued configuration property or defaultValue if a property with name name has not been configured. The format of the original value must be comma-separated, e.g. one,two,three.
  - getMap
```
public Map<String,String> getMap(String name)
```
    Returns a map-valued configuration property or an empty map if a property with name name has not been configured. The format of the original value must be comma-separated for each key, with an '=' separating the key and value, e.g. key=value,anotherKey=anotherValue.
    
    Throws:
    
    ConfigParsingException - if the property is not a valid long.
  - getMap
```
public Map<String,String> getMap(String name,
                                       Map<String,String> defaultValue)
```
    Returns a map-valued configuration property or defaultValue if a property with name name has not been configured or when parsing has failed. This is the safe variant of getMap(String). The format of the original value must be comma-separated for each key, with an '=' separating the key and value, e.g. key=value,anotherKey=anotherValue.
  - isInstrumentationEnabled
```
public boolean isInstrumentationEnabled(Iterable<String> instrumentationNames,
                                        boolean defaultEnabled)
```
  - isInstrumentationPropertyEnabled
```
public boolean isInstrumentationPropertyEnabled(Iterable<String> instrumentationNames,
                                                String suffix,
                                                boolean defaultEnabled)
```
  - isAgentDebugEnabled
```
public boolean isAgentDebugEnabled()
```
  - asJavaProperties
```
@Deprecated
public Properties asJavaProperties()
```
    Deprecated.
    Use getAllProperties() instead.
    
    Converts this config instance to Java Properties.

Class Config

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

internalInitializeConfig

get

getAllProperties

getString

getString

getBoolean

getBoolean

getInt

getInt

getLong

getLong

getDouble

getDouble

getDuration

getDuration

getList

getList

getMap

getMap

isInstrumentationEnabled

isInstrumentationPropertyEnabled

isAgentDebugEnabled

asJavaProperties