Index (Brave Instrumentation: Http Adapters 5.12.7 API)

A B C D E F H M N P R S T U
All Classes|All Packages

A

addRule(String, String, float) - Method in class brave.http.HttpRuleSampler.Builder: Deprecated.
Since 5.8, use HttpRuleSampler.Builder.putRule(Matcher, Sampler)

B

brave.http - package brave.http
build() - Method in class brave.http.HttpRuleSampler.Builder
build() - Method in class brave.http.HttpTracing.Builder

C

clientOf(String) - Method in class brave.http.HttpTracing: Scopes this component for a client of the indicated server.
clientParser() - Method in class brave.http.HttpTracing: Deprecated.
Since 5.10, use HttpTracing.clientRequestParser() and HttpTracing.clientResponseParser()
clientParser(HttpClientParser) - Method in class brave.http.HttpTracing.Builder: Deprecated.
Since 5.10, use HttpTracing.Builder.clientRequestParser(HttpRequestParser) and HttpTracing.Builder.clientResponseParser(HttpResponseParser)
clientRequestParser() - Method in class brave.http.HttpTracing: Used by HttpClientHandler.handleSend(HttpClientRequest) to add a span name and tags about the request before it is sent to the server.
clientRequestParser(HttpRequestParser) - Method in class brave.http.HttpTracing.Builder: Overrides the tagging policy for HTTP client requests.
clientRequestSampler() - Method in class brave.http.HttpTracing: Returns an overriding sampling decision for a new trace.
clientResponseParser() - Method in class brave.http.HttpTracing: Used by HttpClientHandler.handleReceive(HttpClientResponse, Span) to add tags about the response received from the server.
clientResponseParser(HttpResponseParser) - Method in class brave.http.HttpTracing.Builder: Overrides the tagging policy for HTTP client responses.
clientSampler() - Method in class brave.http.HttpTracing: Deprecated.
Since 5.8, use HttpTracing.clientRequestSampler()
clientSampler(HttpSampler) - Method in class brave.http.HttpTracing.Builder: Deprecated.
Since 5.8, use HttpTracing.Builder.clientSampler(SamplerFunction)
clientSampler(SamplerFunction<HttpRequest>) - Method in class brave.http.HttpTracing.Builder
close() - Method in class brave.http.HttpTracing
create(HttpTracing) - Static method in class brave.http.HttpClientHandler
create(HttpTracing) - Static method in class brave.http.HttpServerHandler
create(HttpTracing, HttpClientAdapter<Req, Resp>) - Static method in class brave.http.HttpClientHandler: Deprecated.
Since 5.7, use HttpClientHandler.create(HttpTracing) as it is more portable.
create(HttpTracing, HttpServerAdapter<Req, Resp>) - Static method in class brave.http.HttpServerHandler: Deprecated.
Since 5.7, use HttpServerHandler.create(HttpTracing) as it is more portable.
create(Tracing) - Static method in class brave.http.HttpTracing
current() - Static method in class brave.http.HttpTracing: Returns the most recently created tracing component iff it hasn't been closed.
customize(HttpTracing.Builder) - Method in interface brave.http.HttpTracingCustomizer

D

Default() - Constructor for class brave.http.HttpRequestParser.Default
Default() - Constructor for class brave.http.HttpResponseParser.Default
DEFAULT - Static variable in interface brave.http.HttpRequestParser
DEFAULT - Static variable in interface brave.http.HttpResponseParser

E

error() - Method in class brave.http.HttpClientResponse
error() - Method in class brave.http.HttpServerResponse
error(int, Throwable, SpanCustomizer) - Method in class brave.http.HttpResponseParser.Default: Override to change what data from the HTTP error are parsed into the span modeling it.
error(Integer, Throwable, SpanCustomizer) - Method in class brave.http.HttpParser: Deprecated.

Override to change what data from the http error are parsed into the span modeling it.
errorParser() - Method in class brave.http.HttpParser: Deprecated.
This is only used in Zipkin reporting. Since 5.12, use ZipkinSpanHandler.Builder.errorTag(Tag)

F

finishTimestamp() - Method in class brave.http.HttpResponse: The timestamp in epoch microseconds of the end of this request or zero to take this implicitly from the current clock.
finishTimestamp(Resp) - Method in class brave.http.HttpAdapter: Deprecated.

