Constructor Detail

• DDSpan

  DDSpan(String instrumentationName, long timestampMicro, DDSpanContext context, List<AgentSpanLink> links, InternalLogger internalLogger)

  Spans should be constructed using the builder, not by calling the constructor directly.

  Parameters:

  instrumentationName - instrumentation that creates the span

  timestampMicro - if greater than zero, use this time instead of the current time

  context - the context used for the span

Method Detail

• getStartTimeNano

   long getStartTimeNano()

• getDurationNano

   long getDurationNano()

• getEndpointTracker

  @Nullable() EndpointTracker getEndpointTracker()

  Retrieve the EndpointTracker instance associated with the corresponding local rootspan

• setEndpointTracker

   void setEndpointTracker(@NonNull() EndpointTracker endpointTracker)

  Attach an end-point tracker to the corresponding local root span. When this method is calledmultiple times the last invocation will 'win'

  Parameters:

  endpointTracker - the end-point tracker instance

• getWrapper

   Object getWrapper()

  Returns an attached OT/OTel wrapper or null.

• getRequestBlockingAction

   Flow.Action.RequestBlockingAction getRequestBlockingAction()

• setRequestBlockingAction

   void setRequestBlockingAction(Flow.Action.RequestBlockingAction rba)

• setLongRunningVersion

   void setLongRunningVersion(int longRunningVersion)

• getLinks

   List<AgentSpanLink> getLinks()

• isFinished

   boolean isFinished()

• finish

   void finish()

• finish

   void finish(long stopTimeMicros)

• finishWithDuration

   final void finishWithDuration(long durationNano)

• beginEndToEnd

   void beginEndToEnd()

  Marks the start of a message pipeline where we want to track end-to-end processing time.

• finishWithEndToEnd

   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

   final boolean phasedFinish()

  Finishes the span but does not publish it. The publish method MUST be called onceotherwise the trace will not be reported.

• publish

   final void publish()

  Publish a span that was previously finished by calling phasedFinish. Must be calledonce and only once per span.

• setError

   DDSpan setError(boolean error)

• setError

   DDSpan setError(boolean error, byte priority)

• setMeasured

   DDSpan setMeasured(boolean measured)

• forceKeep

   DDSpan forceKeep(boolean forceKeep)

• isForceKeep

   boolean isForceKeep()

• isRootSpan

   final boolean isRootSpan()

  Check if the span is the root parent. It means that the traceId is the same as the spanId. Inthe context of distributed tracing this will return true if an only if this is the applicationinitializing the trace.

• getRootSpan

  @Deprecated() AgentSpan getRootSpan()

• getLocalRootSpan

   DDSpan 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.

• isLocalRootSpan

   boolean isLocalRootSpan()

  Checks whether the span is also the local root span

• isSameTrace

   boolean isSameTrace(AgentSpan otherSpan)

• setErrorMessage

   DDSpan setErrorMessage(String errorMessage)

• addThrowable

   DDSpan addThrowable(Throwable error)

• addThrowable

   DDSpan addThrowable(Throwable error, byte errorPriority)

• setTag

   final DDSpan setTag(String tag, String value)

• setTag

   final DDSpan setTag(String tag, boolean value)

• setTag

   DDSpan setTag(String tag, int value)

• setTag

   DDSpan setTag(String tag, long value)

• setTag

   DDSpan setTag(String tag, double value)

• setTag

   DDSpan setTag(String tag, Number value)

• setMetric

   DDSpan setMetric(CharSequence metric, int value)

• setMetric

   DDSpan setMetric(CharSequence name, float value)

• setMetric

   DDSpan setMetric(CharSequence metric, long value)

• setMetric

   DDSpan setMetric(CharSequence metric, double value)

• setFlag

   DDSpan setFlag(CharSequence name, boolean value)

• setTag

   DDSpan setTag(String tag, CharSequence value)

• setTag

   DDSpan setTag(String tag, Object value)

• removeTag

   DDSpan removeTag(String tag)

• getTag

   Object getTag(String tag)

• context

  @NonNull() final DDSpanContext context()

• getBaggageItem

   final String getBaggageItem(String key)

• setBaggageItem

   final DDSpan setBaggageItem(String key, String value)

• setHttpStatusCode

   AgentSpan setHttpStatusCode(int statusCode)

• getHttpStatusCode

   short getHttpStatusCode()

• getOrigin

   CharSequence getOrigin()

• setOperationName

   final DDSpan setOperationName(CharSequence operationName)

• setServiceName

   final DDSpan setServiceName(String serviceName)

• setResourceName

   final DDSpan setResourceName(CharSequence resourceName)

• setResourceName

   final DDSpan setResourceName(CharSequence resourceName, byte priority)

  Implementation note: two calls with the same priority will result in the second resource namebeing used

• eligibleForDropping

   boolean eligibleForDropping()

• getRequestContext

   RequestContext getRequestContext()

  RequestContext for the Instrumentation Gateway

• forceSamplingDecision

   Integer forceSamplingDecision()

• setSamplingPriority

  @Deprecated() final DDSpan setSamplingPriority(int newPriority)

• setSamplingPriority

   final DDSpan setSamplingPriority(int newPriority, int samplingMechanism)

  Set the sampling priority of the root span of this span's trace

  Has no effect if the span priority has been propagated (injected or extracted).

• setSamplingPriority

   DDSpan setSamplingPriority(int samplingPriority, CharSequence rate, double sampleRate, int samplingMechanism)

• setSpanSamplingPriority

   DDSpan setSpanSamplingPriority(double rate, int limit)

• setSpanType

   final DDSpan setSpanType(CharSequence type)

• getStartTime

   long getStartTime()

• getServiceName

   String getServiceName()

• getTraceId

   DDTraceId getTraceId()

• getSpanId

   long getSpanId()

• getParentId

   long getParentId()

• getResourceName

   CharSequence getResourceName()

• getOperationName

   CharSequence getOperationName()

• getSpanName

   CharSequence getSpanName()

• setSpanName

   void setSpanName(CharSequence spanName)

• hasResourceName

   boolean hasResourceName()

  Deprecated in favor of setResourceName(final CharSequence resourceName, byte priority) or usinggetResourceNamePriority() for comparisons.

• getResourceNamePriority

   byte getResourceNamePriority()

• getSamplingPriority

   Integer getSamplingPriority()

• samplingPriority

   int samplingPriority()

• getSpanType

   String getSpanType()

• getTags

   Map<String, Object> getTags()

• getType

   CharSequence getType()

• processTagsAndBaggage

   void processTagsAndBaggage(MetadataConsumer consumer)

• isError

   boolean isError()

• getError

   int getError()

• getTag

   <U> U getTag(CharSequence name, U defaultValue)

• getTag

   <U> U getTag(CharSequence name)

• hasSamplingPriority

   boolean hasSamplingPriority()

• isMeasured

   boolean isMeasured()

• isTopLevel

   boolean isTopLevel()

• getBaggage

   Map<String, String> getBaggage()

• toString

   String toString()

• attachWrapper

   void attachWrapper(Object wrapper)

  Attaches a OT/OTel wrapper to a tracer object.

• traceConfig

   TraceConfig traceConfig()

• addLink

   void addLink(AgentSpanLink link)