Package io.micrometer.observation.transport

Class SenderContext<C>

java.lang.Object

io.micrometer.observation.Observation.Context

io.micrometer.observation.transport.SenderContext<C>

Type Parameters:

C - type of the carrier object

All Implemented Interfaces:

Observation.ContextView

Direct Known Subclasses:

RequestReplySenderContext

public class SenderContext<C>
extends Observation.Context

Context used when sending data over the wire in a fire and forget fashion.

Since:

1.10.0

Constructor Summary

Constructors

Constructor	Description
SenderContext(Propagator.Setter<C> setter)	Creates a new instance of a Kind.PRODUCER SenderContext.
SenderContext(Propagator.Setter<C> setter, Kind kind)	Creates a new instance of SenderContext.

Method Summary

Modifier and Type	Method	Description
@Nullable C	getCarrier()
Kind	getKind()
@Nullable String	getRemoteServiceAddress()	Return optional address for the service that will be called.
@Nullable String	getRemoteServiceName()	Return optional name for the service that will be called.
Propagator.Setter<C>	getSetter()
void	setCarrier(C carrier)
void	setRemoteServiceAddress(@Nullable String remoteServiceAddress)	Set optional service address for the service that will be called.
void	setRemoteServiceName(@Nullable String remoteServiceName)	Set optional name for the service that will be called.

Methods inherited from class io.micrometer.observation.Observation.Context

addHighCardinalityKeyValue, addHighCardinalityKeyValues, addLowCardinalityKeyValue, addLowCardinalityKeyValues, clear, computeIfAbsent, containsKey, get, getAllKeyValues, getContextualName, getError, getHighCardinalityKeyValue, getHighCardinalityKeyValues, getLowCardinalityKeyValue, getLowCardinalityKeyValues, getName, getOrDefault, getParentObservation, getRequired, put, remove, removeHighCardinalityKeyValue, removeHighCardinalityKeyValues, removeLowCardinalityKeyValue, removeLowCardinalityKeyValues, setContextualName, setError, setName, setParentObservation, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.micrometer.observation.Observation.ContextView

getOrDefault

Constructor Details

SenderContext

public SenderContext(Propagator.Setter<C> setter,
 Kind kind)

Creates a new instance of SenderContext.

Parameters:

setter - propagator setter

kind - kind

SenderContext

public SenderContext(Propagator.Setter<C> setter)

Creates a new instance of a Kind.PRODUCER SenderContext.

Parameters:

setter - propagator setter

Method Details

getCarrier

public @Nullable C getCarrier()

setCarrier

public void setCarrier(C carrier)

getSetter

public Propagator.Setter<C> getSetter()

getKind

public Kind getKind()

getRemoteServiceName

public @Nullable String getRemoteServiceName()

Return optional name for the service that will be called.

Returns:

optional name for the service that will be called

setRemoteServiceName

public void setRemoteServiceName(@Nullable String remoteServiceName)

Set optional name for the service that will be called.

Parameters:

remoteServiceName - name of the service that will be called

getRemoteServiceAddress

public @Nullable String getRemoteServiceAddress()

Return optional address for the service that will be called.

Returns:

optional address for the service that will be called

setRemoteServiceAddress

public void setRemoteServiceAddress(@Nullable String remoteServiceAddress)

Set optional service address for the service that will be called.

Parameters:

remoteServiceAddress - service address for the service that will be called