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
198
199
200
201
202
|
# 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.
# pylint:disable=protected-access,no-self-use,no-member
import logging
import threading
import time
import unittest
from abc import ABC, abstractmethod
from unittest.mock import Mock
from opentelemetry._logs import LogRecord, SeverityNumber
from opentelemetry.sdk._logs._internal import (
ConcurrentMultiLogRecordProcessor,
LoggerProvider,
LoggingHandler,
LogRecordProcessor,
ReadWriteLogRecord,
SynchronousMultiLogRecordProcessor,
)
class AnotherLogRecordProcessor(LogRecordProcessor):
def __init__(self, exporter, logs_list):
self._exporter = exporter
self._log_list = logs_list
self._closed = False
def on_emit(self, log_record: ReadWriteLogRecord):
if self._closed:
return
self._log_list.append(
(
log_record.log_record.body,
log_record.log_record.severity_text,
)
)
def shutdown(self):
self._closed = True
self._exporter.shutdown()
def force_flush(self, timeout_millis=30000):
self._log_list.clear()
return True
class TestLogRecordProcessor(unittest.TestCase):
def test_log_record_processor(self):
provider = LoggerProvider()
handler = LoggingHandler(logger_provider=provider)
logs_list_1 = []
processor1 = AnotherLogRecordProcessor(Mock(), logs_list_1)
logs_list_2 = []
processor2 = AnotherLogRecordProcessor(Mock(), logs_list_2)
logger = logging.getLogger("test.span.processor")
logger.addHandler(handler)
# Test no proessor added
with self.assertLogs(level=logging.CRITICAL):
logger.critical("Odisha, we have another major cyclone")
self.assertEqual(len(logs_list_1), 0)
self.assertEqual(len(logs_list_2), 0)
# Add one processor
provider.add_log_record_processor(processor1)
with self.assertLogs(level=logging.WARNING):
logger.warning("Brace yourself")
with self.assertLogs(level=logging.ERROR):
logger.error("Some error message")
expected_list_1 = [
("Brace yourself", "WARN"),
("Some error message", "ERROR"),
]
self.assertEqual(logs_list_1, expected_list_1)
# Add another processor
provider.add_log_record_processor(processor2)
with self.assertLogs(level=logging.CRITICAL):
logger.critical("Something disastrous")
expected_list_1.append(("Something disastrous", "CRITICAL"))
expected_list_2 = [("Something disastrous", "CRITICAL")]
self.assertEqual(logs_list_1, expected_list_1)
self.assertEqual(logs_list_2, expected_list_2)
class MultiLogRecordProcessorTestBase(ABC):
@abstractmethod
def _get_multi_log_record_processor(self):
pass
def make_record(self):
return ReadWriteLogRecord(
LogRecord(
timestamp=1622300111608942000,
severity_text="WARN",
severity_number=SeverityNumber.WARN,
body="Warning message",
)
)
def test_on_emit(self):
multi_log_record_processor = self._get_multi_log_record_processor()
mocks = [Mock(spec=LogRecordProcessor) for _ in range(5)]
for mock in mocks:
multi_log_record_processor.add_log_record_processor(mock)
record = self.make_record()
multi_log_record_processor.on_emit(record)
for mock in mocks:
mock.on_emit.assert_called_with(record)
multi_log_record_processor.shutdown()
def test_on_shutdown(self):
multi_log_record_processor = self._get_multi_log_record_processor()
mocks = [Mock(spec=LogRecordProcessor) for _ in range(5)]
for mock in mocks:
multi_log_record_processor.add_log_record_processor(mock)
multi_log_record_processor.shutdown()
for mock in mocks:
mock.shutdown.assert_called_once_with()
def test_on_force_flush(self):
multi_log_record_processor = self._get_multi_log_record_processor()
mocks = [Mock(spec=LogRecordProcessor) for _ in range(5)]
for mock in mocks:
multi_log_record_processor.add_log_record_processor(mock)
ret_value = multi_log_record_processor.force_flush(100)
self.assertTrue(ret_value)
for mock_processor in mocks:
self.assertEqual(1, mock_processor.force_flush.call_count)
class TestSynchronousMultiLogRecordProcessor(
MultiLogRecordProcessorTestBase, unittest.TestCase
):
def _get_multi_log_record_processor(self):
return SynchronousMultiLogRecordProcessor()
def test_force_flush_delayed(self):
multi_log_record_processor = SynchronousMultiLogRecordProcessor()
def delay(_):
time.sleep(0.09)
mock_processor1 = Mock(spec=LogRecordProcessor)
mock_processor1.force_flush = Mock(side_effect=delay)
multi_log_record_processor.add_log_record_processor(mock_processor1)
mock_processor2 = Mock(spec=LogRecordProcessor)
multi_log_record_processor.add_log_record_processor(mock_processor2)
ret_value = multi_log_record_processor.force_flush(50)
self.assertFalse(ret_value)
self.assertEqual(mock_processor1.force_flush.call_count, 1)
self.assertEqual(mock_processor2.force_flush.call_count, 0)
class TestConcurrentMultiLogRecordProcessor(
MultiLogRecordProcessorTestBase, unittest.TestCase
):
def _get_multi_log_record_processor(self):
return ConcurrentMultiLogRecordProcessor()
def test_force_flush_delayed(self):
multi_log_record_processor = ConcurrentMultiLogRecordProcessor()
wait_event = threading.Event()
def delay(_):
wait_event.wait()
mock1 = Mock(spec=LogRecordProcessor)
mock1.force_flush = Mock(side_effect=delay)
mocks = [Mock(LogRecordProcessor) for _ in range(5)]
mocks = [mock1] + mocks
for mock_processor in mocks:
multi_log_record_processor.add_log_record_processor(mock_processor)
ret_value = multi_log_record_processor.force_flush(50)
wait_event.set()
self.assertFalse(ret_value)
for mock in mocks:
self.assertEqual(1, mock.force_flush.call_count)
multi_log_record_processor.shutdown()
|
