blob: ed8170a9d7ff1fc26c68b028156346f2d762db17 (
plain) (
tree)
|
|
/*
* =========================================================================================
* Copyright © 2013 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 java.io.ObjectStreamException
import akka.actor.{ ExtensionId, ActorSystem }
import kamon.Kamon.Extension
import kamon._
import kamon.metric._
import kamon.trace.TraceContextAware.DefaultTraceContextAware
import kamon.util.{ NanoInterval, RelativeNanoTimestamp }
trait TraceContext {
def name: String
def token: String
def isEmpty: Boolean
def nonEmpty: Boolean = !isEmpty
def isOpen: Boolean
def isClosed: Boolean = !isOpen
def finish(): Unit
def rename(newName: String): Unit
def startSegment(segmentName: String, category: String, library: String): Segment
def addMetadata(key: String, value: String)
def startTimestamp: RelativeNanoTimestamp
def lookupExtension[T <: Kamon.Extension](id: ExtensionId[T]): T
}
object TraceContext {
private[kamon] val _traceContextStorage = new ThreadLocal[TraceContext] {
override def initialValue(): TraceContext = EmptyTraceContext
}
def currentContext: TraceContext =
_traceContextStorage.get()
def setCurrentContext(context: TraceContext): Unit =
_traceContextStorage.set(context)
def clearCurrentContext: Unit =
_traceContextStorage.remove()
def withContext[T](context: TraceContext)(code: ⇒ T): T = {
val oldContext = _traceContextStorage.get()
_traceContextStorage.set(context)
try code finally _traceContextStorage.set(oldContext)
}
def map[T](f: TraceContext ⇒ T): Option[T] = {
val current = currentContext
if (current.nonEmpty)
Some(f(current))
else None
}
}
trait Segment {
def name: String
def category: String
def library: String
def isEmpty: Boolean
def nonEmpty: Boolean = !isEmpty
def isOpen: Boolean
def isClosed: Boolean = !isOpen
def finish(): Unit
def rename(newName: String): Unit
def addMetadata(key: String, value: String)
}
case object EmptyTraceContext extends TraceContext {
def name: String = "empty-trace"
def token: String = ""
def isEmpty: Boolean = true
def isOpen: Boolean = false
def finish(): Unit = {}
def rename(name: String): Unit = {}
def startSegment(segmentName: String, category: String, library: String): Segment = EmptySegment
def addMetadata(key: String, value: String): Unit = {}
def startTimestamp = new RelativeNanoTimestamp(0L)
override def lookupExtension[T <: Extension](id: ExtensionId[T]): T =
sys.error("Can't lookup extensions on a EmptyTraceContext.")
case object EmptySegment extends Segment {
val name: String = "empty-segment"
val category: String = "empty-category"
val library: String = "empty-library"
def isEmpty: Boolean = true
def isOpen: Boolean = false
def finish: Unit = {}
def rename(newName: String): Unit = {}
def addMetadata(key: String, value: String): Unit = {}
}
}
object SegmentCategory {
val HttpClient = "http-client"
val Database = "database"
}
class LOD private[trace] (val level: Int) extends AnyVal
object LOD {
val MetricsOnly = new LOD(1)
val SimpleTrace = new LOD(2)
}
sealed trait LevelOfDetail
object LevelOfDetail {
case object MetricsOnly extends LevelOfDetail
case object SimpleTrace extends LevelOfDetail
case object FullTrace extends LevelOfDetail
}
trait TraceContextAware extends Serializable {
def traceContext: TraceContext
}
object TraceContextAware {
def default: TraceContextAware = new DefaultTraceContextAware
class DefaultTraceContextAware extends TraceContextAware {
@transient val traceContext = TraceContext.currentContext
//
// Beware of this hack, it might bite us in the future!
//
// When using remoting/cluster all messages carry the TraceContext in the envelope in which they
// are sent but that doesn't apply to System Messages. We are certain that the TraceContext is
// available (if any) when the system messages are read and this will make sure that it is correctly
// captured and propagated.
@throws[ObjectStreamException]
private def readResolve: AnyRef = {
new DefaultTraceContextAware
}
}
}
trait TimestampedTraceContextAware extends TraceContextAware {
def captureNanoTime: Long
}
object TimestampedTraceContextAware {
def default: TimestampedTraceContextAware = new DefaultTraceContextAware with TimestampedTraceContextAware {
@transient val captureNanoTime = System.nanoTime()
}
}
trait SegmentAware {
@volatile var segment: Segment = EmptyTraceContext.EmptySegment
}
object SegmentAware {
def default: SegmentAware = new DefaultSegmentAware
class DefaultSegmentAware extends DefaultTraceContextAware with SegmentAware {}
}
|