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

Class CapturedHttpHeaders

java.lang.Object

io.opentelemetry.instrumentation.api.instrumenter.http.CapturedHttpHeaders

@Deprecated
public abstract class CapturedHttpHeaders
extends Object

Deprecated.

This class should no longer be used directly. Use the HttpClientAttributesExtractorBuilder.setCapturedRequestHeaders(List), HttpClientAttributesExtractorBuilder.setCapturedResponseHeaders(List), HttpServerAttributesExtractorBuilder.setCapturedRequestHeaders(List) and HttpServerAttributesExtractorBuilder.setCapturedResponseHeaders(List) methods instead.

Represents the configuration that specifies which HTTP request and response headers should be captured as span attributes as described in HTTP semantic conventions.

The HTTP request header values will be captured under the http.request.header.<name> attribute key. The HTTP response header values will be captured under the http.response.header.<name> attribute key. The <name> part in the attribute key is the normalized header name: lowercase, with dashes replaced by underscores.

Method Summary

Modifier and Type	Method	Description
static CapturedHttpHeaders	client(Config config)	Deprecated. Returns a configuration that captures HTTP client request and response headers as configured in the received config.
static CapturedHttpHeaders	create(List<String> capturedRequestHeaders, List<String> capturedResponseHeaders)	Deprecated. Returns a configuration that captures chosen HTTP request and response headers.
static CapturedHttpHeaders	empty()	Deprecated. Returns a configuration that does not capture any HTTP headers as span attributes.
abstract List<String>	requestHeaders()	Deprecated. Returns the list of HTTP request header names that are to be captured as span attributes.
abstract List<String>	responseHeaders()	Deprecated. Returns the list of HTTP response header names that are to be captured as span attributes.
static CapturedHttpHeaders	server(Config config)	Deprecated. Returns a configuration that captures HTTP server request and response headers as configured in the received config.

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static CapturedHttpHeaders empty()

Deprecated.

Returns a configuration that does not capture any HTTP headers as span attributes.

client

public static CapturedHttpHeaders client(Config config)

Deprecated.

Returns a configuration that captures HTTP client request and response headers as configured in the received config.

server

public static CapturedHttpHeaders server(Config config)

Deprecated.

Returns a configuration that captures HTTP server request and response headers as configured in the received config.

create

public static CapturedHttpHeaders create(List<String> capturedRequestHeaders,
                                         List<String> capturedResponseHeaders)

Deprecated.

Returns a configuration that captures chosen HTTP request and response headers.

Parameters:

capturedRequestHeaders - A list of HTTP request header names that are to be captured as span attributes.

capturedResponseHeaders - A list of HTTP response header names that are to be captured as span attributes.

requestHeaders

public abstract List<String> requestHeaders()

Deprecated.

Returns the list of HTTP request header names that are to be captured as span attributes.

responseHeaders

public abstract List<String> responseHeaders()

Deprecated.

Returns the list of HTTP response header names that are to be captured as span attributes.