Package io.opentelemetry.instrumentation.api.instrumenter.url

Interface UrlAttributesGetter<REQUEST>

All Known Subinterfaces:

HttpServerAttributesGetter<REQUEST,RESPONSE>

public interface UrlAttributesGetter<REQUEST>

An interface for getting URL attributes.

Instrumentation authors will create implementations of this interface for their specific library/framework. It will be used by the UrlAttributesExtractor (or other convention specific extractors) to obtain the various URL attributes in a type-generic way.

Method Summary

Modifier and Type	Method	Description
default String	getUrlPath(REQUEST request)	Returns the URI path component.
default String	getUrlQuery(REQUEST request)	Returns the URI query component.
default String	getUrlScheme(REQUEST request)	Returns the URI scheme component identifying the used protocol.

Method Details

getUrlScheme

@Nullable
default String getUrlScheme(REQUEST request)

Returns the URI scheme component identifying the used protocol.

Examples: https, ftp, telnet

getUrlPath

@Nullable
default String getUrlPath(REQUEST request)

Returns the URI path component.

Examples: /search

getUrlQuery

@Nullable
default String getUrlQuery(REQUEST request)

Returns the URI query component.

Examples: q=OpenTelemetry