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
|
# Copyright The OpenTelemetry Authors
#
# 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.
# type: ignore
from logging import WARNING
from unittest import TestCase
from unittest.mock import Mock, patch
from opentelemetry.metrics import Meter, NoOpMeter
# FIXME Test that the meter methods can be called concurrently safely.
class ChildMeter(Meter):
# pylint: disable=signature-differs
def create_counter(self, name, unit="", description=""):
super().create_counter(name, unit=unit, description=description)
def create_up_down_counter(self, name, unit="", description=""):
super().create_up_down_counter(
name, unit=unit, description=description
)
def create_observable_counter(
self, name, callbacks, unit="", description=""
):
super().create_observable_counter(
name,
callbacks,
unit=unit,
description=description,
)
def create_histogram(
self,
name,
unit="",
description="",
*,
explicit_bucket_boundaries_advisory=None,
):
super().create_histogram(
name,
unit=unit,
description=description,
explicit_bucket_boundaries_advisory=explicit_bucket_boundaries_advisory,
)
def create_gauge(self, name, unit="", description=""):
super().create_gauge(name, unit=unit, description=description)
def create_observable_gauge(
self, name, callbacks, unit="", description=""
):
super().create_observable_gauge(
name,
callbacks,
unit=unit,
description=description,
)
def create_observable_up_down_counter(
self, name, callbacks, unit="", description=""
):
super().create_observable_up_down_counter(
name,
callbacks,
unit=unit,
description=description,
)
class TestMeter(TestCase):
# pylint: disable=no-member
# TODO: convert to assertNoLogs instead of mocking logger when 3.10 is baseline
@patch("opentelemetry.metrics._internal._logger")
def test_repeated_instrument_names(self, logger_mock):
try:
test_meter = NoOpMeter("name")
test_meter.create_counter("counter")
test_meter.create_up_down_counter("up_down_counter")
test_meter.create_observable_counter("observable_counter", Mock())
test_meter.create_histogram("histogram")
test_meter.create_gauge("gauge")
test_meter.create_observable_gauge("observable_gauge", Mock())
test_meter.create_observable_up_down_counter(
"observable_up_down_counter", Mock()
)
except Exception as error: # pylint: disable=broad-exception-caught
self.fail(f"Unexpected exception raised {error}")
for instrument_name in [
"counter",
"up_down_counter",
"histogram",
"gauge",
]:
getattr(test_meter, f"create_{instrument_name}")(instrument_name)
logger_mock.warning.assert_not_called()
for instrument_name in [
"observable_counter",
"observable_gauge",
"observable_up_down_counter",
]:
getattr(test_meter, f"create_{instrument_name}")(
instrument_name, Mock()
)
logger_mock.warning.assert_not_called()
def test_repeated_instrument_names_with_different_advisory(self):
try:
test_meter = NoOpMeter("name")
test_meter.create_histogram(
"histogram", explicit_bucket_boundaries_advisory=[1.0]
)
except Exception as error: # pylint: disable=broad-exception-caught
self.fail(f"Unexpected exception raised {error}")
for instrument_name in [
"histogram",
]:
with self.assertLogs(level=WARNING):
getattr(test_meter, f"create_{instrument_name}")(
instrument_name,
)
def test_create_counter(self):
"""
Test that the meter provides a function to create a new Counter
"""
self.assertTrue(hasattr(Meter, "create_counter"))
self.assertTrue(Meter.create_counter.__isabstractmethod__)
def test_create_up_down_counter(self):
"""
Test that the meter provides a function to create a new UpDownCounter
"""
self.assertTrue(hasattr(Meter, "create_up_down_counter"))
self.assertTrue(Meter.create_up_down_counter.__isabstractmethod__)
def test_create_observable_counter(self):
"""
Test that the meter provides a function to create a new ObservableCounter
"""
self.assertTrue(hasattr(Meter, "create_observable_counter"))
self.assertTrue(Meter.create_observable_counter.__isabstractmethod__)
def test_create_histogram(self):
"""
Test that the meter provides a function to create a new Histogram
"""
self.assertTrue(hasattr(Meter, "create_histogram"))
self.assertTrue(Meter.create_histogram.__isabstractmethod__)
def test_create_gauge(self):
"""
Test that the meter provides a function to create a new Gauge
"""
self.assertTrue(hasattr(Meter, "create_gauge"))
def test_create_observable_gauge(self):
"""
Test that the meter provides a function to create a new ObservableGauge
"""
self.assertTrue(hasattr(Meter, "create_observable_gauge"))
self.assertTrue(Meter.create_observable_gauge.__isabstractmethod__)
def test_create_observable_up_down_counter(self):
"""
Test that the meter provides a function to create a new
ObservableUpDownCounter
"""
self.assertTrue(hasattr(Meter, "create_observable_up_down_counter"))
self.assertTrue(
Meter.create_observable_up_down_counter.__isabstractmethod__
)
|