path: root/kamon-core/src/main/scala/kamon/trace/SpanContext.scala

/* =========================================================================================
 * Copyright © 2013-2017 the kamon project <http://kamon.io/>
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 * =========================================================================================
 */

package kamon.trace

import kamon.trace.IdentityProvider.Identifier
import kamon.trace.SpanContext.SamplingDecision

/**
  *
  * @param traceID
  * @param spanID
  * @param parentID
  * @param samplingDecision
  */
case class SpanContext(traceID: Identifier, spanID: Identifier, parentID: Identifier, samplingDecision: SamplingDecision) {

  def createChild(childSpanID: Identifier, samplingDecision: SamplingDecision): SpanContext =
    this.copy(parentID = this.spanID, spanID = childSpanID, samplingDecision = samplingDecision)
}

object SpanContext {

  val EmptySpanContext = SpanContext(
    traceID = IdentityProvider.NoIdentifier,
    spanID = IdentityProvider.NoIdentifier,
    parentID = IdentityProvider.NoIdentifier,
    samplingDecision = SamplingDecision.DoNotSample
  )


  sealed trait SamplingDecision

  object SamplingDecision {

    /**
      * The Trace is sampled, all child Spans should be sampled as well.
      */
    case object Sample extends SamplingDecision

    /**
      * The Trace is not sampled, none of the child Spans should be sampled.
      */
    case object DoNotSample extends SamplingDecision

    /**
      * The sampling decision has not been taken yet, the Tracer is free to decide when creating a Span.
      */
    case object Unknown extends SamplingDecision

  }

}