Method Detail

• start

   abstract Boolean start()

  Start recording of the Span. Returns true if this call triggered the start of the recording. Returns false if the Span has already been started or has been stopped.

• stop

   abstract Boolean stop()

  Stop the recording of the Span with no ErrorCode, indicating a successful completion of the underlying operation. Returns true if this call triggered the stopping of the recording. Returns false if the Span has not been started or if has already been stopped.

• stop

   abstract Boolean stop(ErrorCode errorCode)

  Stop the recording of the Span with an ErrorCode, a non-null value indicating an unsuccessful completion of the underlying operation with the given reason. Returns true if this call triggered the stopping of the recording. Returns false if the Span has not been started or if has already been stopped.

• addEvent

   abstract Boolean addEvent(String name)

  Add an EmbraceSpanEvent with the given name at the current time. Returns false if the Event was definitely not successfully added. Returns true if the validation at the Embrace level has passed and the call to add the Event at the OpenTelemetry level was successful.

• addEvent

   abstract Boolean addEvent(String name, Long time, Map<String, String> attributes)

  Add an EmbraceSpanEvent with the given name. If time is null, the current time will be used. Optionally, the specific time of the event and a set of attributes can be passed in associated with the event. Returns false if the Event was definitely not successfully added. Returns true if the validation at the Embrace level has passed and the call to add the Event at the OpenTelemetry level was successful.

• addAttribute

   abstract Boolean addAttribute(String key, String value)

  Add the given key-value pair as an Attribute to the Event. Returns false if the Attribute was definitely not added. Returns true if the validation at the Embrace Level has passed and the call to add the Attribute at the OpenTelemetry level was successful.

• getTraceId

   abstract String getTraceId()

  ID of the Trace that this Span belongs to. The format adheres to the OpenTelemetry standard for Trace IDs

• getSpanId

   abstract String getSpanId()

  ID of the Span. The format adheres to the OpenTelemetry standard for Span IDs

• getIsRecording

   abstract Boolean getIsRecording()

  Returns true if and only if this Span has been started and has not been stopped

• getParent

   abstract EmbraceSpan getParent()

  The Span that is the parent of this Span. If this is null, it means this Span is the root of the Trace.