All Implemented Interfaces:

com.datadog.trace.api.gateway.IGSpanInfo , com.datadog.trace.api.interceptor.MutableSpan
```
public interface AgentSpan
 implements MutableSpan, IGSpanInfo
                    
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`AgentSpan.Context`

Method Summary

Modifier and Type	Method	Description
`abstract DDTraceId`	`getTraceId()`
`abstract long`	`getSpanId()`
`abstract AgentSpan`	`setTag(String key, boolean value)`
`abstract AgentSpan`	`setTag(String key, int value)`
`abstract AgentSpan`	`setTag(String key, long value)`
`abstract AgentSpan`	`setTag(String key, double value)`
`abstract AgentSpan`	`setTag(String key, String value)`
`abstract AgentSpan`	`setTag(String key, CharSequence value)`
`abstract AgentSpan`	`setTag(String key, Object value)`
`abstract AgentSpan`	`setTag(String key, Number value)`
`abstract AgentSpan`	`setMetric(CharSequence key, int value)`
`abstract AgentSpan`	`setMetric(CharSequence key, long value)`
`abstract AgentSpan`	`setMetric(CharSequence key, double value)`
`abstract AgentSpan`	`setSpanType(CharSequence type)`
`abstract Object`	`getTag(String key)`
`abstract AgentSpan`	`setError(boolean error)`
`abstract AgentSpan`	`setError(boolean error, byte priority)`
`abstract AgentSpan`	`setMeasured(boolean measured)`
`abstract AgentSpan`	`setErrorMessage(String errorMessage)`
`abstract AgentSpan`	`addThrowable(Throwable throwable)`
`abstract AgentSpan`	`addThrowable(Throwable throwable, byte errorPriority)`
`abstract AgentSpan`	`getLocalRootSpan()`	Returns the root span for current the trace fragment.
`abstract boolean`	`isSameTrace(AgentSpan otherSpan)`
`abstract AgentSpan.Context`	`context()`
`abstract String`	`getBaggageItem(String key)`
`abstract AgentSpan`	`setBaggageItem(String key, String value)`
`abstract AgentSpan`	`setHttpStatusCode(int statusCode)`
`abstract short`	`getHttpStatusCode()`
`abstract void`	`finish()`
`abstract void`	`finish(long finishMicros)`
`abstract void`	`finishWithDuration(long durationNanos)`
`abstract void`	`beginEndToEnd()`	Marks the start of a message pipeline where we want to track end-to-end processing time.
`abstract void`	`finishWithEndToEnd()`	Marks the end of a message pipeline where the final end-to-end processing time is recorded.
`abstract boolean`	`phasedFinish()`	Finishes the span but does not publish it.
`abstract void`	`publish()`	Publish a span that was previously finished by calling phasedFinish.
`abstract CharSequence`	`getSpanName()`
`abstract void`	`setSpanName(CharSequence spanName)`
`abstract boolean`	`hasResourceName()`	Deprecated in favor of setResourceName(final CharSequence resourceName, byte priority) or usinggetResourceNamePriority() for comparisons.
`abstract byte`	`getResourceNamePriority()`
`abstract AgentSpan`	`setResourceName(CharSequence resourceName)`
`abstract AgentSpan`	`setResourceName(CharSequence resourceName, byte priority)`	Implementation note: two calls with the same priority will result in the second resource namebeing used
`abstract boolean`	`eligibleForDropping()`
`abstract RequestContext`	`getRequestContext()`	RequestContext for the Instrumentation Gateway
`abstract Integer`	`forceSamplingDecision()`
`abstract AgentSpan`	`setSamplingPriority(int newPriority, int samplingMechanism)`
`abstract TraceConfig`	`traceConfig()`
`abstract void`	`addLink(AgentSpanLink link)`

Methods inherited from class com.datadog.trace.api.interceptor.MutableSpan
getDurationNano, getLocalRootSpan, getOperationName, getResourceName, getRootSpan, getSamplingPriority, getServiceName, getSpanType, getStartTime, getTags, isError, setError, setMetric, setMetric, setMetric, setOperationName, setResourceName, setSamplingPriority, setServiceName, setSpanType, setTag, setTag, setTag
Methods inherited from class com.datadog.trace.api.gateway.IGSpanInfo
getRequestBlockingAction, setRequestBlockingAction
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTraceId
```
 abstract DDTraceId getTraceId()
```

getSpanId
```
 abstract long getSpanId()
