Spaces:
Sleeping
Sleeping
File size: 9,091 Bytes
0d3a3a6 |
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 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
from abc import ABC, abstractmethod
from typing import Optional, Sequence
class MetricType:
"""
MetricType is a class for defining the type of a metric.
"""
COUNTER = "counter"
UPDOWNCOUNTER = "updowncounter"
GAUGE = "gauge"
HISTOGRAM = "histogram"
class MetricProvider(ABC):
"""
MeterProvider is the entry point of the API.
"""
def __init__(self):
# list of exporters
self._exporters = []
@abstractmethod
def shutdown(self):
"""
shutdown the metric provider.
"""
def add_exporter(self, exporter):
"""
Add an exporter to the list of exporters.
"""
self._exporters.append(exporter)
@abstractmethod
def create_counter(self, name: str, description: str, unit: str,
label_names: Optional[Sequence[str]] = None) -> "Counter":
"""
Create a counter.
Args:
name: The name of the instrument to be created
description: A description for this instrument and what it measures.
unit: The unit for observations this instrument reports. For
example, ``By`` for bytes. UCUM units are recommended.
"""
@abstractmethod
def create_un_down_counter(self, name: str, description: str, unit: str,
label_names: Optional[Sequence[str]] = None) -> "UnDownCounter":
"""
Create a un-down counter.
Args:
name: The name of the instrument to be created
description: A description for this instrument and what it measures.
unit: The unit for observations this instrument reports. For
example, ``By`` for bytes. UCUM units are recommended.
"""
@abstractmethod
def create_gauge(self, name: str, description: str, unit: str,
label_names: Optional[Sequence[str]] = None) -> "Gauge":
"""
Create a gauge.
Args:
name: The name of the instrument to be created
description: A description for this instrument and what it measures.
unit: The unit for observations this instrument reports. For
example, ``By`` for bytes. UCUM units are recommended.
"""
@abstractmethod
def create_histogram(self,
name: str,
description: str,
unit: str,
buckets: Optional[Sequence[float]] = None,
label_names: Optional[Sequence[str]] = None) -> "Histogram":
"""
Create a histogram.
Args:
name: The name of the instrument to be created
description: A description for this instrument and what it measures.
unit: The unit for observations this instrument reports. For
example, ``By`` for bytes. UCUM units are recommended.
"""
class BaseMetric(ABC):
"""
Metric is the base class for all metrics.
Args:
name: The name of the metric.
description: The description of the metric.
unit: The unit of the metric.
provider: The provider of the metric.
"""
def __init__(self,
name: str,
description: str,
unit: str,
provider: MetricProvider,
label_names: Optional[Sequence[str]] = None):
self._name = name
self._description = description
self._unit = unit
self._provider = provider
self._label_names = label_names
self._type = None
class Counter(BaseMetric):
"""
Counter is a subclass of BaseMetric, representing a counter metric.
A counter is a cumulative metric that represents a single numerical value that only ever goes up.
"""
def __init__(self,
name: str,
description: str,
unit: str,
provider: MetricProvider,
label_names: Optional[Sequence[str]] = None):
"""
Initialize the Counter.
Args:
name: The name of the metric.
description: The description of the metric.
unit: The unit of the metric.
provider: The provider of the metric.
"""
super().__init__(name, description, unit, provider, label_names)
self._type = MetricType.COUNTER
@abstractmethod
def add(self, value: int, labels: dict = None) -> None:
"""
Add a value to the counter.
Args:
value: The value to add to the counter.
labels: The labels to associate with the value.
"""
class UpDownCounter(BaseMetric):
"""
UpDownCounter is a subclass of BaseMetric, representing an un-down counter metric.
An un-down counter is a cumulative metric that represents a single numerical value that only ever goes up.
"""
def __init__(self,
name: str,
description: str,
unit: str,
provider: MetricProvider,
label_names: Optional[Sequence[str]] = None):
"""
Initialize the UnDownCounter.
Args:
name: The name of the metric.
description: The description of the metric.
unit: The unit of the metric.
provider: The provider of the metric.
"""
super().__init__(name, description, unit, provider, label_names)
self._type = MetricType.UPDOWNCOUNTER
@abstractmethod
def inc(self, value: int, labels: dict = None) -> None:
"""
Add a value to the gauge.
Args:
value: The value to add to the gauge.
labels: The labels to associate with the value.
"""
@abstractmethod
def dec(self, value: int, labels: dict = None) -> None:
"""
Subtract a value from the gauge.
Args:
value: The value to subtract from the gauge.
labels: The labels to associate with the value.
"""
class Gauge(BaseMetric):
"""
Gauge is a subclass of BaseMetric, representing a gauge metric.
A gauge is a metric that represents a single numerical value that can arbitrarily go up and down.
"""
def __init__(self,
name: str,
description: str,
unit: str,
provider: MetricProvider,
label_names: Optional[Sequence[str]] = None):
"""
Initialize the Gauge.
Args:
name: The name of the metric.
description: The description of the metric.
unit: The unit of the metric.
provider: The provider of the metric.
"""
super().__init__(name, description, unit, provider, label_names)
self._type = MetricType.GAUGE
@abstractmethod
def set(self, value: int, labels: dict = None) -> None:
"""
Set the value of the gauge.
Args:
value: The value to set the gauge to.
labels: The labels to associate with the value.
"""
class Histogram(BaseMetric):
"""
Histogram is a subclass of BaseMetric, representing a histogram metric.
A histogram is a metric that represents the distribution of a set of values.
"""
def __init__(self,
name: str,
description: str,
unit: str,
provider: MetricProvider,
buckets: Sequence[float] = None,
label_names: Optional[Sequence[str]] = None):
"""
Initialize the Histogram.
Args:
name: The name of the metric.
description: The description of the metric.
unit: The unit of the metric.
provider: The provider of the metric.
buckets: The buckets of the histogram.
"""
super().__init__(name, description, unit, provider, label_names)
self._type = MetricType.HISTOGRAM
self._buckets = buckets
@abstractmethod
def record(self, value: int, labels: dict = None) -> None:
"""
Record a value in the histogram.
Args:
value: The value to record in the histogram.
labels: The labels to associate with the value.
"""
class MetricExporter(ABC):
"""
MetricExporter is the base class for all metric exporters.
"""
@abstractmethod
def shutdown(self):
"""
Export the metrics.
"""
_GLOBAL_METRIC_PROVIDER: Optional[MetricProvider] = None
def set_metric_provider(provider):
"""
Set the global metric provider.
"""
global _GLOBAL_METRIC_PROVIDER
_GLOBAL_METRIC_PROVIDER = provider
def get_metric_provider():
"""
Get the global metric provider.
"""
global _GLOBAL_METRIC_PROVIDER
if _GLOBAL_METRIC_PROVIDER is None:
raise ValueError("No metric provider has been set.")
return _GLOBAL_METRIC_PROVIDER
|