org.springframework.cloud.sleuth.docs

Interface AssertingSpanCustomizer

All Superinterfaces:

SpanCustomizer

public interface AssertingSpanCustomizer
extends SpanCustomizer

A SpanCustomizer that can perform assertions on itself.

Since:

3.1.0

Author:

Marcin Grzejszczak

Method Summary

Modifier and Type	Method and Description
default AssertingSpanCustomizer	event(EventValue value) Sets an event on a span.
default AssertingSpanCustomizer	event(String value) Sets an event on a span.
SpanCustomizer	getDelegate()
DocumentedSpan	getDocumentedSpan()
default AssertingSpanCustomizer	name(String name) Sets a name on a span.
static AssertingSpanCustomizer	of(DocumentedSpan documentedSpan, SpanCustomizer span)
default AssertingSpanCustomizer	tag(String key, String value) Sets a tag on a span.
default AssertingSpanCustomizer	tag(TagKey key, String value) Sets a tag on a span.
static <T extends SpanCustomizer> T	unwrap(SpanCustomizer span) Returns the underlying delegate.

Method Detail

getDocumentedSpan

DocumentedSpan getDocumentedSpan()

Returns:

a DocumentedSpan with span configuration

getDelegate

SpanCustomizer getDelegate()

Returns:

wrapped SpanCustomizer

tag

default AssertingSpanCustomizer tag(String key,
                                    String value)

Description copied from interface: SpanCustomizer

Sets a tag on a span.

Specified by:

tag in interface SpanCustomizer

Parameters:

key - tag key

value - tag value

Returns:

this, for chaining

tag

default AssertingSpanCustomizer tag(TagKey key,
                                    String value)

Sets a tag on a span.

Parameters:

key - tag key

value - tag

Returns:

this, for chaining

event

default AssertingSpanCustomizer event(String value)

Description copied from interface: SpanCustomizer

Sets an event on a span.

Specified by:

event in interface SpanCustomizer

Parameters:

value - event name

Returns:

this, for chaining

event

default AssertingSpanCustomizer event(EventValue value)

Sets an event on a span.

Parameters:

value - event

Returns:

this, for chaining

name

default AssertingSpanCustomizer name(String name)

Description copied from interface: SpanCustomizer

Sets a name on a span.

Specified by:

name in interface SpanCustomizer

Parameters:

name - name to set on a span

Returns:

this, for chaining

of

static AssertingSpanCustomizer of(DocumentedSpan documentedSpan,
                                  SpanCustomizer span)

Parameters:

documentedSpan - span configuration

span - span to wrap in assertions

Returns:

asserting span customizer

unwrap

static <T extends SpanCustomizer> T unwrap(SpanCustomizer span)

Returns the underlying delegate. Used when casting is necessary.

Type Parameters:

T - type extending a span

Parameters:

span - span to check for wrapping

Returns:

unwrapped object