Package io.opentelemetry.api.incubator.config

Class InstrumentationConfigUtil

java.lang.Object

io.opentelemetry.api.incubator.config.InstrumentationConfigUtil

public class InstrumentationConfigUtil
extends Object

A collection of convenience methods to extract instrumentation config from ConfigProvider.getInstrumentationConfig().

Method Summary

Modifier and Type	Method	Description
static <T> T	getOrNull(ConfigProvider configProvider, Function<DeclarativeConfigProperties,T> accessor, String... segments)	Walk down the segments of ConfigProvider.getInstrumentationConfig() and call accessor on the terminal node.
static List<String>	httpClientRequestCapturedHeaders(ConfigProvider configProvider)	Return .instrumentation.general.http.client.request_captured_headers, or null if none is configured.
static List<String>	httpClientResponseCapturedHeaders(ConfigProvider configProvider)	Return .instrumentation.general.http.client.response_captured_headers, or null if none is configured.
static List<String>	httpServerRequestCapturedHeaders(ConfigProvider configProvider)	Return .instrumentation.general.http.server.request_captured_headers, or null if none is configured.
static List<String>	httpSeverResponseCapturedHeaders(ConfigProvider configProvider)	Return .instrumentation.general.http.server.response_captured_headers, or null if none is configured.
static DeclarativeConfigProperties	javaInstrumentationConfig(ConfigProvider configProvider, String instrumentationName)	Return .instrumentation.java.<instrumentationName>, or null if none is configured.
static Map<String,String>	peerServiceMapping(ConfigProvider configProvider)	Return a map representation of the peer service map entries in .instrumentation.general.peer.service_mapping, or null if none is configured.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

peerServiceMapping

@Nullable
public static Map<String,String> peerServiceMapping(ConfigProvider configProvider)

Return a map representation of the peer service map entries in .instrumentation.general.peer.service_mapping, or null if none is configured.

Throws:

DeclarativeConfigException - if an unexpected type is encountered accessing the property

httpClientRequestCapturedHeaders

@Nullable
public static List<String> httpClientRequestCapturedHeaders(ConfigProvider configProvider)

Return .instrumentation.general.http.client.request_captured_headers, or null if none is configured.

Throws:

DeclarativeConfigException - if an unexpected type is encountered accessing the property

httpClientResponseCapturedHeaders

@Nullable
public static List<String> httpClientResponseCapturedHeaders(ConfigProvider configProvider)

Return .instrumentation.general.http.client.response_captured_headers, or null if none is configured.

Throws:

DeclarativeConfigException - if an unexpected type is encountered accessing the property

httpServerRequestCapturedHeaders

@Nullable
public static List<String> httpServerRequestCapturedHeaders(ConfigProvider configProvider)

Return .instrumentation.general.http.server.request_captured_headers, or null if none is configured.

Throws:

DeclarativeConfigException - if an unexpected type is encountered accessing the property

httpSeverResponseCapturedHeaders

@Nullable
public static List<String> httpSeverResponseCapturedHeaders(ConfigProvider configProvider)

Return .instrumentation.general.http.server.response_captured_headers, or null if none is configured.

Throws:

DeclarativeConfigException - if an unexpected type is encountered accessing the property

javaInstrumentationConfig

@Nullable
public static DeclarativeConfigProperties javaInstrumentationConfig(ConfigProvider configProvider,
 String instrumentationName)

Return .instrumentation.java.<instrumentationName>, or null if none is configured.

Throws:

DeclarativeConfigException - if an unexpected type is encountered accessing the property

getOrNull

@Nullable
public static <T> T getOrNull(ConfigProvider configProvider,
 Function<DeclarativeConfigProperties,T> accessor,
 String... segments)

Walk down the segments of ConfigProvider.getInstrumentationConfig() and call accessor on the terminal node. Returns null if ConfigProvider.getInstrumentationConfig() is null, or if null is encountered walking the segments, or if accessor returns null.

See other methods in InstrumentationConfigUtil for usage examples.