|
| 1 | +# Copyright (c) Microsoft Corporation. |
| 2 | +# Licensed under the MIT License. |
| 3 | + |
| 4 | +"""Unit tests for the OpenTelemetry span-noise filter.""" |
| 5 | + |
| 6 | +import os |
| 7 | +import sys |
| 8 | +from unittest.mock import MagicMock, patch |
| 9 | + |
| 10 | +sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "..", "ContentProcessorAPI"))) |
| 11 | + |
| 12 | +from app.utils.telemetry_filter import install_noise_filter # noqa: E402 |
| 13 | + |
| 14 | + |
| 15 | +@patch("app.utils.telemetry_filter.trace") |
| 16 | +def test_install_noise_filter_no_active_processor(mock_trace): |
| 17 | + """Early return when the provider has no _active_span_processor.""" |
| 18 | + mock_provider = MagicMock(spec=[]) # no attributes at all |
| 19 | + mock_trace.get_tracer_provider.return_value = mock_provider |
| 20 | + |
| 21 | + install_noise_filter(noisy_names=frozenset({"Foo"})) |
| 22 | + # Nothing to wrap, should return without error |
| 23 | + |
| 24 | + |
| 25 | +@patch("app.utils.telemetry_filter.trace") |
| 26 | +def test_install_noise_filter_wraps_inner_processors(mock_trace): |
| 27 | + """Wraps each processor in _span_processors tuple.""" |
| 28 | + inner_proc_1 = MagicMock() |
| 29 | + inner_proc_2 = MagicMock() |
| 30 | + |
| 31 | + active_proc = MagicMock() |
| 32 | + active_proc._span_processors = (inner_proc_1, inner_proc_2) |
| 33 | + |
| 34 | + mock_provider = MagicMock() |
| 35 | + mock_provider._active_span_processor = active_proc |
| 36 | + mock_trace.get_tracer_provider.return_value = mock_provider |
| 37 | + |
| 38 | + install_noise_filter( |
| 39 | + noisy_names=frozenset({"NoisySpan"}), |
| 40 | + noisy_suffixes=(".noisy",), |
| 41 | + ) |
| 42 | + |
| 43 | + # The tuple should have been replaced with wrapped processors |
| 44 | + assert len(active_proc._span_processors) == 2 |
| 45 | + # Each element should be a _Filter wrapping the original |
| 46 | + for wrapped in active_proc._span_processors: |
| 47 | + assert hasattr(wrapped, "_inner") |
| 48 | + |
| 49 | + |
| 50 | +@patch("app.utils.telemetry_filter.trace") |
| 51 | +def test_install_noise_filter_wraps_direct_processor(mock_trace): |
| 52 | + """Wraps the processor directly when _span_processors is absent.""" |
| 53 | + active_proc = MagicMock(spec=["on_start", "on_end", "shutdown", "force_flush"]) |
| 54 | + # No _span_processors attribute |
| 55 | + |
| 56 | + mock_provider = MagicMock() |
| 57 | + mock_provider._active_span_processor = active_proc |
| 58 | + mock_trace.get_tracer_provider.return_value = mock_provider |
| 59 | + |
| 60 | + install_noise_filter(noisy_names=frozenset({"NoisySpan"})) |
| 61 | + |
| 62 | + # Provider should now have a wrapped processor |
| 63 | + new_proc = mock_provider._active_span_processor |
| 64 | + assert hasattr(new_proc, "_inner") |
| 65 | + assert new_proc._inner is active_proc |
| 66 | + |
| 67 | + |
| 68 | +@patch("app.utils.telemetry_filter.trace") |
| 69 | +def test_filter_on_start_delegates(mock_trace): |
| 70 | + """_Filter.on_start delegates to the inner processor.""" |
| 71 | + inner_proc = MagicMock() |
| 72 | + active_proc = MagicMock() |
| 73 | + active_proc._span_processors = (inner_proc,) |
| 74 | + |
| 75 | + mock_provider = MagicMock() |
| 76 | + mock_provider._active_span_processor = active_proc |
| 77 | + mock_trace.get_tracer_provider.return_value = mock_provider |
| 78 | + |
| 79 | + install_noise_filter(noisy_names=frozenset({"NoisySpan"})) |
| 80 | + |
| 81 | + wrapped = active_proc._span_processors[0] |
| 82 | + mock_span = MagicMock() |
| 83 | + mock_context = MagicMock() |
| 84 | + wrapped.on_start(mock_span, mock_context) |
| 85 | + |
| 86 | + inner_proc.on_start.assert_called_once_with(mock_span, mock_context) |
| 87 | + |
| 88 | + |
| 89 | +@patch("app.utils.telemetry_filter.trace") |
| 90 | +def test_filter_on_end_drops_noisy_name(mock_trace): |
| 91 | + """_Filter.on_end drops spans whose name is in noisy_names.""" |
| 92 | + inner_proc = MagicMock() |
| 93 | + active_proc = MagicMock() |
| 94 | + active_proc._span_processors = (inner_proc,) |
| 95 | + |
| 96 | + mock_provider = MagicMock() |
| 97 | + mock_provider._active_span_processor = active_proc |
| 98 | + mock_trace.get_tracer_provider.return_value = mock_provider |
| 99 | + |
| 100 | + install_noise_filter(noisy_names=frozenset({"MsiToken.Refresh"})) |
| 101 | + |
| 102 | + wrapped = active_proc._span_processors[0] |
| 103 | + mock_span = MagicMock() |
| 104 | + mock_span.name = "MsiToken.Refresh" |
| 105 | + wrapped.on_end(mock_span) |
| 106 | + |
| 107 | + inner_proc.on_end.assert_not_called() |
| 108 | + |
| 109 | + |
| 110 | +@patch("app.utils.telemetry_filter.trace") |
| 111 | +def test_filter_on_end_drops_noisy_suffix(mock_trace): |
| 112 | + """_Filter.on_end drops spans whose name ends with a noisy suffix.""" |
| 113 | + inner_proc = MagicMock() |
| 114 | + active_proc = MagicMock() |
| 115 | + active_proc._span_processors = (inner_proc,) |
| 116 | + |
| 117 | + mock_provider = MagicMock() |
| 118 | + mock_provider._active_span_processor = active_proc |
| 119 | + mock_trace.get_tracer_provider.return_value = mock_provider |
| 120 | + |
| 121 | + install_noise_filter(noisy_suffixes=(" send", " receive")) |
| 122 | + |
| 123 | + wrapped = active_proc._span_processors[0] |
| 124 | + mock_span = MagicMock() |
| 125 | + mock_span.name = "ServiceBusReceiver receive" |
| 126 | + wrapped.on_end(mock_span) |
| 127 | + |
| 128 | + inner_proc.on_end.assert_not_called() |
| 129 | + |
| 130 | + |
| 131 | +@patch("app.utils.telemetry_filter.trace") |
| 132 | +def test_filter_on_end_passes_non_noisy(mock_trace): |
| 133 | + """_Filter.on_end passes through non-noisy spans.""" |
| 134 | + inner_proc = MagicMock() |
| 135 | + active_proc = MagicMock() |
| 136 | + active_proc._span_processors = (inner_proc,) |
| 137 | + |
| 138 | + mock_provider = MagicMock() |
| 139 | + mock_provider._active_span_processor = active_proc |
| 140 | + mock_trace.get_tracer_provider.return_value = mock_provider |
| 141 | + |
| 142 | + install_noise_filter( |
| 143 | + noisy_names=frozenset({"NoisySpan"}), |
| 144 | + noisy_suffixes=(".noisy",), |
| 145 | + ) |
| 146 | + |
| 147 | + wrapped = active_proc._span_processors[0] |
| 148 | + mock_span = MagicMock() |
| 149 | + mock_span.name = "ImportantOperation" |
| 150 | + wrapped.on_end(mock_span) |
| 151 | + |
| 152 | + inner_proc.on_end.assert_called_once_with(mock_span) |
| 153 | + |
| 154 | + |
| 155 | +@patch("app.utils.telemetry_filter.trace") |
| 156 | +def test_filter_shutdown_delegates(mock_trace): |
| 157 | + """_Filter.shutdown delegates to the inner processor.""" |
| 158 | + inner_proc = MagicMock() |
| 159 | + active_proc = MagicMock() |
| 160 | + active_proc._span_processors = (inner_proc,) |
| 161 | + |
| 162 | + mock_provider = MagicMock() |
| 163 | + mock_provider._active_span_processor = active_proc |
| 164 | + mock_trace.get_tracer_provider.return_value = mock_provider |
| 165 | + |
| 166 | + install_noise_filter(noisy_names=frozenset()) |
| 167 | + |
| 168 | + wrapped = active_proc._span_processors[0] |
| 169 | + wrapped.shutdown() |
| 170 | + |
| 171 | + inner_proc.shutdown.assert_called_once() |
| 172 | + |
| 173 | + |
| 174 | +@patch("app.utils.telemetry_filter.trace") |
| 175 | +def test_filter_force_flush_delegates(mock_trace): |
| 176 | + """_Filter.force_flush delegates to the inner processor.""" |
| 177 | + inner_proc = MagicMock() |
| 178 | + active_proc = MagicMock() |
| 179 | + active_proc._span_processors = (inner_proc,) |
| 180 | + |
| 181 | + mock_provider = MagicMock() |
| 182 | + mock_provider._active_span_processor = active_proc |
| 183 | + mock_trace.get_tracer_provider.return_value = mock_provider |
| 184 | + |
| 185 | + install_noise_filter(noisy_names=frozenset()) |
| 186 | + |
| 187 | + wrapped = active_proc._span_processors[0] |
| 188 | + wrapped.force_flush(timeout_millis=5000) |
| 189 | + |
| 190 | + inner_proc.force_flush.assert_called_once_with(5000) |
0 commit comments