A B C D E F G H I K M N O P R S T U V W

A

abandon() - Method in interface org.springframework.cloud.sleuth.Span

Ends the span.

alwaysSample() - Static method in interface org.springframework.cloud.sleuth.SamplerFunction

Always sampling SamplerFunction.

B

BaggageInScope - Interface in org.springframework.cloud.sleuth

Inspired by OpenZipkin Brave's BaggageField.

BaggageManager - Interface in org.springframework.cloud.sleuth

Manages BaggageInScope entries.

C

close() - Method in interface org.springframework.cloud.sleuth.BaggageInScope

close() - Method in interface org.springframework.cloud.sleuth.CurrentTraceContext.Scope

close() - Method in interface org.springframework.cloud.sleuth.Tracer.SpanInScope

context() - Method in interface org.springframework.cloud.sleuth.CurrentTraceContext

context() - Method in interface org.springframework.cloud.sleuth.ScopedSpan

context() - Method in interface org.springframework.cloud.sleuth.Span

ContinueSpan - Annotation Type in org.springframework.cloud.sleuth.annotation

Tells Sleuth that all Sleuth related annotations should be applied to an existing span instead of creating a new one.

createBaggage(String) - Method in interface org.springframework.cloud.sleuth.BaggageManager

Creates a new BaggageInScope entry for the given name or returns an existing one if it's already present.

createBaggage(String, String) - Method in interface org.springframework.cloud.sleuth.BaggageManager

Creates a new BaggageInScope entry for the given name or returns an existing one if it's already present.

currentSpan() - Method in interface org.springframework.cloud.sleuth.Tracer

Retrieves the current span in scope or null if one is not available.

currentSpanCustomizer() - Method in interface org.springframework.cloud.sleuth.Tracer

Allows to customize the current span in scope.

CurrentTraceContext - Interface in org.springframework.cloud.sleuth

This API was heavily influenced by Brave.

CurrentTraceContext.Scope - Interface in org.springframework.cloud.sleuth

Scope of a span.

D

deferDecision() - Static method in interface org.springframework.cloud.sleuth.SamplerFunction

Always deferring SamplerFunction.

E

end() - Method in interface org.springframework.cloud.sleuth.ScopedSpan

Ends the span.

end() - Method in interface org.springframework.cloud.sleuth.Span

Ends the span.

error() - Method in interface org.springframework.cloud.sleuth.http.HttpClientResponse

error() - Method in interface org.springframework.cloud.sleuth.http.HttpServerResponse

error() - Method in interface org.springframework.cloud.sleuth.http.Response

error(Throwable) - Method in interface org.springframework.cloud.sleuth.ScopedSpan

Records an exception for this span.

error(Throwable) - Method in interface org.springframework.cloud.sleuth.Span.Builder

Sets an error on the span.

error(Throwable) - Method in interface org.springframework.cloud.sleuth.Span

Records an exception for this span.

event(String) - Method in interface org.springframework.cloud.sleuth.ScopedSpan

Sets an event on this span.

event(String) - Method in interface org.springframework.cloud.sleuth.Span.Builder

Sets an event on the span.

event(String) - Method in interface org.springframework.cloud.sleuth.Span

Sets an event on this span.

event(String) - Method in interface org.springframework.cloud.sleuth.SpanCustomizer

Sets an event on a span.

extract(C, Propagator.Getter<C>) - Method in interface org.springframework.cloud.sleuth.propagation.Propagator

Extracts the value from upstream.

F

fields() - Method in interface org.springframework.cloud.sleuth.propagation.Propagator

FinishedSpan - Interface in org.springframework.cloud.sleuth.exporter

This API is inspired by OpenZipkin Brave (from {code MutableSpan}).

G

get() - Method in interface org.springframework.cloud.sleuth.BaggageInScope

get(TraceContext) - Method in interface org.springframework.cloud.sleuth.BaggageInScope

Retrieves baggage from the given TraceContext.

get(C, String) - Method in interface org.springframework.cloud.sleuth.propagation.Propagator.Getter

Returns the first value of the given propagation key or returns null.

getAllBaggage() - Method in interface org.springframework.cloud.sleuth.BaggageManager

getAttribute(String) - Method in interface org.springframework.cloud.sleuth.http.HttpServerRequest

getBaggage(String) - Method in interface org.springframework.cloud.sleuth.BaggageManager

Retrieves BaggageInScope for the given name.

getBaggage(TraceContext, String) - Method in interface org.springframework.cloud.sleuth.BaggageManager

Retrieves BaggageInScope for the given name.

getEndTimestamp() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getError() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getEvents() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getKind() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getLocalIp() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getName() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getParentId() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getRemoteIp() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getRemotePort() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getRemoteServiceName() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getSpanId() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getStartTimestamp() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getTags() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

getTraceId() - Method in interface org.springframework.cloud.sleuth.exporter.FinishedSpan

H

handleReceive(HttpClientResponse, Span) - Method in interface org.springframework.cloud.sleuth.http.HttpClientHandler

Finishes the client span after assigning it tags according to the response or error.

handleReceive(HttpServerRequest) - Method in interface org.springframework.cloud.sleuth.http.HttpServerHandler

Conditionally joins a span, or starts a new trace, depending on if a trace context was extracted from the request.

handleSend(HttpClientRequest) - Method in interface org.springframework.cloud.sleuth.http.HttpClientHandler

Starts the client span after assigning it a name and tags.

handleSend(HttpClientRequest, TraceContext) - Method in interface org.springframework.cloud.sleuth.http.HttpClientHandler

Same as HttpClientHandler.handleSend(HttpClientRequest) but with an explicit parent TraceContext.

handleSend(HttpServerResponse, Span) - Method in interface org.springframework.cloud.sleuth.http.HttpServerHandler

Finishes the server span after assigning it tags according to the response or error.

header(String, String) - Method in interface org.springframework.cloud.sleuth.http.HttpClientRequest

header(String) - Method in interface org.springframework.cloud.sleuth.http.HttpRequest

header(String) - Method in interface org.springframework.cloud.sleuth.http.HttpResponse

headerNames() - Method in interface org.springframework.cloud.sleuth.http.Request

headerNames() - Method in interface org.springframework.cloud.sleuth.http.Response

HttpClientHandler - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

HttpClientRequest - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

HttpClientResponse - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

HttpRequest - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

HttpRequestParser - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

HttpResponse - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

HttpResponseParser - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

HttpServerHandler - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

HttpServerRequest - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

HttpServerResponse - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

I

inject(TraceContext, C, Propagator.Setter<C>) - Method in interface org.springframework.cloud.sleuth.propagation.Propagator

Injects the value downstream, for example as HTTP headers.

isExportable(FinishedSpan) - Method in interface org.springframework.cloud.sleuth.exporter.SpanFilter

Called to export sampled Spans.

isExportable(FinishedSpan) - Method in class org.springframework.cloud.sleuth.exporter.SpanIgnoringSpanFilter

isNoop() - Method in interface org.springframework.cloud.sleuth.ScopedSpan

isNoop() - Method in interface org.springframework.cloud.sleuth.Span

K

kind(Span.Kind) - Method in interface org.springframework.cloud.sleuth.Span.Builder

Sets the kind on the span.

M

makeCurrent() - Method in interface org.springframework.cloud.sleuth.BaggageInScope

Sets the current baggage in scope.

maybeScope(TraceContext) - Method in interface org.springframework.cloud.sleuth.CurrentTraceContext

Like CurrentTraceContext.newScope(TraceContext), except returns a noop scope if the given context is already in scope.

method() - Method in interface org.springframework.cloud.sleuth.http.HttpRequest

method() - Method in interface org.springframework.cloud.sleuth.http.HttpResponse

N

name() - Method in interface org.springframework.cloud.sleuth.BaggageInScope

name(String) - Method in interface org.springframework.cloud.sleuth.ScopedSpan

Sets a name on this span.

name(String) - Method in interface org.springframework.cloud.sleuth.Span.Builder

Sets the name of the span.

name(String) - Method in interface org.springframework.cloud.sleuth.Span

Sets a name on this span.

name(String) - Method in interface org.springframework.cloud.sleuth.SpanCustomizer

Sets a name on a span.

name(Object, String) - Method in interface org.springframework.cloud.sleuth.SpanNamer

Retrieves the span name for the given object.

neverSample() - Static method in interface org.springframework.cloud.sleuth.SamplerFunction

Never sampling SamplerFunction.

newScope(TraceContext) - Method in interface org.springframework.cloud.sleuth.CurrentTraceContext

Sets the current span in scope until the returned object is closed.

NewSpan - Annotation Type in org.springframework.cloud.sleuth.annotation

Allows to create a new span around a public method.

NewSpanParser - Interface in org.springframework.cloud.sleuth.annotation

Parses data for a span created via a NewSpan annotation.

nextSpan() - Method in interface org.springframework.cloud.sleuth.Tracer

This creates a new span based on the current span in scope.

nextSpan(Span) - Method in interface org.springframework.cloud.sleuth.Tracer

This creates a new span whose parent is Span.

NoOpTagValueResolver - Class in org.springframework.cloud.sleuth.annotation

Does nothing.

NoOpTagValueResolver() - Constructor for class org.springframework.cloud.sleuth.annotation.NoOpTagValueResolver

O

org.springframework.cloud.sleuth - package org.springframework.cloud.sleuth

org.springframework.cloud.sleuth.annotation - package org.springframework.cloud.sleuth.annotation

org.springframework.cloud.sleuth.autoconfig - package org.springframework.cloud.sleuth.autoconfig

org.springframework.cloud.sleuth.exporter - package org.springframework.cloud.sleuth.exporter

org.springframework.cloud.sleuth.http - package org.springframework.cloud.sleuth.http

org.springframework.cloud.sleuth.propagation - package org.springframework.cloud.sleuth.propagation

P

parentId() - Method in interface org.springframework.cloud.sleuth.TraceContext

Parent span id.

parse(MethodInvocation, NewSpan, Span) - Method in interface org.springframework.cloud.sleuth.annotation.NewSpanParser

Override to control the name and tags on an annotation-based span.

parse(HttpRequest, TraceContext, SpanCustomizer) - Method in interface org.springframework.cloud.sleuth.http.HttpRequestParser

Implement to choose what data from the http request are parsed into the span representing it.

parse(HttpResponse, TraceContext, SpanCustomizer) - Method in interface org.springframework.cloud.sleuth.http.HttpResponseParser

Implement to choose what data from the http response are parsed into the span representing it.

path() - Method in interface org.springframework.cloud.sleuth.http.HttpRequest

process(MethodInvocation, NewSpan, ContinueSpan) - Method in interface org.springframework.cloud.sleuth.annotation.SleuthMethodInvocationProcessor

Executes a given Sleuth annotated method.

Propagator - Interface in org.springframework.cloud.sleuth.propagation

Inspired by OpenZipkin Brave and OpenTelemetry.

Propagator.Getter<C> - Interface in org.springframework.cloud.sleuth.propagation

Interface that allows a TextMapPropagator to read propagated fields from a carrier.

Propagator.Setter<C> - Interface in org.springframework.cloud.sleuth.propagation

Class that allows a TextMapPropagator to set propagated fields into a carrier.

R

remoteIp() - Method in interface org.springframework.cloud.sleuth.http.HttpRequest

remotePort() - Method in interface org.springframework.cloud.sleuth.http.HttpRequest

remoteServiceName(String) - Method in interface org.springframework.cloud.sleuth.Span.Builder

Sets the remote service name for the span.

remoteServiceName(String) - Method in interface org.springframework.cloud.sleuth.Span

Sets the remote service name for the span.

request() - Method in interface org.springframework.cloud.sleuth.http.HttpClientResponse

request() - Method in interface org.springframework.cloud.sleuth.http.HttpResponse

request() - Method in interface org.springframework.cloud.sleuth.http.HttpServerResponse

Request - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

request() - Method in interface org.springframework.cloud.sleuth.http.Response

resolve(Object) - Method in class org.springframework.cloud.sleuth.annotation.NoOpTagValueResolver

resolve(String, Object) - Method in interface org.springframework.cloud.sleuth.annotation.TagValueExpressionResolver

Returns the tag value for the given parameter and the provided expression.

resolve(Object) - Method in interface org.springframework.cloud.sleuth.annotation.TagValueResolver

Returns the tag value for the given parameter.

Response - Interface in org.springframework.cloud.sleuth.http

This API is taken from OpenZipkin Brave.

route() - Method in interface org.springframework.cloud.sleuth.http.HttpRequest

Returns an expression such as "/items/:itemId" representing an application endpoint, conventionally associated with the tag key "http.route".

route() - Method in interface org.springframework.cloud.sleuth.http.HttpResponse

Returns an expression such as "/items/:itemId" representing an application endpoint, conventionally associated with the tag key "http.route".

S

sampled() - Method in interface org.springframework.cloud.sleuth.TraceContext

SamplerFunction<T> - Interface in org.springframework.cloud.sleuth

This API was heavily influenced by Brave.

SamplerFunction.Constants - Enum in org.springframework.cloud.sleuth

Constant SamplerFunctions.

ScopedSpan - Interface in org.springframework.cloud.sleuth

Represents the "current span" until ScopedSpan.end() ()} is called.

set(String) - Method in interface org.springframework.cloud.sleuth.BaggageInScope

Sets the baggage value.

set(TraceContext, String) - Method in interface org.springframework.cloud.sleuth.BaggageInScope

Sets the baggage value for the given TraceContext.

set(C, String, String) - Method in interface org.springframework.cloud.sleuth.propagation.Propagator.Setter

Replaces a propagated field with the given value.

setAttribute(String, Object) - Method in interface org.springframework.cloud.sleuth.http.HttpServerRequest

setNoParent() - Method in interface org.springframework.cloud.sleuth.Span.Builder

Sets no parent of the built span.

setParent(TraceContext) - Method in interface org.springframework.cloud.sleuth.Span.Builder

Sets the parent of the built span.

SingleSkipPattern - Interface in org.springframework.cloud.sleuth.autoconfig

Provides a URL Pattern for spans that should be not sampled.

skipPattern() - Method in interface org.springframework.cloud.sleuth.autoconfig.SingleSkipPattern

SleuthMethodInvocationProcessor - Interface in org.springframework.cloud.sleuth.annotation

Contract for processing Sleuth annotations.

Span - Interface in org.springframework.cloud.sleuth

This API was heavily influenced by Brave.

Span.Builder - Interface in org.springframework.cloud.sleuth

In some cases (e.g.

Span.Kind - Enum in org.springframework.cloud.sleuth

Type of span.

spanBuilder() - Method in interface org.springframework.cloud.sleuth.Tracer

In some cases (e.g.

SpanCustomizer - Interface in org.springframework.cloud.sleuth

Allows to customize the current span in scope.

SpanFilter - Interface in org.springframework.cloud.sleuth.exporter

An interface that allows to filter whether a given reported span should be exported or not.

spanId() - Method in interface org.springframework.cloud.sleuth.TraceContext

Span id.

SpanIgnoringSpanFilter - Class in org.springframework.cloud.sleuth.exporter

SpanFilter that ignores spans via names.

SpanIgnoringSpanFilter(List<String>, List<String>) - Constructor for class org.springframework.cloud.sleuth.exporter.SpanIgnoringSpanFilter

spanKind() - Method in interface org.springframework.cloud.sleuth.http.HttpClientRequest

spanKind() - Method in interface org.springframework.cloud.sleuth.http.HttpClientResponse

spanKind() - Method in interface org.springframework.cloud.sleuth.http.HttpServerRequest

spanKind() - Method in interface org.springframework.cloud.sleuth.http.HttpServerResponse

spanKind() - Method in interface org.springframework.cloud.sleuth.http.Request

spanKind() - Method in interface org.springframework.cloud.sleuth.http.Response

SpanName - Annotation Type in org.springframework.cloud.sleuth

Annotation to provide the name for the span.

SpanNamer - Interface in org.springframework.cloud.sleuth

Describes how for a given object a span should be named.

SpanTag - Annotation Type in org.springframework.cloud.sleuth.annotation

There are 3 different ways to add tags to a span.

start() - Method in interface org.springframework.cloud.sleuth.Span.Builder

Builds and starts the span.

start() - Method in interface org.springframework.cloud.sleuth.Span

Starts this span.

startScopedSpan(String) - Method in interface org.springframework.cloud.sleuth.Tracer

Returns a new child span if there's a Tracer.currentSpan() or a new trace if there isn't.

statusCode() - Method in interface org.springframework.cloud.sleuth.http.HttpResponse

T

tag(String, String) - Method in interface org.springframework.cloud.sleuth.ScopedSpan

Sets a tag on this span.

tag(String, String) - Method in interface org.springframework.cloud.sleuth.Span.Builder

Sets a tag on the span.

tag(String, String) - Method in interface org.springframework.cloud.sleuth.Span

Sets a tag on this span.

tag(String, String) - Method in interface org.springframework.cloud.sleuth.SpanCustomizer

Sets a tag on a span.

TagValueExpressionResolver - Interface in org.springframework.cloud.sleuth.annotation

Resolves the tag value for the given parameter and the provided expression.

TagValueResolver - Interface in org.springframework.cloud.sleuth.annotation

Resolves the tag value for the given parameter.

TraceContext - Interface in org.springframework.cloud.sleuth

Contains trace and span data.

traceId() - Method in interface org.springframework.cloud.sleuth.TraceContext

Trace id.

Tracer - Interface in org.springframework.cloud.sleuth

This API was heavily influenced by Brave.

Tracer.SpanInScope - Interface in org.springframework.cloud.sleuth

Scope of a span.

trySample(T) - Method in interface org.springframework.cloud.sleuth.SamplerFunction

Returns an overriding sampling decision for a new trace.

U

unwrap() - Method in interface org.springframework.cloud.sleuth.http.Request

unwrap() - Method in interface org.springframework.cloud.sleuth.http.Response

url() - Method in interface org.springframework.cloud.sleuth.http.HttpRequest

V

valueOf(String) - Static method in enum org.springframework.cloud.sleuth.SamplerFunction.Constants

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.springframework.cloud.sleuth.Span.Kind

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.springframework.cloud.sleuth.SamplerFunction.Constants

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.springframework.cloud.sleuth.Span.Kind

Returns an array containing the constants of this enum type, in the order they are declared.

W

withSpan(Span) - Method in interface org.springframework.cloud.sleuth.Tracer

Makes the given span the "current span" and returns an object that exits that scope on close.

wrap(Callable<C>) - Method in interface org.springframework.cloud.sleuth.CurrentTraceContext

Wraps a task in a trace representation.

wrap(Runnable) - Method in interface org.springframework.cloud.sleuth.CurrentTraceContext

Wraps a task in a trace representation.

wrap(Executor) - Method in interface org.springframework.cloud.sleuth.CurrentTraceContext

Wraps an executor in a trace representation.

wrap(ExecutorService) - Method in interface org.springframework.cloud.sleuth.CurrentTraceContext

Wraps an executor service in a trace representation.

A B C D E F G H I K M N O P R S T U V W