add unit tests for exemplarfilter, exemplarreservoir, and reservoirfactory

Author: czhang771

opentelemetry-sdk/tests/metrics/test_exemplarfilter.py

@@ -1,13 +1,15 @@
 from unittest import TestCase
 
+from opentelemetry import trace
 from opentelemetry.context import Context
+from opentelemetry.trace.span import SpanContext
+from opentelemetry.trace import TraceFlags
 from opentelemetry.sdk.metrics._internal.exemplar import (
     AlwaysOffExemplarFilter,
     AlwaysOnExemplarFilter,
     TraceBasedExemplarFilter,
 )
 
-
 class TestAlwaysOnExemplarFilter(TestCase):
     def test_should_sample(self):
         filter = AlwaysOnExemplarFilter()
@@ -21,8 +23,34 @@ def test_should_sample(self):
 
 
 class TestTraceBasedExemplarFilter(TestCase):
+    TRACE_ID = int("d4cda95b652f4a1592b449d5929fda1b", 16)
+    SPAN_ID = int("6e0c63257de34c92", 16)
     def test_should_not_sample_without_trace(self):
+        filter = TraceBasedExemplarFilter()
+        span_context = SpanContext(
+            trace_id=self.TRACE_ID, 
+            span_id=self.SPAN_ID,
+            is_remote=False,
+            trace_flags= TraceFlags(TraceFlags.DEFAULT),
+            trace_state={}
+        )
+        span = trace.NonRecordingSpan(span_context)
+        ctx = trace.set_span_in_context(span)
+        self.assertFalse(filter.should_sample(10, 0, {}, ctx))
+
+    def test_should_not_sample_with_invalid_span(self):
         filter = TraceBasedExemplarFilter()
         self.assertFalse(filter.should_sample(10, 0, {}, Context()))
-
-        # FIXME add test with trace that should sample
+    
+    def test_should_sample_when_trace_is_sampled(self):
+        filter = TraceBasedExemplarFilter()
+        span_context = SpanContext(
+            trace_id=self.TRACE_ID, 
+            span_id=self.SPAN_ID,
+            is_remote=False,
+            trace_flags= TraceFlags(TraceFlags.SAMPLED),
+            trace_state={}
+        )
+        span = trace.NonRecordingSpan(span_context)
+        ctx = trace.set_span_in_context(span)
+        self.assertTrue(filter.should_sample(10, 0, {}, ctx))

opentelemetry-sdk/tests/metrics/test_exemplarreservoir.py

@@ -0,0 +1,98 @@
+from unittest import TestCase
+
+#from opentelemetry.context import Context
+from opentelemetry.trace import INVALID_SPAN, SpanContext, TraceFlags
+from opentelemetry import trace
+from time import time_ns
+from opentelemetry.sdk.metrics._internal.view import default_reservoir_factory
+from opentelemetry.sdk.metrics._internal.exemplar import (
+    AlignedHistogramBucketExemplarReservoir,
+    ExemplarReservoir,
+    ExemplarReservoirFactory,
+    SimpleFixedSizeExemplarReservoir
+)
+from opentelemetry.sdk.metrics._internal.aggregation import (
+    _ExplicitBucketHistogramAggregation,
+    _LastValueAggregation,
+    _SumAggregation,
+)
+
+class TestSimpleFixedSizeExemplarReservoir(TestCase):
+    
+    TRACE_ID = int("d4cda95b652f4a1592b449d5929fda1b", 16)
+    SPAN_ID = int("6e0c63257de34c92", 16)
+
+    def test_no_measurements(self):
+        reservoir = SimpleFixedSizeExemplarReservoir(10)
+        self.assertEqual(len(reservoir.collect({})), 0)
+    
+    def test_has_context(self):
+        reservoir = SimpleFixedSizeExemplarReservoir(1)
+        span_context = SpanContext(
+            trace_id=self.TRACE_ID,
+            span_id=self.SPAN_ID,
+            is_remote=False,
+            trace_flags= TraceFlags(TraceFlags.SAMPLED),
+            trace_state={}
+        )
+        span = trace.NonRecordingSpan(span_context)
+        ctx = trace.set_span_in_context(span)
+        reservoir.offer(1, time_ns(), {}, ctx)
+        exemplars = reservoir.collect({})
+        self.assertEqual(len(exemplars), 1)
+        self.assertEqual(exemplars[0].trace_id, self.TRACE_ID)
+        self.assertEqual(exemplars[0].span_id, self.SPAN_ID)
+    
+    def test_filter_attributes(self):
+        reservoir = SimpleFixedSizeExemplarReservoir(1)
+        span_context = SpanContext(
+            trace_id=self.TRACE_ID,
+            span_id=self.SPAN_ID,
+            is_remote=False,
+            trace_flags= TraceFlags(TraceFlags.SAMPLED),
+            trace_state={}
+        )
+        span = trace.NonRecordingSpan(span_context)
+        ctx = trace.set_span_in_context(span)
+        reservoir.offer(1, time_ns(), {"key1": "value1", "key2": "value2"}, ctx)
+        exemplars = reservoir.collect({"key2": "value2", "key3": "value3"})
+        self.assertEqual(len(exemplars), 1)
+        self.assertNotEqual("key1", exemplars[0].filtered_attributes)
+
+class TestAlignedHistogramBucketExemplarReservoir(TestCase):
+    
+    TRACE_ID = int("d4cda95b652f4a1592b449d5929fda1b", 16)
+    SPAN_ID = int("6e0c63257de34c92", 16)
+    
+    def test_measurement_in_buckets(self):
+        reservoir = AlignedHistogramBucketExemplarReservoir([0, 5, 10, 25, 50, 75])
+        span_context = SpanContext(
+        trace_id=self.TRACE_ID,
+        span_id=self.SPAN_ID,
+        is_remote=False,
+        trace_flags= TraceFlags(TraceFlags.SAMPLED),
+        trace_state={}
+        )
+        span = trace.NonRecordingSpan(span_context)
+        ctx = trace.set_span_in_context(span)
+        reservoir.offer(52, time_ns(), {"bucket": "5"}, ctx)
+        reservoir.offer(7, time_ns(), {"bucket": "3"}, ctx)
+        reservoir.offer(6, time_ns(), {"bucket": "3"}, ctx)
+        exemplars = reservoir.collect({"bucket": "3"})
+        self.assertEqual(len(exemplars), 2)
+        self.assertEqual(exemplars[0].value, 6)            
+        self.assertEqual(exemplars[1].value, 52)
+        self.assertEqual(len(exemplars[0].filtered_attributes), 0)
+        self.assertNotEqual(exemplars[1].filtered_attributes, {"bucket": "5"})
+
+
+class TestExemplarReservoirFactory(TestCase):
+    def test_sum_aggregation(self):
+        exemplar_reservoir = default_reservoir_factory(_SumAggregation)
+        self.assertEqual(exemplar_reservoir, SimpleFixedSizeExemplarReservoir)
+    def test_last_value_aggregation(self):
+        exemplar_reservoir = default_reservoir_factory(_LastValueAggregation)
+        self.assertEqual(exemplar_reservoir, SimpleFixedSizeExemplarReservoir)
+    def test_explicit_histogram_aggregation(self):
+        exemplar_reservoir = default_reservoir_factory(_ExplicitBucketHistogramAggregation)
+        self.assertEqual(exemplar_reservoir, AlignedHistogramBucketExemplarReservoir)