aboutsummaryrefslogtreecommitdiff
path: root/kamon-core/src/main/scala/kamon/trace/SpanContext.scala
blob: ae92f46d02ef2c5c9df29ec954806f2aefd3ebc6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/* =========================================================================================
 * 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.{Baggage, SamplingDecision, Source}

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

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

object SpanContext {

  sealed trait Source
  object Source {
    case object Local extends Source
    case object Remote extends Source
  }

  val EmptySpanContext = SpanContext(
    traceID   = IdentityProvider.NoIdentifier,
    spanID    = IdentityProvider.NoIdentifier,
    parentID  = IdentityProvider.NoIdentifier,
    samplingDecision = SamplingDecision.DoNotSample,
    baggage = Baggage.EmptyBaggage,
    source = Source.Local
  )


  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
  }

  /**
    *
    */

  sealed trait Baggage {
    def add(key: String, value:String): Unit
    def get(key: String): Option[String]
    def getAll(): Map[String, String]
  }

  object Baggage {
    def apply(): Baggage = new DefaultBaggage()

    case object EmptyBaggage extends Baggage {
      override def add(key: String, value: String): Unit = {}
      override def get(key: String): Option[String] = None
      override def getAll: Map[String, String] = Map.empty
    }


    final class DefaultBaggage extends Baggage {
      private var baggage: Map[String, String] = Map.empty

      def add(key: String, value: String): Unit = synchronized {
        baggage = baggage + (key -> value)
      }

      def get(key: String): Option[String] =
        baggage.get(key)

      def getAll: Map[String, String] =
        baggage
    }
  }
}