org.springframework.cloud.sleuth

Interface SpanTextMap

All Superinterfaces:

Iterable<Map.Entry<String,String>>

public interface SpanTextMap
extends Iterable<Map.Entry<String,String>>

Adopted from: https://github.com/opentracing/opentracing-java/blob/0.16.0/opentracing-api/src/main/java/io/opentracing/propagation/TextMap.java TextMap is a built-in carrier for SpanInjector and SpanExtractor. TextMap implementations allows Tracers to read and write key:value String pairs from arbitrary underlying sources of data.

Since:

1.2.0

Author:

Marcin Grzejszczak

Method Summary

Modifier and Type	Method and Description
Iterator<Map.Entry<String,String>>	iterator() Gets an iterator over arbitrary key:value pairs from the TextMapReader.
void	put(String key, String value) Puts a key:value pair into the TextMapWriter's backing store.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

Iterator<Map.Entry<String,String>> iterator()

Gets an iterator over arbitrary key:value pairs from the TextMapReader.

Specified by:

iterator in interface Iterable<Map.Entry<String,String>>

Returns:

entries in the TextMap backing store; note that for some Formats, the iterator may include entries that were never injected by a Tracer implementation (e.g., unrelated HTTP headers)

put

void put(String key,
         String value)

Puts a key:value pair into the TextMapWriter's backing store.

Parameters:

key - a String, possibly with constraints dictated by the particular Format this TextMap is paired with

value - a String, possibly with constraints dictated by the particular Format this TextMap is paired with