Package io.opentelemetry.instrumentation.api.instrumenter.http

Interface HttpServerAttributesGetter<REQUEST,RESPONSE>

All Superinterfaces:

HttpCommonAttributesGetter<REQUEST,RESPONSE>

public interface HttpServerAttributesGetter<REQUEST,RESPONSE>
extends HttpCommonAttributesGetter<REQUEST,RESPONSE>

An interface for getting HTTP server attributes.

Instrumentation authors will create implementations of this interface for their specific library/framework. It will be used by the HttpServerAttributesExtractor to obtain the various HTTP server attributes in a type-generic way.

Method Summary

Modifier and Type	Method	Description
String	flavor(REQUEST request)
String	route(REQUEST request)
String	scheme(REQUEST request)
default String	serverName(REQUEST request)	Deprecated. This method is deprecated and will be removed in the next release.
String	target(REQUEST request)

Methods inherited from interface io.opentelemetry.instrumentation.api.instrumenter.http.HttpCommonAttributesGetter

method, requestHeader, responseHeader, statusCode

Method Details

flavor

@Nullable
String flavor(REQUEST request)

target

@Nullable
String target(REQUEST request)

route

@Nullable
String route(REQUEST request)

scheme

@Nullable
String scheme(REQUEST request)

serverName

@Nullable
@Deprecated
default String serverName(REQUEST request)

Deprecated.

This method is deprecated and will be removed in the next release.

The primary server name of the matched virtual host. This should be obtained via configuration, not from the Host header. If no such configuration can be obtained, this method should return null.