Package io.opentelemetry.sdk.autoconfigure.spi

Interface ConfigProperties

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

  • Method Details

    • 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.

    • getString

      default String getString(String name, String defaultValue)
      Returns a string-valued configuration property.
      Returns:
      a string-valued configuration property or defaultValue if a property with name has not been configured.
      Throws:
      ConfigurationException - if the property is not a valid string.
      Since:
      1.15.0

    • 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.

    • getBoolean

      default boolean getBoolean(String name, boolean defaultValue)
      Returns a boolean-valued configuration property.
      Returns:
      a Boolean-valued configuration property or defaultValue if a property with name has not been configured.
      Throws:
      ConfigurationException - if the property is not a valid string.
      Since:
      1.15.0

    • getInt

      @Nullable Integer getInt(String name)
      Returns an Integer-valued configuration property.
      Returns:
      null if the property has not been configured.
      Throws:
      ConfigurationException - if the property is not a valid integer.

    • getInt

      default int getInt(String name, int defaultValue)
      Returns an Integer-valued configuration property.
      Returns:
      an Integer-valued configuration property or defaultValue if a property with name has not been configured.
      Throws:
      ConfigurationException - if the property is not a valid string.
      Since:
      1.15.0

    • 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.

    • getLong

      default long getLong(String name, long defaultValue)
      Returns a Long-valued configuration property.
      Returns:
      a Long-valued configuration property or defaultValue if a property with name has not been configured.
      Throws:
      ConfigurationException - if the property is not a valid string.
      Since:
      1.15.0

    • 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.

    • getDouble

      default double getDouble(String name, double defaultValue)
      Returns a double-valued configuration property.
      Returns:
      a Double-valued configuration property or defaultValue if a property with name has not been configured.
      Throws:
      ConfigurationException - if the property is not a valid string.
      Since:
      1.15.0

    • 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.

    • getDuration

      default Duration getDuration(String name, Duration defaultValue)
      Returns a Duration value configuration property.
      Returns:
      a Double-valued configuration property or defaultValue if a property with name name has not been configured.
      Throws:
      ConfigurationException - if the property is not a valid string.
      Since:
      1.15.0
      See Also:

    • 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.

    • getList

      default List<String> getList(String name, List<String> defaultValue)
      Returns a List value configuration property.
      Returns:
      a List configuration property or defaultValue if a property with name has not been configured.
      Throws:
      ConfigurationException - if the property is not a valid string.
      Since:
      1.15.0
      See Also:

    • getMap

      Map<String,String> getMap(String name)
      Returns a Map 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.

    • getMap

      default Map<String,String> getMap(String name, Map<String,String> defaultValue)
      Returns a Map value configuration property.
      Returns:
      a Double-valued configuration property or defaultValue if a property with name has not been configured.
      Throws:
      ConfigurationException - if the property is not a valid string.
      Since:
      1.15.0
      See Also: