org.springframework.cloud.sleuth.docs

Interface AssertingSpanBuilder

All Superinterfaces:

Span.Builder

public interface AssertingSpanBuilder
extends Span.Builder

A Span.Builder that can perform assertions on itself.

Since:

3.1.0

Author:

Marcin Grzejszczak

Method Summary

Modifier and Type	Method and Description
default AssertingSpanBuilder	error(Throwable throwable) Sets an error on the span.
default AssertingSpanBuilder	event(EventValue value) Sets an event on a span.
default AssertingSpanBuilder	event(String value) Sets an event on the span.
Span.Builder	getDelegate()
DocumentedSpan	getDocumentedSpan()
default AssertingSpanBuilder	kind(Span.Kind spanKind) Sets the kind on the span.
default AssertingSpanBuilder	name(String name) Sets the name of the span.
static AssertingSpanBuilder	of(DocumentedSpan documentedSpan, Span.Builder builder)
default Span.Builder	remoteIpAndPort(String ip, int port) Sets the remote URL for the span.
default AssertingSpanBuilder	remoteServiceName(String remoteServiceName) Sets the remote service name for the span.
default AssertingSpanBuilder	setNoParent() Sets no parent of the built span.
default AssertingSpanBuilder	setParent(TraceContext context) Sets the parent of the built span.
default AssertingSpan	start() Builds and starts the span.
default AssertingSpanBuilder	tag(String key, String value) Sets a tag on the span.
default AssertingSpanBuilder	tag(TagKey key, String value) Sets a tag on a span.

Method Detail

getDocumentedSpan

DocumentedSpan getDocumentedSpan()

Returns:

a DocumentedSpan with span configuration

getDelegate

Span.Builder getDelegate()

Returns:

wrapped Span.Builder

tag

default AssertingSpanBuilder tag(String key,
                                 String value)

Description copied from interface: Span.Builder

Sets a tag on the span.

Specified by:

tag in interface Span.Builder

Parameters:

key - tag key

value - tag value

Returns:

this

tag

default AssertingSpanBuilder tag(TagKey key,
                                 String value)

Sets a tag on a span.

Parameters:

key - tag key

value - tag

Returns:

this, for chaining

event

default AssertingSpanBuilder event(String value)

Description copied from interface: Span.Builder

Sets an event on the span.

Specified by:

event in interface Span.Builder

Parameters:

value - event value

Returns:

this

event

default AssertingSpanBuilder event(EventValue value)

Sets an event on a span.

Parameters:

value - event

Returns:

this, for chaining

name

default AssertingSpanBuilder name(String name)

Description copied from interface: Span.Builder

Sets the name of the span.

Specified by:

name in interface Span.Builder

Parameters:

name - span name

Returns:

this

error

default AssertingSpanBuilder error(Throwable throwable)

Description copied from interface: Span.Builder

Sets an error on the span.

Specified by:

error in interface Span.Builder

Parameters:

throwable - error to set

Returns:

this

remoteServiceName

default AssertingSpanBuilder remoteServiceName(String remoteServiceName)

Description copied from interface: Span.Builder

Sets the remote service name for the span.

Specified by:

remoteServiceName in interface Span.Builder

Parameters:

remoteServiceName - remote service name

Returns:

this

remoteIpAndPort

default Span.Builder remoteIpAndPort(String ip,
                                     int port)

Description copied from interface: Span.Builder

Sets the remote URL for the span.

Specified by:

remoteIpAndPort in interface Span.Builder

Parameters:

ip - remote service ip

port - remote service port

Returns:

this

setParent

default AssertingSpanBuilder setParent(TraceContext context)

Description copied from interface: Span.Builder

Sets the parent of the built span.

Specified by:

setParent in interface Span.Builder

Parameters:

context - parent's context

Returns:

this

setNoParent

default AssertingSpanBuilder setNoParent()

Description copied from interface: Span.Builder

Sets no parent of the built span.

Specified by:

setNoParent in interface Span.Builder

Returns:

this

kind

default AssertingSpanBuilder kind(Span.Kind spanKind)

Description copied from interface: Span.Builder

Sets the kind on the span.

Specified by:

kind in interface Span.Builder

Parameters:

spanKind - kind of the span

Returns:

this

start

default AssertingSpan start()

Description copied from interface: Span.Builder

Builds and starts the span.

Specified by:

start in interface Span.Builder

Returns:

started span

of

static AssertingSpanBuilder of(DocumentedSpan documentedSpan,
                               Span.Builder builder)

Parameters:

documentedSpan - span configuration

builder - builder to wrap in assertions

Returns:

asserting span builder