Class Sampler

    • Constructor Summary

      Constructors 
      Constructor Description
      Sampler()  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract java.lang.String getDescription()
      Returns the description of this Sampler.
      abstract boolean shouldSample​(SpanContext parentContext, java.lang.Boolean hasRemoteParent, TraceId traceId, SpanId spanId, java.lang.String name, java.util.List<Span> parentLinks)
      Called during Span creation to make a sampling decision.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Sampler

        public Sampler()
    • Method Detail

      • shouldSample

        public abstract boolean shouldSample​(@Nullable
                                             SpanContext parentContext,
                                             @Nullable
                                             java.lang.Boolean hasRemoteParent,
                                             TraceId traceId,
                                             SpanId spanId,
                                             java.lang.String name,
                                             java.util.List<Span> parentLinks)
        Called during Span creation to make a sampling decision.
        Parameters:
        parentContext - the parent span's SpanContext. null if this is a root span.
        hasRemoteParent - true if the parent Span is remote. null if this is a root span.
        traceId - the TraceId for the new Span. This will be identical to that in the parentContext, unless this is a root span.
        spanId - the SpanId for the new Span.
        name - the name of the new Span.
        parentLinks - the parentLinks associated with the new Span.
        Returns:
        true if the Span is sampled.
        Since:
        0.5
      • getDescription

        public abstract java.lang.String getDescription()
        Returns the description of this Sampler. This may be displayed on debug pages or in the logs.

        Example: "ProbabilitySampler{0.000100}"

        Returns:
        the description of this Sampler.
        Since:
        0.6