ConfigProvider (OpenTelemetry API Incubator)

@ThreadSafe public interface ConfigProvider

A registry for accessing declarative configuration.

The name Provider is for consistency with other languages and it is NOT loaded using reflection.

See InstrumentationConfigUtil for convenience methods for extracting config from ConfigProvider.

Method Summary

Modifier and Type

Method

Description

default DeclarativeConfigProperties

getGeneralInstrumentationConfig()

Returns the DeclarativeConfigProperties for general instrumentation configuration.

DeclarativeConfigProperties

getInstrumentationConfig()

Returns the DeclarativeConfigProperties corresponding to instrumentation config, or DeclarativeConfigProperties.empty() if unavailable.

default DeclarativeConfigProperties

getInstrumentationConfig(String name)

Returns the DeclarativeConfigProperties for a specific instrumentation by name.

static ConfigProvider

noop()

Returns a no-op ConfigProvider.

Method Details
- getInstrumentationConfig
  
  DeclarativeConfigProperties getInstrumentationConfig()
  
  Returns the DeclarativeConfigProperties corresponding to instrumentation config, or DeclarativeConfigProperties.empty() if unavailable.
  
  Returns:
  
  the instrumentation DeclarativeConfigProperties
- getInstrumentationConfig
  
  default DeclarativeConfigProperties getInstrumentationConfig(String name)
  Returns the DeclarativeConfigProperties for a specific instrumentation by name. If no configuration is available for the given name, an empty DeclarativeConfigProperties is returned.
  For example, getInstrumentationConfig("foo") returns the node:
  instrumentation/development: java: foo:
  Parameters:
  
  name - the name of the instrumentation
  
  Returns:
  
  the DeclarativeConfigProperties for the given instrumentation name
- getGeneralInstrumentationConfig
  
  default DeclarativeConfigProperties getGeneralInstrumentationConfig()
  Returns the DeclarativeConfigProperties for general instrumentation configuration.
  instrumentation/development: general:
  
  If the general configuration is not available, an empty DeclarativeConfigProperties is returned.
  Returns:
  
  the DeclarativeConfigProperties for the general instrumentation configuration
- noop
  
  static ConfigProvider noop()
  
  Returns a no-op ConfigProvider.