Metrics API RFC 0009 (open-telemetry#140)

lzchen · web-flow · commit ca10173422f3 · 2019-09-19T11:43:30.000-07:00
* Create functions

Comments for Meter

More comments

Add more comments

Fix typos

* fix lint

* Fix lint

* fix typing

* Remove options, constructors, seperate labels

* Consistent naming for float and int

* Abstract time series

* Use ABC

* Fix typo

* Fix docs

* seperate measure classes

* Add examples

* fix lint

* Update to RFC 0003

* Add spancontext, measurebatch

* Fix docs

* Fix comments

* fix lint

* fix lint

* fix lint

* skip examples

* white space

* fix spacing

* fix imports

* fix imports

* LabelValues to str

* Black formatting

* fix isort

* Remove aggregation

* Fix names

* Remove aggregation from docs

* Fix lint

* metric changes

* Typing

* Fix lint

* Fix lint

* Add space

* Fix lint

* fix comments

* handle, recordbatch

* docs

* Update recordbatch

* black

* Fix typo

* remove ValueType

* fix lint
diff --git a/docs/opentelemetry.metrics.handle.rst b/docs/opentelemetry.metrics.handle.rst
@@ -0,0 +1,5 @@
+opentelemetry.metrics.handle module
+==========================================
+
+.. automodule:: opentelemetry.metrics.handle
+
diff --git a/docs/opentelemetry.metrics.rst b/docs/opentelemetry.metrics.rst
@@ -6,7 +6,7 @@ Submodules
 
 .. toctree::
 
-   opentelemetry.metrics.time_series
+   opentelemetry.metrics.handle
 
 Module contents
 ---------------
diff --git a/docs/opentelemetry.metrics.time_series.rst b/docs/opentelemetry.metrics.time_series.rst
diff --git a/opentelemetry-api/src/opentelemetry/metrics/__init__.py b/opentelemetry-api/src/opentelemetry/metrics/__init__.py
@@ -27,13 +27,12 @@
 
 """
 from abc import ABC, abstractmethod
-from enum import Enum
-from typing import List, Union
+from typing import Dict, List, Tuple, Type, Union
 
-from opentelemetry.metrics.time_series import (
-    CounterTimeSeries,
-    GaugeTimeSeries,
-    MeasureTimeSeries,
+from opentelemetry.metrics.handle import (
+    CounterHandle,
+    GaugeHandle,
+    MeasureHandle,
 )
 from opentelemetry.trace import SpanContext
 
@@ -47,19 +46,30 @@ class Meter:
     for the exported metric are deferred.
     """
 
-    # TODO: RecordBatch
+    def record_batch(
+        self,
+        label_tuples: Dict[str, str],
+        record_tuples: List[Tuple["Metric", Union[float, int]]],
+    ) -> None:
+        """Atomically records a batch of `Metric` and value pairs.
 
+        Allows the functionality of acting upon multiple metrics with
+        a single API call. Implementations should find handles that match
+        the key-value pairs in the label tuples.
 
-class ValueType(Enum):
-    FLOAT = 0
-    INT = 1
+        Args:
+            label_tuples: A collection of key value pairs that will be matched
+                against to record for the metric-handle that has those labels.
+            record_tuples: A list of pairs of `Metric` s and the
+                corresponding value to record for that metric.
+        """
 
 
 def create_counter(
     name: str,
     description: str,
     unit: str,
-    value_type: "ValueType",
+    value_type: Union[Type[float], Type[int]],
     is_bidirectional: bool = False,
     label_keys: List[str] = None,
     span_context: SpanContext = None,
@@ -91,7 +101,7 @@ def create_gauge(
     name: str,
     description: str,
     unit: str,
-    value_type: "ValueType",
+    value_type: Union[Type[float], Type[int]],
     is_unidirectional: bool = False,
     label_keys: List[str] = None,
     span_context: SpanContext = None,
@@ -122,7 +132,7 @@ def create_measure(
     name: str,
     description: str,
     unit: str,
-    value_type: "ValueType",
+    value_type: Union[Type[float], Type[int]],
     is_non_negative: bool = False,
     label_keys: List[str] = None,
     span_context: SpanContext = None,
@@ -157,82 +167,71 @@ class Metric(ABC):
     """
 
     @abstractmethod
-    def get_or_create_time_series(self, label_values: List[str]) -> "object":
-        """Gets a timeseries, used for repeated-use of metrics instruments.
+    def get_handle(self, label_values: List[str]) -> "object":
+        """Gets a handle, used for repeated-use of metrics instruments.
 
-        If the provided label values are not already associated with this
-        metric, a new timeseries is returned, otherwise it returns the existing
-        timeseries with the exact label values. The timeseries returned
-        contains logic and behaviour specific to the type of metric that
-        overrides this function.
+        Handles are useful to reduce the cost of repeatedly recording a metric
+        with a pre-defined set of label values. All metric kinds (counter,
+        gauge, measure) support declaring a set of required label keys. The
+        values corresponding to these keys should be specified in every handle.
+        "Unspecified" label values, in cases where a handle is requested but
+        a value was not provided are permitted.
 
         Args:
             label_values: A list of label values that will be associated
-                with the return timeseries.
+                with the return handle.
         """
 
-    def remove_time_series(self, label_values: List[str]) -> None:
-        """Removes the timeseries from the Metric, if present.
+    def remove_handle(self, label_values: List[str]) -> None:
+        """Removes the handle from the Metric, if present.
 
-        The timeseries with matching label values will be removed.
+        The handle with matching label values will be removed.
 
         args:
             label_values: The list of label values to match against.
         """
 
     def clear(self) -> None:
-        """Removes all timeseries from the `Metric`."""
+        """Removes all handles from the `Metric`."""
 
 
 class FloatCounter(Metric):
     """A counter type metric that holds float values."""
 
-    def get_or_create_time_series(
-        self, label_values: List[str]
-    ) -> "CounterTimeSeries":
-        """Gets a `CounterTimeSeries` with a float value."""
+    def get_handle(self, label_values: List[str]) -> "CounterHandle":
+        """Gets a `CounterHandle` with a float value."""
 
 
 class IntCounter(Metric):
     """A counter type metric that holds int values."""
 
-    def get_or_create_time_series(
-        self, label_values: List[str]
-    ) -> "CounterTimeSeries":
-        """Gets a `CounterTimeSeries` with an int value."""
+    def get_handle(self, label_values: List[str]) -> "CounterHandle":
+        """Gets a `CounterHandle` with an int value."""
 
 
 class FloatGauge(Metric):
     """A gauge type metric that holds float values."""
 
-    def get_or_create_time_series(
-        self, label_values: List[str]
-    ) -> "GaugeTimeSeries":
-        """Gets a `GaugeTimeSeries` with a float value."""
+    def get_handle(self, label_values: List[str]) -> "GaugeHandle":
+        """Gets a `GaugeHandle` with a float value."""
 
 
 class IntGauge(Metric):
     """A gauge type metric that holds int values."""
 
-    def get_or_create_time_series(
-        self, label_values: List[str]
-    ) -> "GaugeTimeSeries":
-        """Gets a `GaugeTimeSeries` with an int value."""
+    def get_handle(self, label_values: List[str]) -> "GaugeHandle":
+        """Gets a `GaugeHandle` with an int value."""
 
 
 class FloatMeasure(Metric):
     """A measure type metric that holds float values."""
 
-    def get_or_create_time_series(
-        self, label_values: List[str]
-    ) -> "MeasureTimeSeries":
-        """Gets a `MeasureTimeSeries` with a float value."""
+    def get_handle(self, label_values: List[str]) -> "MeasureHandle":
+        """Gets a `MeasureHandle` with a float value."""
 
 
 class IntMeasure(Metric):
     """A measure type metric that holds int values."""
 
-    def get_or_create_time_series(
-        self, label_values: List[str]
-    ) -> "MeasureTimeSeries":
-        """Gets a `MeasureTimeSeries` with an int value."""
+    def get_handle(self, label_values: List[str]) -> "MeasureHandle":
+        """Gets a `MeasureHandle` with an int value."""
diff --git a/opentelemetry-api/src/opentelemetry/metrics/examples/pre_aggregated.py b/opentelemetry-api/src/opentelemetry/metrics/examples/pre_aggregated.py
@@ -16,7 +16,7 @@
 from opentelemetry import metrics
 
 METER = metrics.Meter()
-COUNTER = METER.create_int_counter(
+COUNTER = METER.create_counter(
     "sum numbers",
     "sum numbers over time",
     "number",
@@ -25,8 +25,8 @@
 )
 
 # Metrics sent to some exporter
-METRIC_TESTING = COUNTER.get_or_create_time_series("Testing")
-METRIC_STAGING = COUNTER.get_or_create_time_series("Staging")
+METRIC_TESTING = COUNTER.get_handle("Testing")
+METRIC_STAGING = COUNTER.get_handle("Staging")
 
 for i in range(100):
     METRIC_STAGING.add(i)
diff --git a/opentelemetry-api/src/opentelemetry/metrics/examples/raw.py b/opentelemetry-api/src/opentelemetry/metrics/examples/raw.py
@@ -25,9 +25,12 @@
 )
 
 # Metrics sent to some exporter
-MEASURE_METRIC_TESTING = MEASURE.get_or_create_time_series("Testing")
-MEASURE_METRIC_STAGING = MEASURE.get_or_create_time_series("Staging")
+MEASURE_METRIC_TESTING = MEASURE.get_handle("Testing")
+MEASURE_METRIC_STAGING = MEASURE.get_handle("Staging")
 
 # record individual measures
 STATISTIC = 100
 MEASURE_METRIC_STAGING.record(STATISTIC)
+
+# Batch recording
+METER.record_batch([tuple(MEASURE_METRIC_STAGING, STATISTIC)])
diff --git a/opentelemetry-api/src/opentelemetry/metrics/handle.py b/opentelemetry-api/src/opentelemetry/metrics/handle.py
@@ -15,19 +15,19 @@
 import typing
 
 
-class CounterTimeSeries:
+class CounterHandle:
     def add(self, value: typing.Union[float, int]) -> None:
         """Adds the given value to the current value.
 
         The input value cannot be negative if not bidirectional.
         """
 
 
-class GaugeTimeSeries:
+class GaugeHandle:
     def set(self, value: typing.Union[float, int]) -> None:
         """Sets the current value to the given value. Can be negative."""
 
 
-class MeasureTimeSeries:
+class MeasureHandle:
     def record(self, value: typing.Union[float, int]) -> None:
         """Records the given value to this measure."""
