Package io.micrometer.tracing.exporter

Interface FinishedSpan

public interface FinishedSpan
This API is inspired by OpenZipkin Brave (from {code MutableSpan}). Represents a span that has been finished and is ready to be sent to an external location (e.g. Zipkin).
Since:
1.0.0

  • Method Details

    • setName

      FinishedSpan setName(String name)
      Sets the name.
      Parameters:
      name - name to set
      Returns:
      this

    • getName

      String getName()
      Returns:
      span's name

    • getStartTimestamp

      Instant getStartTimestamp()
      Returns:
      span's start timestamp

    • getEndTimestamp

      Instant getEndTimestamp()
      Returns:
      span's end timestamp

    • getDuration

      default Duration getDuration()
      Returns:
      span's duration
      Since:
      1.2.0

    • setTags

      FinishedSpan setTags(Map<String,String> tags)
      Sets the tags.
      Parameters:
      tags - tags to set
      Returns:
      this

    • getTags

      Map<String,String> getTags()
      Returns:
      span's tags

    • setTypedTags

      default FinishedSpan setTypedTags(Map<String,Object> tags)
      Sets the tags with typed values.
      Parameters:
      tags - tags to set
      Returns:
      this
      Since:
      1.1.0

    • getTypedTags

      default Map<String,Object> getTypedTags()
      Not all tracers (e.g. Brave) honor different values of tags in which case the tags will always get converted to String.
      Returns:
      span's tags with typed values
      Since:
      1.1.0

    • setEvents

      FinishedSpan setEvents(Collection<Map.Entry<Long,String>> events)
      Sets the events.
      Parameters:
      events - events to set
      Returns:
      this

    • getEvents

      Collection<Map.Entry<Long,String>> getEvents()
      Returns:
      span's events as timestamp to value mapping

    • getSpanId

      String getSpanId()
      Returns:
      span's span id

    • getParentId

      @Nullable String getParentId()
      Returns:
      span's parent id or null if not set

    • getRemoteIp

      @Nullable String getRemoteIp()
      Returns:
      span's remote ip

    • getLocalIp

      default @Nullable String getLocalIp()
      Returns:
      span's local ip

    • setLocalIp

      FinishedSpan setLocalIp(String ip)
      Sets the local ip.
      Parameters:
      ip - ip to set
      Returns:
      this

    • getRemotePort

      int getRemotePort()
      Returns:
      span's remote port

    • setRemotePort

      FinishedSpan setRemotePort(int port)
      Sets the remote port.
      Parameters:
      port - port to set
      Returns:
      this

    • getTraceId

      String getTraceId()
      Returns:
      span's trace id

    • getError

      @Nullable Throwable getError()
      Returns:
      corresponding error or null if one was not thrown

    • setError

      FinishedSpan setError(Throwable error)
      Sets the error.
      Parameters:
      error - error to set
      Returns:
      this

    • getKind

      @Nullable Span.Kind getKind()
      Returns:
      span's kind

    • getRemoteServiceName

      @Nullable String getRemoteServiceName()
      Returns:
      remote service name or null if not set

    • setRemoteServiceName

      FinishedSpan setRemoteServiceName(String remoteServiceName)
      Sets the remote service name.
      Parameters:
      remoteServiceName - remote service name
      Returns:
      this

    • getLocalServiceName

      default @Nullable String getLocalServiceName()
      Returns:
      local service name or null if not set
      Since:
      1.5

    • setLocalServiceName

      default FinishedSpan setLocalServiceName(String localServiceName)
      Sets the local service name.
      Parameters:
      localServiceName - local service name
      Returns:
      this
      Since:
      1.5

    • getLinks

      default List<Link> getLinks()
      Returns:
      links
      Since:
      1.1.0

    • addLinks

      default FinishedSpan addLinks(List<Link> links)
      Adds links.
      Parameters:
      links - links to add
      Returns:
      this
      Since:
      1.1.0

    • addLink

      default FinishedSpan addLink(Link link)
      Adds a link.
      Parameters:
      link - link to add
      Returns:
      this
      Since:
      1.1.0