Package io.opentelemetry.sdk.autoconfigure.spi

Interface ConfigProperties

public interface ConfigProperties

Properties used for auto-configuration of the OpenTelemetry SDK components.

Method Summary

Modifier and Type	Method	Description
Boolean	getBoolean(String name)	Returns a boolean-valued configuration property.
Double	getDouble(String name)	Returns a double-valued configuration property.
Duration	getDuration(String name)	Returns a duration property from the map, or null if it cannot be found or it has a wrong type.
Integer	getInt(String name)	Returns a integer-valued configuration property.
List<String>	getList(String name)	Returns a list-valued configuration property.
Long	getLong(String name)	Returns a long-valued configuration property.
Map<String,String>	getMap(String name)	Returns a map-valued configuration property.
String	getString(String name)	Returns a string-valued configuration property.

Method Detail

getString

@Nullable
String getString(String name)

Returns a string-valued configuration property.

Returns:

null if the property has not been configured.

Throws:

ConfigurationException - if the property is not a valid string.

getBoolean

@Nullable
Boolean getBoolean(String name)

Returns a boolean-valued configuration property. Implementations should use the same rules as Boolean.parseBoolean(String) for handling the values.

Returns:

null if the property has not been configured.

Throws:

ConfigurationException - if the property is not a valid boolean.

getInt

@Nullable
Integer getInt(String name)

Returns a integer-valued configuration property.

Returns:

null if the property has not been configured.

Throws:

ConfigurationException - if the property is not a valid integer.

getLong

@Nullable
Long getLong(String name)

Returns a long-valued configuration property.

Returns:

null if the property has not been configured.

Throws:

ConfigurationException - if the property is not a valid long.

getDouble

@Nullable
Double getDouble(String name)

Returns a double-valued configuration property.

Returns:

null if the property has not been configured.

Throws:

ConfigurationException - if the property is not a valid double.

getDuration

@Nullable
Duration getDuration(String name)

Returns a duration property from the map, or null if it cannot be found or it has a wrong type.

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.

Parameters:

name - The property name

Returns:

the Duration value of the property, null if the property cannot be found.

Throws:

ConfigurationException - for malformed duration strings.

getList

List<String> getList(String name)

Returns a list-valued configuration property. The format of the original value must be comma-separated. Empty values will be removed.

Returns:

an empty list if the property has not been configured.

Throws:

ConfigurationException - if the property is not a valid comma-separated list.

getMap

Map<String,String> getMap(String name)

Returns a map-valued configuration property. The format of the original value must be comma-separated for each key, with an '=' separating the key and value. For instance, service.name=Greatest Service,host.name=localhost Empty values will be removed.

Returns:

an empty map if the property has not been configured.

Throws:

ConfigurationException - for malformed map strings.