Consolidate exportresult

Author: lzchen

ext/opentelemetry-ext-azure-monitor/examples/metrics.py

@@ -14,13 +14,11 @@
 
 from opentelemetry import metrics
 from opentelemetry.ext.azure_monitor import AzureMonitorMetricsExporter
-from opentelemetry.sdk.metrics import Counter, Gauge, Meter
-from opentelemetry.sdk.metrics.export import ConsoleMetricsExporter
+from opentelemetry.sdk.metrics import Counter, Meter
 
 metrics.set_preferred_meter_implementation(lambda T: Meter())
 meter = metrics.meter()
 exporter = AzureMonitorMetricsExporter()
-console_exporter = ConsoleMetricsExporter()
 
 counter = meter.create_metric(
     "available memory",
@@ -30,23 +28,10 @@
     Counter,
     ("environment",),
 )
-gauge = meter.create_metric(
-    "process cpu usage",
-    "process cpu usage",
-    "percentage",
-    float,
-    Gauge,
-    ("environment",),
-)
+
 label_values = ("staging",)
-label_values2 = ("testing",)
 counter_handle = counter.get_handle(label_values)
 counter_handle.add(100)
-gauge_handle = gauge.get_handle(label_values2)
-gauge_handle.set(20.5)
-
 
-console_exporter.export([(counter, label_values), (gauge, label_values2)])
-exporter.export([(counter, label_values), (gauge, label_values2)])
-console_exporter.shutdown()
+exporter.export([(counter, label_values)])
 exporter.shutdown()

ext/opentelemetry-ext-azure-monitor/src/opentelemetry/ext/azure_monitor/metrics.py

@@ -15,10 +15,8 @@
 import logging
 
 from opentelemetry.ext.azure_monitor import protocol, transport, util
-from opentelemetry.sdk.metrics.export import (
-    MetricsExporter,
-    MetricsExportResult,
-)
+from opentelemetry.sdk.metrics.export import MetricsExporter
+from opentelemetry.sdk.util import ns_to_iso_str
 
 logger = logging.getLogger(__name__)
 
@@ -27,10 +25,15 @@ class AzureMonitorMetricsExporter(MetricsExporter, transport.TransportMixin):
     def __init__(self, **options):
         self.options = util.Options(**options)
         util.validate_key(self.options.instrumentation_key)
-        self.export_result_type = MetricsExportResult
 
     def export(self, metric_tuples):
-        # Metric tuples is a sequence of metric to label values pairs
+        """Exports metrics with specified label values.
+        
+        Args:
+            metrics_tuples: a sequence of metric to label value pairs.
+                The metric handles with the corresponding label values for
+                each metric will be used for exporting.
+        """
         envelopes = tuple(map(self._metric_tuple_to_envelope, metric_tuples))
         return self._transmit(envelopes)
 
@@ -41,7 +44,7 @@ def _metric_tuple_to_envelope(self, metric_tuple):
         envelope = protocol.Envelope(
             iKey=self.options.instrumentation_key,
             tags=dict(util.azure_monitor_context),
-            time=handle.last_update_timestamp,
+            time=ns_to_iso_str(handle.last_update_timestamp),
         )
         envelope.name = "Microsoft.ApplicationInsights.Metric"
         # label_keys and label_values assumed to have the same length

ext/opentelemetry-ext-azure-monitor/src/opentelemetry/ext/azure_monitor/trace.py

@@ -17,7 +17,7 @@
 from urllib.parse import urlparse
 
 from opentelemetry.ext.azure_monitor import protocol, transport, util
-from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult
+from opentelemetry.sdk.trace.export import SpanExporter
 from opentelemetry.sdk.util import ns_to_iso_str
 from opentelemetry.trace import Span, SpanKind
 
@@ -28,7 +28,6 @@ class AzureMonitorSpanExporter(SpanExporter, transport.TransportMixin):
     def __init__(self, **options):
         self.options = util.Options(**options)
         util.validate_key(self.options.instrumentation_key)
-        self.export_result_type = SpanExportResult
 
     def export(self, spans):
         envelopes = tuple(map(self.span_to_envelope, spans))