H

handleReceive(HttpClientResponse, Span) - Method in class brave.http.HttpClientHandler: Finishes the client span after assigning it tags according to the response or error.
handleReceive(HttpServerRequest) - Method in class brave.http.HttpServerHandler: Conditionally joins a span, or starts a new trace, depending on if a trace context was extracted from the request.
handleReceive(TraceContext.Extractor<C>, C, Req) - Method in class brave.http.HttpServerHandler: Deprecated.
Since 5.7, use HttpServerHandler.handleReceive(HttpServerRequest)
handleReceive(TraceContext.Extractor<Req>, Req) - Method in class brave.http.HttpServerHandler: Deprecated.
Since 5.7, use HttpServerHandler.handleReceive(HttpServerRequest)
handleReceive(Resp, Throwable, Span) - Method in class brave.http.HttpClientHandler: Deprecated.
since 5.12 use HttpClientHandler.handleReceive(HttpClientResponse, Span)
handleSend(HttpClientRequest) - Method in class brave.http.HttpClientHandler: Starts the client span after assigning it a name and tags.
handleSend(HttpClientRequest, Span) - Method in class brave.http.HttpClientHandler: Like HttpClientHandler.handleSend(HttpClientRequest), except explicitly controls the span representing the request.
handleSend(HttpServerResponse, Span) - Method in class brave.http.HttpServerHandler: Finishes the server span after assigning it tags according to the response or error.
handleSend(TraceContext.Injector<C>, C, Req) - Method in class brave.http.HttpClientHandler: Deprecated.
Since 5.7, use HttpClientHandler.handleSend(HttpClientRequest).
handleSend(TraceContext.Injector<C>, C, Req, Span) - Method in class brave.http.HttpClientHandler: Deprecated.
Since 5.7, use HttpClientHandler.handleSend(HttpClientRequest).
handleSend(TraceContext.Injector<Req>, Req) - Method in class brave.http.HttpClientHandler: Deprecated.
Since 5.7, use HttpClientHandler.handleSend(HttpClientRequest), as this allows more advanced samplers to be used.
handleSend(TraceContext.Injector<Req>, Req, Span) - Method in class brave.http.HttpClientHandler: Deprecated.
Since 5.7, use HttpClientHandler.handleSend(HttpClientRequest, Span).
handleSend(Resp, Throwable, Span) - Method in class brave.http.HttpServerHandler: Deprecated.
Since 5.12, use HttpServerHandler.handleSend(HttpServerResponse, Span)
handleSendWithParent(HttpClientRequest, TraceContext) - Method in class brave.http.HttpClientHandler: Like HttpClientHandler.handleSend(HttpClientRequest), except explicitly controls the parent of the client span.
header(String) - Method in class brave.http.HttpRequest: Returns one value corresponding to the specified header, or null.
header(String, String) - Method in class brave.http.HttpClientRequest: Sets a request header with the indicated name.
HttpAdapter<Req,Resp> - Class in brave.http: Deprecated.
Since 5.10, use HttpRequest and HttpResponse
HttpClientAdapter<Req,Resp> - Class in brave.http: Deprecated.
Since 5.10, use HttpClientRequest and HttpClientResponse
HttpClientAdapter() - Constructor for class brave.http.HttpClientAdapter: Deprecated.
HttpClientHandler<Req,Resp> - Class in brave.http: This standardizes a way to instrument http clients, particularly in a way that encourages use of portable customizations via HttpRequestParser and HttpResponseParser.
HttpClientParser - Class in brave.http: Deprecated.
Since 5.10, use HttpRequestParser and HttpResponseParser
HttpClientParser() - Constructor for class brave.http.HttpClientParser: Deprecated.
HttpClientRequest - Class in brave.http: Marks an interface for use in HttpClientHandler.handleSend(HttpClientRequest).
HttpClientRequest() - Constructor for class brave.http.HttpClientRequest
HttpClientResponse - Class in brave.http: Marks an interface for use in HttpClientHandler.handleReceive(HttpClientResponse, Span).
HttpClientResponse() - Constructor for class brave.http.HttpClientResponse
HttpParser - Class in brave.http: Deprecated.
Since 5.10, use HttpRequestParser and HttpResponseParser
HttpParser() - Constructor for class brave.http.HttpParser: Deprecated.
HttpRequest - Class in brave.http: Abstract request type used for parsing and sampling of http clients and servers.
HttpRequestMatchers - Class in brave.http: Null safe matchers for use in HttpRuleSampler.
HttpRequestMatchers() - Constructor for class brave.http.HttpRequestMatchers
HttpRequestParser - Interface in brave.http: Use this to control the request data recorded for an sampled HTTP client or server span.
HttpRequestParser.Default - Class in brave.http: The default data policy sets the span name to the HTTP method and adds the "http.method" and "http.path" tags.
HttpResponse - Class in brave.http: Abstract response type used for parsing and sampling of http clients and servers.
HttpResponseParser - Interface in brave.http: Use this to control the response data recorded for an sampled HTTP client or server span.
HttpResponseParser.Default - Class in brave.http: The default data policy sets the span name to the HTTP route when available, along with the "http.status_code" and "error" tags.
HttpRuleSampler - Class in brave.http: Assigns sample rates to http routes.
HttpRuleSampler.Builder - Class in brave.http
HttpSampler - Class in brave.http: Deprecated.
Since 5.8, use SamplerFunction<HttpRequest>.
HttpSampler() - Constructor for class brave.http.HttpSampler: Deprecated.
HttpServerAdapter<Req,Resp> - Class in brave.http: Deprecated.
Since 5.10, use HttpServerRequest and HttpServerResponse
HttpServerAdapter() - Constructor for class brave.http.HttpServerAdapter: Deprecated.
HttpServerHandler<Req,Resp> - Class in brave.http: This standardizes a way to instrument http servers, particularly in a way that encourages use of portable customizations via HttpRequestParser and HttpResponseParser.
HttpServerParser - Class in brave.http: Deprecated.
Since 5.10, use HttpRequestParser and HttpResponseParser
HttpServerParser() - Constructor for class brave.http.HttpServerParser: Deprecated.
HttpServerRequest - Class in brave.http: Marks an interface for use in HttpServerHandler.handleReceive(HttpServerRequest).
HttpServerRequest() - Constructor for class brave.http.HttpServerRequest
HttpServerResponse - Class in brave.http: Marks an interface for use in HttpServerHandler.handleSend(Object, Throwable, Span).
HttpServerResponse() - Constructor for class brave.http.HttpServerResponse
HttpTags - Class in brave.http: Standard tags used in request and response parsers.
HttpTracing - Class in brave.http: Instances built via HttpTracing.create(Tracing) or HttpTracing.newBuilder(Tracing) are registered automatically such that statically configured instrumentation like HTTP clients can use HttpTracing.current().
HttpTracing.Builder - Class in brave.http
HttpTracingCustomizer - Interface in brave.http: This allows configuration plugins to collaborate on building an instance of HttpTracing.