```

setTag

 abstract AgentSpan setTag(String key, boolean value)

setTag

 abstract AgentSpan setTag(String key, int value)

setTag

 abstract AgentSpan setTag(String key, long value)

setTag

 abstract AgentSpan setTag(String key, double value)

setTag

 abstract AgentSpan setTag(String key, String value)

setTag

 abstract AgentSpan setTag(String key, CharSequence value)

setTag

 abstract AgentSpan setTag(String key, Object value)

setTag

 abstract AgentSpan setTag(String key, Number value)

setMetric

 abstract AgentSpan setMetric(CharSequence key, int value)

setMetric

 abstract AgentSpan setMetric(CharSequence key, long value)

setMetric

 abstract AgentSpan setMetric(CharSequence key, double value)

setSpanType

 abstract AgentSpan setSpanType(CharSequence type)

getTag
```
 abstract Object getTag(String key)
```

setError

 abstract AgentSpan setError(boolean error)

setError

 abstract AgentSpan setError(boolean error, byte priority)

setMeasured

 abstract AgentSpan setMeasured(boolean measured)

setErrorMessage

 abstract AgentSpan setErrorMessage(String errorMessage)

addThrowable

 abstract AgentSpan addThrowable(Throwable throwable)

addThrowable

 abstract AgentSpan addThrowable(Throwable throwable, byte errorPriority)

getLocalRootSpan
```
 abstract AgentSpan getLocalRootSpan()
```
Returns the root span for current the trace fragment. In the context of distributed tracingthis method returns the root span only for the fragment generated by the currently tracedapplication.

isSameTrace

 abstract boolean isSameTrace(AgentSpan otherSpan)

context
```
 abstract AgentSpan.Context context()
```

getBaggageItem

 abstract String getBaggageItem(String key)

setBaggageItem

 abstract AgentSpan setBaggageItem(String key, String value)

setHttpStatusCode

 abstract AgentSpan setHttpStatusCode(int statusCode)

getHttpStatusCode
```
 abstract short getHttpStatusCode()
```

finish
```
 abstract void finish()
```

finish

 abstract void finish(long finishMicros)

finishWithDuration

 abstract void finishWithDuration(long durationNanos)

beginEndToEnd
```
 abstract void beginEndToEnd()
```
Marks the start of a message pipeline where we want to track end-to-end processing time.

finishWithEndToEnd
```
 abstract void finishWithEndToEnd()
```
Marks the end of a message pipeline where the final end-to-end processing time is recorded.
Note: this will also finish the span and publish it.

phasedFinish
```
 abstract boolean phasedFinish()
```
Finishes the span but does not publish it. The publish method MUST be called onceotherwise the trace will not be reported.

publish
```
 abstract void publish()
```
Publish a span that was previously finished by calling phasedFinish. Must be calledonce and only once per span.

getSpanName
```
 abstract CharSequence getSpanName()
```

setSpanName

 abstract void setSpanName(CharSequence spanName)

hasResourceName
```
@Deprecated() abstract boolean hasResourceName()
```
Deprecated in favor of setResourceName(final CharSequence resourceName, byte priority) or usinggetResourceNamePriority() for comparisons.

getResourceNamePriority

 abstract byte getResourceNamePriority()

setResourceName

 abstract AgentSpan setResourceName(CharSequence resourceName)

setResourceName
```
 abstract AgentSpan setResourceName(CharSequence resourceName, byte priority)
```
Implementation note: two calls with the same priority will result in the second resource namebeing used

eligibleForDropping
```
 abstract boolean eligibleForDropping()
```

getRequestContext
```
 abstract RequestContext getRequestContext()
```
RequestContext for the Instrumentation Gateway

forceSamplingDecision

 abstract Integer forceSamplingDecision()

setSamplingPriority

 abstract AgentSpan setSamplingPriority(int newPriority, int samplingMechanism)

traceConfig
```
 abstract TraceConfig traceConfig()
```

addLink

 abstract void addLink(AgentSpanLink link)

Interface AgentSpan

Nested Class Summary

Method Summary

Methods inherited from class com.datadog.trace.api.interceptor.MutableSpan

Methods inherited from class com.datadog.trace.api.gateway.IGSpanInfo

Methods inherited from class java.lang.Object

Method Detail

getTraceId

getSpanId

setTag

setTag

setTag

setTag

setTag

setTag

setTag

setTag

setMetric

setMetric

setMetric

setSpanType

getTag

setError

setError

setMeasured

setErrorMessage

addThrowable

addThrowable

getLocalRootSpan

isSameTrace

context

getBaggageItem

setBaggageItem

setHttpStatusCode

getHttpStatusCode

finish

finish

finishWithDuration

beginEndToEnd

finishWithEndToEnd

phasedFinish

publish

getSpanName

setSpanName

hasResourceName

getResourceNamePriority

setResourceName

setResourceName

eligibleForDropping

getRequestContext

forceSamplingDecision

setSamplingPriority

traceConfig

addLink