io.prometheus.metrics.tracer.common.SpanContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jmx_prometheus_httpserver Show documentation

See https://github.com/prometheus/jmx_exporter/blob/master/README.md

There is a newer version: 1.0.1

Show newest version

package io.prometheus.metrics.tracer.common;

public interface SpanContext {

  String EXEMPLAR_ATTRIBUTE_NAME = "exemplar";
  String EXEMPLAR_ATTRIBUTE_VALUE = "true";

  /**
   * @return the current trace id, or {@code null} if this call is not happening within a span context.
   */
  String getCurrentTraceId();

  /**
   * @return the current span id, or {@code null} if this call is not happening within a span context.
   */
  String getCurrentSpanId();
  
  /**
   * @return the state of the current Span. If this value is false a component before in the chain take the decision to not record it. Subsequent calling service have
   * to respect this value in order not to have partial TraceID with only some Span in it. This value is important to be sure to choose a recorded Trace in Examplar
   * sampling process
   */
  boolean isCurrentSpanSampled();

  void markCurrentSpanAsExemplar();
}