Package brave.http

Class HttpTags

java.lang.Object

brave.http.HttpTags

public final class HttpTags
extends Object

Standard tags used in request and response parsers.

Since:

5.11

See Also:

HttpRequestParser, HttpResponseParser

Field Summary

Fields

Modifier and Type	Field	Description
static Tag<HttpRequest>	METHOD	This tags "http.method" as the value of HttpRequest.method(), such as "GET" or "POST".
static Tag<HttpRequest>	PATH	This tags "http.path" as the value of HttpRequest.path().
static Tag<HttpRequest>	ROUTE	This tags "http.route" as the value of HttpRequest.route().
static Tag<HttpResponse>	STATUS_CODE	This tags "http.status_code" as the value of HttpResponse.statusCode(), when a valid status code (100 - 599).
static Tag<HttpRequest>	URL	This tags "http.url" as the value of HttpRequest.url().

Method Summary

Modifier and Type	Method	Description
static Tag<HttpRequest>	requestHeader(String headerName)	Creates a tag for the given HTTP request header.
static Tag<HttpRequest>	requestHeader(String key, String headerName)	Like requestHeader(String), except controls the tag key used.

Methods inherited from class java.lang.Object

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

Field Detail

METHOD

public static final Tag<HttpRequest> METHOD

This tags "http.method" as the value of HttpRequest.method(), such as "GET" or "POST".

Since:

5.11

See Also:

HttpRequest.method(), HttpRequestParser.parse(HttpRequest, TraceContext, SpanCustomizer), HttpResponse.request()

PATH

public static final Tag<HttpRequest> PATH

This tags "http.path" as the value of HttpRequest.path(). Ex. "/objects/abcd-ff"

Since:

5.11

See Also:

HttpRequest.path(), ROUTE, HttpRequestParser.parse(HttpRequest, TraceContext, SpanCustomizer), HttpResponse.request()

ROUTE

public static final Tag<HttpRequest> ROUTE

This tags "http.route" as the value of HttpRequest.route(). Ex "/users/{userId}" or "" (empty string) if routing is supported, but there was no match.

Since:

5.11

See Also:

HttpRequest.route(), PATH, HttpRequestParser.parse(HttpRequest, TraceContext, SpanCustomizer), HttpResponse.request()

URL

public static final Tag<HttpRequest> URL

This tags "http.url" as the value of HttpRequest.url(). Unlike PATH, this includes the scheme, host and query parameters.

Ex. "https://mybucket.s3.amazonaws.com/objects/abcd-ff?X-Amz-Algorithm=AWS4-HMAC-SHA256..."

Combined with METHOD, you can understand the fully-qualified request line.

Caution:This may include private data or be of considerable length.

Since:

5.11

See Also:

HttpRequest.url(), PATH, HttpRequestParser.parse(HttpRequest, TraceContext, SpanCustomizer), HttpResponse.request()

STATUS_CODE

public static final Tag<HttpResponse> STATUS_CODE

This tags "http.status_code" as the value of HttpResponse.statusCode(), when a valid status code (100 - 599).

Since:

5.11

See Also:

HttpResponse.statusCode(), HttpResponseParser.parse(HttpResponse, TraceContext, SpanCustomizer)

Method Detail

requestHeader

public static Tag<HttpRequest> requestHeader(String headerName)

Creates a tag for the given HTTP request header.

Ex.

 USER_AGENT = HttpTags.requestHeader("User-Agent");
 

Since:

5.11

See Also:

HttpRequest.header(String), HttpResponse.request()

requestHeader

public static Tag<HttpRequest> requestHeader(String key,
                                             String headerName)

Like requestHeader(String), except controls the tag key used.

Ex.

 USER_AGENT = HttpTags.requestHeader("http.user_agent", "User-Agent");
 

Since:

5.11

See Also:

HttpRequest.header(String), HttpResponse.request()