ext/opentelemetry-ext-azure-monitor/src/opentelemetry/ext/azure_monitor/transport.py

@@ -32,16 +32,16 @@ def _transmit(self, envelopes):
                 },
                 timeout=self.options.timeout,
             )
-        except requests.RequestException:
-            logger.exception("Transient client side error.")
+        except requests.RequestException as ex:
+            logger.warning("Transient client side error %s.", ex)
             return self.export_result_type.FAILED_RETRYABLE
 
         text = "N/A"
         data = None  # noqa pylint: disable=unused-variable
         try:
             text = response.text
-        except Exception:  # noqa pylint: disable=broad-except
-            logger.exception("Error while reading response body %s.")
+        except Exception as ex:  # noqa pylint: disable=broad-except
+            logger.warning("Error while reading response body %s.", ex)
         else:
             try:
                 data = json.loads(text)  # noqa pylint: disable=unused-variable

opentelemetry-sdk/src/opentelemetry/sdk/metrics/__init__.py

@@ -16,7 +16,7 @@
 from typing import Sequence, Tuple, Type
 
 from opentelemetry import metrics as metrics_api
-from opentelemetry.sdk.util import ns_to_iso_str, time_ns
+from opentelemetry.sdk.util import time_ns
 
 logger = logging.getLogger(__name__)
 
@@ -32,7 +32,7 @@ def __init__(
         self.value_type = value_type
         self.enabled = enabled
         self.monotonic = monotonic
-        self.last_update_timestamp = ns_to_iso_str(time_ns())
+        self.last_update_timestamp = time_ns()
 
     def _validate_update(self, value: metrics_api.ValueT):
         if not self.enabled:
@@ -57,7 +57,7 @@ def update(self, value: metrics_api.ValueT) -> None:
                 logger.warning("Monotonic counter cannot descend.")
                 return
             self.data += value
-            self.last_update_timestamp = ns_to_iso_str(time_ns())
+            self.last_update_timestamp = time_ns()
 
     def add(self, value: metrics_api.ValueT) -> None:
         """See `opentelemetry.metrics.CounterHandle._add`."""
@@ -71,7 +71,7 @@ def update(self, value: metrics_api.ValueT) -> None:
                 logger.warning("Monotonic gauge cannot descend.")
                 return
             self.data = value
-            self.last_update_timestamp = ns_to_iso_str(time_ns())
+            self.last_update_timestamp = time_ns()
 
     def set(self, value: metrics_api.ValueT) -> None:
         """See `opentelemetry.metrics.GaugeHandle._set`."""
@@ -84,7 +84,7 @@ def update(self, value: metrics_api.ValueT) -> None:
             if self.monotonic and value < 0:
                 logger.warning("Monotonic measure cannot accept negatives.")
                 return
-            self.last_update_timestamp = ns_to_iso_str(time_ns())
+            self.last_update_timestamp = time_ns()
 
     def record(self, value: metrics_api.ValueT) -> None:
         """See `opentelemetry.metrics.MeasureHandle._record`."""

opentelemetry-sdk/src/opentelemetry/sdk/metrics/export/__init__.py

@@ -16,12 +16,7 @@
 from typing import Sequence, Tuple
 
 from .. import Metric
-
-
-class MetricsExportResult(Enum):
-    SUCCESS = 0
-    FAILED_RETRYABLE = 1
-    FAILED_NOT_RETRYABLE = 2
+from opentelemetry.sdk.util import ExportResult
 
 
 class MetricsExporter:
@@ -33,7 +28,7 @@ class MetricsExporter:
 
     def export(
         self, metric_tuples: Sequence[Tuple[Metric, Sequence[str]]]
-    ) -> "MetricsExportResult":
+    ) -> "ExportResult":
         """Exports a batch of telemetry data.
 
         Args:
@@ -63,7 +58,7 @@ class ConsoleMetricsExporter(MetricsExporter):
 
     def export(
         self, metric_tuples: Sequence[Tuple[Metric, Sequence[str]]]
-    ) -> "MetricsExportResult":
+    ) -> "ExportResult":
         for metric_tuple in metric_tuples:
             handle = metric_tuple[0].get_handle(metric_tuple[1])
             print(
@@ -74,4 +69,4 @@ def export(
                     handle,
                 )
             )
-        return MetricsExportResult.SUCCESS
+        return ExportResult.SUCCESS

opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py

@@ -26,12 +26,6 @@
 logger = logging.getLogger(__name__)
 
 
-class SpanExportResult(Enum):
-    SUCCESS = 0
-    FAILED_RETRYABLE = 1
-    FAILED_NOT_RETRYABLE = 2
-
-
 class SpanExporter:
     """Interface for exporting spans.
 
