brave.handler.MutableSpan

All Implemented Interfaces:: Cloneable

public final class MutableSpan
extends Object
implements Cloneable

This represents a span except for its TraceContext. It is mutable, for late adjustments.

While in-flight, the data is synchronized where necessary. When exposed to users, it can be mutated without synchronization.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`MutableSpan.AnnotationConsumer<T>`
`static interface`	`MutableSpan.AnnotationUpdater`
`static interface`	`MutableSpan.TagConsumer<T>`
`static interface`	`MutableSpan.TagUpdater`

Constructor Summary

Constructors

Constructor Description

MutableSpan()

Method Summary

Modifier and Type	Method	Description
`void`	`annotate(long timestamp, String value)`
`boolean`	`containsAnnotation(String value)`	Returns true if an annotation with the given value exists in this span.
`Throwable`	`error()`
`void`	`error(Throwable error)`
`long`	`finishTimestamp()`	Returns the `span finish timestamp` or zero
`void`	`finishTimestamp(long finishTimestamp)`
`<T> void`	`forEachAnnotation(MutableSpan.AnnotationConsumer<T> annotationConsumer, T target)`	Allows you to copy all data into a different target, such as a different span model or logs.
`void`	`forEachAnnotation(MutableSpan.AnnotationUpdater annotationUpdater)`	Allows you to update values for redaction purposes
`<T> void`	`forEachTag(MutableSpan.TagConsumer<T> tagConsumer, T target)`
`void`	`forEachTag(MutableSpan.TagUpdater tagUpdater)`	Allows you to update values for redaction purposes
`boolean`	`isEmpty()`	Returns true if there was no data added.
`Span.Kind`	`kind()`	Returns the `span kind` or null
`void`	`kind(Span.Kind kind)`
`String`	`localIp()`	When null `default` will be used for zipkin.
`boolean`	`localIp(String localIp)`
`int`	`localPort()`	When zero `default` will be used for zipkin.
`void`	`localPort(int localPort)`
`String`	`localServiceName()`	When null `default` is used.
`void`	`localServiceName(String localServiceName)`
`String`	`name()`	Returns the `span name` or null
`void`	`name(String name)`
`String`	`remoteIp()`	The text representation of the primary IPv4 or IPv6 address associated with the remote side of this connection.
`boolean`	`remoteIpAndPort(String remoteIp, int remotePort)`
`int`	`remotePort()`	Port of the remote IP's socket or 0, if not known.
`String`	`remoteServiceName()`
`void`	`remoteServiceName(String remoteServiceName)`
`void`	`setShared()`	Indicates we are contributing to a span started by another tracer (ex on a different host).
`boolean`	`shared()`	Returns true if the span ID is `shared` with a remote client.
`long`	`startTimestamp()`	Returns the `span start timestamp` or zero
`void`	`startTimestamp(long startTimestamp)`
`String`	`tag(String key)`	Returns the last value associated with the key or null
`void`	`tag(String key, String value)`

Methods inherited from class java.lang.Object

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

Constructor Details
- MutableSpan
  
  public MutableSpan()
Method Details
- isEmpty
  
  public boolean isEmpty()
  
  Returns true if there was no data added. Usually this indicates an instrumentation bug.
- name
  
  @Nullable public String name()
  
  Returns the span name or null
- name
  
  public void name(String name)
  
  See Also:
  
  Span.name(String)
- startTimestamp
  
  public long startTimestamp()
  
  Returns the span start timestamp or zero
- startTimestamp
  
  public void startTimestamp(long startTimestamp)
  
  See Also:
  
  Span.start(long)
- finishTimestamp
  
  public long finishTimestamp()
  
  Returns the span finish timestamp or zero
- finishTimestamp
  
  public void finishTimestamp(long finishTimestamp)
  
  See Also:
  
  Span.finish(long)
- kind
  
  public Span.Kind kind()
  
  Returns the span kind or null
- kind
  
  public void kind(@Nullable Span.Kind kind)
  
  See Also:
  
  Span.kind(brave.Span.Kind)
- localServiceName
  
  @Nullable public String localServiceName()
  
  When null default is used.
- localServiceName
  
  public void localServiceName(String localServiceName)
  
  See Also:
  
  Tracing.Builder.localServiceName(String)
- localIp
  
  @Nullable public String localIp()
  
  When null default will be used for zipkin.
- localIp
  
  public boolean localIp(@Nullable String localIp)
  
  See Also:
  
  localIp()
- localPort
  
  public int localPort()
  
  When zero default will be used for zipkin.
- localPort
  
  public void localPort(int localPort)
  
  See Also:
  
  localPort()
- remoteServiceName
  
  @Nullable public String remoteServiceName()
  
  See Also:
  
  Span.remoteServiceName(String)
- remoteServiceName
  
  public void remoteServiceName(String remoteServiceName)
  
  See Also:
  
  Span.remoteServiceName(String)
- remoteIp
  
  @Nullable public String remoteIp()
  
  The text representation of the primary IPv4 or IPv6 address associated with the remote side of this connection. Ex. 192.168.99.100 null if unknown.
  
  See Also:
  
  Span.remoteIpAndPort(String, int)
- remotePort
  
  public int remotePort()
  
  Port of the remote IP's socket or 0, if not known.
  
  See Also:
  
  InetSocketAddress.getPort(), Span.remoteIpAndPort(String, int)
- remoteIpAndPort
  
  public boolean remoteIpAndPort(@Nullable String remoteIp, int remotePort)
  
  See Also:
  
  Span.remoteIpAndPort(String, int)
- containsAnnotation
  
  public boolean containsAnnotation(String value)
  
  Returns true if an annotation with the given value exists in this span.
- annotate
  
  public void annotate(long timestamp, String value)
  
  See Also:
  
  Span.annotate(String)
- error
  
  public Throwable error()
  
  See Also:
  
  Span.error(Throwable)
- error
  
  public void error(Throwable error)
  
  See Also:
  
  Span.error(Throwable)
- tag
  
  @Nullable public String tag(String key)
  
  Returns the last value associated with the key or null
- tag
  
  public void tag(String key, String value)
  
  See Also:
  
  Span.tag(String, String)
- forEachTag
  
  public <T> void forEachTag(MutableSpan.TagConsumer<T> tagConsumer, T target)
- forEachTag
  
  public void forEachTag(MutableSpan.TagUpdater tagUpdater)
  
  Allows you to update values for redaction purposes
- forEachAnnotation
  
  public <T> void forEachAnnotation(MutableSpan.AnnotationConsumer<T> annotationConsumer, T target)
  
  Allows you to copy all data into a different target, such as a different span model or logs.
- forEachAnnotation
  
  public void forEachAnnotation(MutableSpan.AnnotationUpdater annotationUpdater)
  
  Allows you to update values for redaction purposes
- shared
  
  public boolean shared()
  
  Returns true if the span ID is shared with a remote client.
- setShared
  
  public void setShared()
  
  Indicates we are contributing to a span started by another tracer (ex on a different host). Defaults to false.
  
  See Also:
  
  Tracer.joinSpan(TraceContext), Span.shared()

Class MutableSpan

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details