M

method() - Method in class brave.http.HttpRequest: The HTTP method, or verb, such as "GET" or "POST".
method() - Method in class brave.http.HttpResponse: Returns the HTTP method of the request that caused this response or null if unreadable.
method(Req) - Method in class brave.http.HttpAdapter: Deprecated.
METHOD - Static variable in class brave.http.HttpTags: This tags "http.method" as the value of HttpRequest.method(), such as "GET" or "POST".
methodEquals(String) - Static method in class brave.http.HttpRequestMatchers: Matcher for case-sensitive HTTP methods, such as "GET" and "POST"
methodFromResponse(Resp) - Method in class brave.http.HttpAdapter: Deprecated.

N

NEVER_SAMPLE - Static variable in class brave.http.HttpSampler: Deprecated.

Returns false to never start new traces for http requests.
newBuilder() - Static method in class brave.http.HttpRuleSampler
newBuilder(Tracing) - Static method in class brave.http.HttpTracing
nextSpan(Req) - Method in class brave.http.HttpClientHandler: Deprecated.
since 5.8 use Tracer.nextSpan(SamplerFunction, Object)
NOOP - Static variable in interface brave.http.HttpTracingCustomizer: Use to avoid comparing against null references

P

parse(HttpRequest, TraceContext, SpanCustomizer) - Method in class brave.http.HttpRequestParser.Default: This sets the span name to the HTTP method and adds the "http.method" and "http.path" tags.
parse(HttpRequest, TraceContext, SpanCustomizer) - Method in interface brave.http.HttpRequestParser: Implement to choose what data from the http request are parsed into the span representing it.
parse(HttpResponse, TraceContext, SpanCustomizer) - Method in class brave.http.HttpResponseParser.Default: This tags "http.status_code" when it is not 2xx.
parse(HttpResponse, TraceContext, SpanCustomizer) - Method in interface brave.http.HttpResponseParser: Implement to choose what data from the http response are parsed into the span representing it.
parseClientAddress(Req, Endpoint.Builder) - Method in class brave.http.HttpServerAdapter: Deprecated.
HttpServerAdapter.parseClientIpAndPort(Req, brave.Span) addresses this functionality. This will be removed in Brave v6.
parseClientIpAndPort(Span) - Method in class brave.http.HttpServerRequest: Used by HttpServerHandler.handleReceive(HttpServerRequest) to add remote socket information about the client from the delegate.
parseClientIpAndPort(Req, Span) - Method in class brave.http.HttpServerAdapter: Deprecated.
parseClientIpFromXForwardedFor(Span) - Method in class brave.http.HttpServerRequest: Uses the first value in the "X-Forwarded-For" header, or returns false if not present.
parseClientIpFromXForwardedFor(Req, Span) - Method in class brave.http.HttpServerAdapter: Deprecated.
parseServerIpAndPort(Req, Endpoint.Builder) - Method in class brave.http.HttpClientAdapter: Deprecated.
remote IP information should be added directly by instrumentation. This will be removed in Brave v6.
path() - Method in class brave.http.HttpRequest: The absolute http path, without any query parameters.
path(Req) - Method in class brave.http.HttpAdapter: Deprecated.
PATH - Static variable in class brave.http.HttpTags: This tags "http.path" as the value of HttpRequest.path().
pathStartsWith(String) - Static method in class brave.http.HttpRequestMatchers
putAllRules(HttpRuleSampler) - Method in class brave.http.HttpRuleSampler.Builder: Adds or replaces all rules in this sampler with those of the input.
putRule(Matcher<HttpRequest>, Sampler) - Method in class brave.http.HttpRuleSampler.Builder: Adds or replaces the sampler for the matcher.

