TracerSpan (Beeline Java (Parent) 1.1.0 API)

java.lang.Object
- io.honeycomb.beeline.tracing.Span
- - io.honeycomb.beeline.tracing.TracerSpan

All Implemented Interfaces:

AutoCloseable
```
public class TracerSpan
extends Span
```
This class represents a Span that is managed by a Tracer.
It overrides all methods of Span, and then simply delegates method invocations to the Span instance that it wraps.
The only added functionality is in close(), which is used to notify the Tracer of the TracerSpan being closed prior to invoking close on the delegate Span. This ensures that the TracerSpan can detach itself from the Tracer context and perform any necessary cleanup.
Thread-safety
Instances of this class are not thread-safe. See the notes on the Tracer's javadoc for details.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Span`	`addField(String key, Object value)`	Add a field to the Span.
`Span`	`addFields(Map<String,?> fieldsToAdd)`	Add a fields to the Span.
`Span`	`addTraceField(String key, Object value)`	Add a trace field to the Span.
`Span`	`addTraceFields(Map<String,?> traceFieldsToAdd)`	Add trace fields to the Span.
`void`	`close()`	Closes this span in order to submit it as an `Event` to Honeycomb and perform any necessary clean up in the process.
`protected void`	`closeInternal()`	Subclasses should override this to implement the mechanism
`double`	`elapsedTimeMs()`
`String`	`getDataset()`
`Map<String,Object>`	`getFields()`
`String`	`getParentSpanId()`
`String`	`getServiceName()`
`String`	`getSpanId()`
`String`	`getSpanName()`
`long`	`getStartTime()`
`long`	`getTimestamp()`
`PropagationContext`	`getTraceContext()`
`Map<String,Object>`	`getTraceFields()`
`String`	`getTraceId()`
`boolean`	`isNoop()`
`Span`	`markStart()`	Reset the Span's timer.
`Span`	`markStart(long timestamp, long startTime)`	Sets the times with the specified values - useful when copying Spans.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class io.honeycomb.beeline.tracing.Span
getNoopInstance

- Method Detail
  - addField
```
public Span addField(String key,
                     Object value)
```
    Description copied from class: Span
    
    Add a field to the Span.
    
    Overrides:
    
    addField in class Span
    
    Parameters:
    
    key - of the field.
    
    value - of the field.
    
    Returns:
    
    this span.
  - addFields
```
public Span addFields(Map<String,?> fieldsToAdd)
```
    Description copied from class: Span
    
    Add a fields to the Span.
    
    Overrides:
    
    addFields in class Span
    
    Parameters:
    
    fieldsToAdd - to add.
    
    Returns:
    
    this Span.
  - addTraceField
```
public Span addTraceField(String key,
                          Object value)
```
    Description copied from class: Span
    
    Add a trace field to the Span.
    
    Overrides:
    
    addTraceField in class Span
    
    Parameters:
    
    key - of the field.
    
    value - of the field.
    
    Returns:
    
    this Span.
  - addTraceFields
```
public Span addTraceFields(Map<String,?> traceFieldsToAdd)
```
    Description copied from class: Span
    
    Add trace fields to the Span.
    
    Overrides:
    
    addTraceFields in class Span
    
    Parameters:
    
    traceFieldsToAdd - to add.
    
    Returns:
    
    this Span.
  - markStart
```
public Span markStart()
```
    Description copied from class: Span
    
    Reset the Span's timer.
    The Span always starts the timer upon construction of the instance. However, if the operation covered by the Span starts later you can reset its timer with this (e.g. for async use cases).
    
    Overrides:
    
    markStart in class Span
    
    Returns:
    
    this Span.
  - markStart
```
public Span markStart(long timestamp,
                      long startTime)
```
    Description copied from class: Span
    
    Sets the times with the specified values - useful when copying Spans.
    
    Overrides:
    
    markStart in class Span
    
    Parameters:
    
    timestamp - (millis since the epoch)
    
    startTime - start time (monotonic JVM time)
    
    Returns:
    
    this Span.
  - getParentSpanId
```
public String getParentSpanId()
```
    Overrides:
    
    getParentSpanId in class Span
  - getTraceId
```
public String getTraceId()
```
    Overrides:
    
    getTraceId in class Span
  - getDataset
```
public String getDataset()
```
    Overrides:
    
    getDataset in class Span
  - getSpanId
```
public String getSpanId()
```
    Overrides:
    
    getSpanId in class Span
  - getSpanName
```
public String getSpanName()
```
    Overrides:
    
    getSpanName in class Span
  - getServiceName
```
public String getServiceName()
```
    Overrides:
    
    getServiceName in class Span
  - getFields
```
public Map<String,Object> getFields()
```
    Overrides:
    
    getFields in class Span
    
    Returns:
    
    an unmodifiable reference to the Span's fields.
    
    See Also:
    
    Span.fields
  - getTraceFields
```
public Map<String,Object> getTraceFields()
```
    Overrides:
    
    getTraceFields in class Span
    
    Returns:
    
    an unmodifiable reference to the Span's trace fields.
    
    See Also:
    
    Span.traceFields
  - getTraceContext
```
public PropagationContext getTraceContext()
```
    Overrides:
    
    getTraceContext in class Span
    
    Returns:
    
    a PropagationContext with the Span's IDs and trace fields - useful for propagating traces.
  - elapsedTimeMs
```
public double elapsedTimeMs()
```
    Overrides:
    
    elapsedTimeMs in class Span
    
    Returns:
    
    the time elapsed since "markStart" as a double with sub-millis in the fractional part.
    
    See Also:
    
    Span.markStart()
  - getTimestamp
```
public long getTimestamp()
```
    Overrides:
    
    getTimestamp in class Span
    
    Returns:
    
    the timestamp (millis since the epoch) of when "markStart" was called.
    
    See Also:
    
    Span.markStart()
  - getStartTime
```
public long getStartTime()
```
    Overrides:
    
    getStartTime in class Span
    
    Returns:
    
    the start time (monotonic JVM time).
    
    See Also:
    
    Span.markStart()
  - isNoop
```
public boolean isNoop()
```
    Overrides:
    
    isNoop in class Span
  - close
```
public void close()
```
    Description copied from class: Span
    
    Closes this span in order to submit it as an Event to Honeycomb and perform any necessary clean up in the process. Overrides of Span.closeInternal() contain the logic to do this.
    The Span's duration is measured upon calling this method (as per Span.elapsedTimeMs()).
    In order to avoid clashes, because of multiple events with the same span_id being submitted, this method ensures that it is only called once and ignores multiple invocations. However, it does not use any synchronization to ensure this and is therefore not thread safe.
    This uses method allows Span to be used with try-with-resources statements.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class Span
  - closeInternal
```
protected void closeInternal()
```
    Description copied from class: Span
    
    Subclasses should override this to implement the mechanism
    
    Overrides:
    
    closeInternal in class Span
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Span

Class TracerSpan

Thread-safety

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class io.honeycomb.beeline.tracing.Span

Method Detail

addField

addFields

addTraceField

addTraceFields

markStart

markStart

getParentSpanId

getTraceId

getDataset

getSpanId

getSpanName

getServiceName

getFields

getTraceFields

getTraceContext

elapsedTimeMs

getTimestamp

getStartTime

isNoop

close

closeInternal

toString