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
|
/* =========================================================================================
* 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.metric
/**
* A MeasurementUnit is a simple representation of the dimension and magnitude of a quantity being measured, such as
* "Time in Seconds" or "Data in Kilobytes". The main use of these units is done by the metric instruments; when a
* instrument has a specified MeasurementUnit the reporters can apply scaling in case it's necessary to meet the
* backend's requirements.
*/
case class MeasurementUnit(dimension: MeasurementUnit.Dimension, magnitude: MeasurementUnit.Magnitude)
object MeasurementUnit {
val none = MeasurementUnit(Dimension.None, Magnitude("none", 1D))
val percentage = MeasurementUnit(Dimension.Percentage, Magnitude("percentage", 1D))
val time: TimeUnits = new TimeUnits {
val seconds = MeasurementUnit(Dimension.Time, Magnitude("seconds", 1D))
val milliseconds = MeasurementUnit(Dimension.Time, Magnitude("milliseconds", 1e-3))
val microseconds = MeasurementUnit(Dimension.Time, Magnitude("microseconds", 1e-6))
val nanoseconds = MeasurementUnit(Dimension.Time, Magnitude("nanoseconds", 1e-9))
}
val information: DataUnits = new DataUnits {
val bytes = MeasurementUnit(Dimension.Information, Magnitude("byte", 1))
val kilobytes = MeasurementUnit(Dimension.Information, Magnitude("kilobytes", 1024))
val megabytes = MeasurementUnit(Dimension.Information, Magnitude("megabytes", 1024 * 1024))
val gigabytes = MeasurementUnit(Dimension.Information, Magnitude("gigabytes", 1024 * 1024 * 1024))
}
/**
* Scales the provided value between two MeasurementUnits of the same dimension.
*
* @param value value to be scaled.
* @param from value's [[MeasurementUnit]].
* @param to target [[MeasurementUnit]].
* @return equivalent of the provided value on the target [[MeasurementUnit]]
*/
def scale(value: Long, from: MeasurementUnit, to: MeasurementUnit): Double = {
if(from.dimension != to.dimension)
sys.error(s"Can't scale values from the [${from.dimension.name}] dimension into the [${to.dimension.name}] dimension.")
else if(from == to)
value.toDouble
else (from.magnitude.scaleFactor / to.magnitude.scaleFactor) * value.toDouble
}
case class Dimension(name: String)
case class Magnitude(name: String, scaleFactor: Double)
object Dimension {
val None = Dimension("none")
val Percentage = Dimension("percentage")
val Time = Dimension("time")
val Information = Dimension("information")
}
trait TimeUnits {
def seconds: MeasurementUnit
def milliseconds: MeasurementUnit
def microseconds: MeasurementUnit
def nanoseconds: MeasurementUnit
}
trait DataUnits {
def bytes: MeasurementUnit
def kilobytes: MeasurementUnit
def megabytes: MeasurementUnit
def gigabytes: MeasurementUnit
}
}
|