R

request() - Method in class brave.http.HttpClientResponse: The request that initiated this HTTP response or null if unknown.
request() - Method in class brave.http.HttpResponse: The request that initiated this HTTP response or null if unknown.
request() - Method in class brave.http.HttpServerResponse: The request that initiated this HTTP response or null if unknown.
request(HttpAdapter<Req, ?>, Req, SpanCustomizer) - Method in class brave.http.HttpClientParser: Deprecated.

Customizes the span based on the request that will be sent to the server.
request(HttpAdapter<Req, ?>, Req, SpanCustomizer) - Method in class brave.http.HttpParser: Deprecated.

Override to change what data from the http request are parsed into the span representing it.
request(HttpAdapter<Req, ?>, Req, SpanCustomizer) - Method in class brave.http.HttpServerParser: Deprecated.

Customizes the span based on the request received from the client.
requestHeader(String) - Static method in class brave.http.HttpTags: Creates a tag for the given HTTP request header.
requestHeader(String, String) - Static method in class brave.http.HttpTags: Like HttpTags.requestHeader(String), except controls the tag key used.
requestHeader(Req, String) - Method in class brave.http.HttpAdapter: Deprecated.
response(HttpAdapter<?, Resp>, Resp, Throwable, SpanCustomizer) - Method in class brave.http.HttpClientParser: Deprecated.

Customizes the span based on the response received from the server.
response(HttpAdapter<?, Resp>, Resp, Throwable, SpanCustomizer) - Method in class brave.http.HttpParser: Deprecated.

Override to change what data from the http response or error are parsed into the span modeling it.
response(HttpAdapter<?, Resp>, Resp, Throwable, SpanCustomizer) - Method in class brave.http.HttpServerParser: Deprecated.

Customizes the span based on the response sent to the client.
route() - Method in class brave.http.HttpRequest: Returns an expression such as "/items/:itemId" representing an application endpoint, conventionally associated with the tag key "http.route".
route() - Method in class brave.http.HttpResponse: Returns the HTTP route of the request that caused this response or null if unreadable.
route(Resp) - Method in class brave.http.HttpAdapter: Deprecated.
ROUTE - Static variable in class brave.http.HttpTags: This tags "http.route" as the value of HttpRequest.route().