@@ -42,7 +36,7 @@ class SpanExporter:
     `SimpleExportSpanProcessor` or a `BatchSpanProcessor`.
     """
 
-    def export(self, spans: typing.Sequence[Span]) -> "SpanExportResult":
+    def export(self, spans: typing.Sequence[Span]) -> "ExportResult":
         """Exports a batch of telemetry data.
 
         Args:
@@ -217,7 +211,7 @@ class ConsoleSpanExporter(SpanExporter):
     spans to the console STDOUT.
     """
 
-    def export(self, spans: typing.Sequence[Span]) -> SpanExportResult:
+    def export(self, spans: typing.Sequence[Span]) -> ExportResult:
         for span in spans:
             print(span)
-        return SpanExportResult.SUCCESS
+        return util.ExportResult.SUCCESS

opentelemetry-sdk/src/opentelemetry/sdk/trace/export/in_memory_span_exporter.py

@@ -16,7 +16,8 @@
 import typing
 
 from .. import Span
-from . import SpanExporter, SpanExportResult
+from . import SpanExporter
+from opentelemetry.sdk import util
 
 
 class InMemorySpanExporter(SpanExporter):
@@ -42,13 +43,13 @@ def get_finished_spans(self):
         with self._lock:
             return tuple(self._finished_spans)
 
-    def export(self, spans: typing.Sequence[Span]) -> SpanExportResult:
+    def export(self, spans: typing.Sequence[Span]) -> util.ExportResult:
         """Stores a list of spans in memory."""
         if self._stopped:
-            return SpanExportResult.FAILED_NOT_RETRYABLE
+            return util.ExportResult.FAILED_NOT_RETRYABLE
         with self._lock:
             self._finished_spans.extend(spans)
-        return SpanExportResult.SUCCESS
+        return util.ExportResult.SUCCESS
 
     def shutdown(self):
         """Shut downs the exporter.

opentelemetry-sdk/src/opentelemetry/sdk/util.py

@@ -16,6 +16,7 @@
 import threading
 import time
 from collections import OrderedDict, deque
+from enum import Enum
 
 try:
     # pylint: disable=ungrouped-imports
@@ -141,3 +142,9 @@ def from_map(cls, maxlen, mapping):
         # pylint: disable=protected-access
         bounded_dict._dict = mapping
         return bounded_dict
+
+
+class ExportResult(Enum):
+    SUCCESS = 0
+    FAILED_RETRYABLE = 1
+    FAILED_NOT_RETRYABLE = 2

opentelemetry-sdk/tests/trace/export/test_export.py

@@ -19,6 +19,7 @@
 from opentelemetry import trace as trace_api
 from opentelemetry.sdk import trace
 from opentelemetry.sdk.trace import export
+from opentelemetry.sdk.util import ExportResult
 
 
 class MySpanExporter(export.SpanExporter):
@@ -28,14 +29,14 @@ def __init__(self, destination, max_export_batch_size=None):
         self.destination = destination
         self.max_export_batch_size = max_export_batch_size
 
-    def export(self, spans: trace.Span) -> export.SpanExportResult:
+    def export(self, spans: trace.Span) -> ExportResult:
         if (
             self.max_export_batch_size is not None
             and len(spans) > self.max_export_batch_size
         ):
             raise ValueError("Batch is too big")
         self.destination.extend(span.name for span in spans)
-        return export.SpanExportResult.SUCCESS
+        return ExportResult.SUCCESS
 
 
 class TestSimpleExportSpanProcessor(unittest.TestCase):