S

serverName() - Method in class brave.http.HttpTracing: Used by http clients to indicate the name of the destination service.
serverParser() - Method in class brave.http.HttpTracing: Deprecated.
Since 5.10, use HttpTracing.serverRequestParser() and HttpTracing.serverResponseParser()
serverParser(HttpServerParser) - Method in class brave.http.HttpTracing.Builder: Deprecated.
Since 5.10, use HttpTracing.Builder.serverRequestParser(HttpRequestParser) and HttpTracing.Builder.serverResponseParser(HttpResponseParser)
serverRequestParser() - Method in class brave.http.HttpTracing: Used by HttpServerHandler.handleReceive(HttpServerRequest) to add a span name and tags about the request before the server processes it.
serverRequestParser(HttpRequestParser) - Method in class brave.http.HttpTracing.Builder: Overrides the tagging policy for HTTP server requests.
serverRequestSampler() - Method in class brave.http.HttpTracing: Returns an overriding sampling decision for a new trace.
serverResponseParser() - Method in class brave.http.HttpTracing: Used by HttpServerHandler.handleSend(Object, Throwable, Span) to add tags about the response sent to the client.
serverResponseParser(HttpResponseParser) - Method in class brave.http.HttpTracing.Builder: Overrides the tagging policy for HTTP server responses.
serverSampler() - Method in class brave.http.HttpTracing: Deprecated.
Since 5.8, use HttpTracing.serverRequestSampler()
serverSampler(HttpSampler) - Method in class brave.http.HttpTracing.Builder: Deprecated.
Since 5.8, use HttpTracing.Builder.serverSampler(SamplerFunction)
serverSampler(SamplerFunction<HttpRequest>) - Method in class brave.http.HttpTracing.Builder
spanKind() - Method in class brave.http.HttpClientRequest
spanKind() - Method in class brave.http.HttpClientResponse
spanKind() - Method in class brave.http.HttpServerRequest
spanKind() - Method in class brave.http.HttpServerResponse
spanName(HttpAdapter<Req, ?>, Req) - Method in class brave.http.HttpParser: Deprecated.

Returns the span name of the request or null if the data needed is unavailable.
spanName(HttpRequest, TraceContext) - Method in class brave.http.HttpRequestParser.Default: Returns the span name of the request or null if the data needed is unavailable.
startTimestamp() - Method in class brave.http.HttpRequest: The timestamp in epoch microseconds of the beginning of this request or zero to take this implicitly from the current clock.
startTimestamp(Req) - Method in class brave.http.HttpAdapter: Deprecated.
STATUS_CODE - Static variable in class brave.http.HttpTags: This tags "http.status_code" as the value of HttpResponse.statusCode(), when a valid status code (100 - 599).
statusCode() - Method in class brave.http.HttpResponse: The HTTP status code or zero if unreadable.
statusCode(Resp) - Method in class brave.http.HttpAdapter: Deprecated.
Since 5.7, use HttpAdapter.statusCodeAsInt(Object) which prevents boxing.
statusCodeAsInt(Resp) - Method in class brave.http.HttpAdapter: Deprecated.

T

toBuilder() - Method in class brave.http.HttpTracing
TRACE_ID - Static variable in class brave.http.HttpSampler: Deprecated.

Ignores the request and uses the trace ID instead.
tracing() - Method in class brave.http.HttpTracing
tracing(Tracing) - Method in class brave.http.HttpTracing.Builder
trySample(HttpAdapter<Req, ?>, Req) - Method in class brave.http.HttpRuleSampler: Deprecated.
trySample(HttpAdapter<Req, ?>, Req) - Method in class brave.http.HttpSampler: Deprecated.

Returns an overriding sampling decision for a new trace.
trySample(HttpRequest) - Method in class brave.http.HttpRuleSampler
trySample(HttpRequest) - Method in class brave.http.HttpSampler: Deprecated.

U

url() - Method in class brave.http.HttpRequest: The entire URL, including the scheme, host and query parameters if available or null if unreadable.
url(Req) - Method in class brave.http.HttpAdapter: Deprecated.
URL - Static variable in class brave.http.HttpTags: This tags "http.url" as the value of HttpRequest.url().

A B C D E F H M N P R S T U
All Classes|All Packages