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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
import os
import platform
import shutil
import unittest
from unittest import mock
# pylint: disable=import-error
from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.sdk import _logs
from opentelemetry.sdk.util.instrumentation import InstrumentationScope
from opentelemetry.sdk.resources import Resource
from opentelemetry.sdk._logs.export import LogExportResult
from opentelemetry.sdk._logs.severity import SeverityNumber
from azure.monitor.opentelemetry.exporter.export._base import ExportResult
from azure.monitor.opentelemetry.exporter.export.logs._exporter import (
AzureMonitorLogExporter,
_get_log_export_result,
_get_severity_level,
)
from azure.monitor.opentelemetry.exporter._utils import (
azure_monitor_context,
ns_to_iso_str,
)
def throw(exc_type, *args, **kwargs):
def func(*_args, **_kwargs):
raise exc_type(*args, **kwargs)
return func
# pylint: disable=import-error
# pylint: disable=protected-access
# pylint: disable=too-many-lines
class TestAzureLogExporter(unittest.TestCase):
@classmethod
def setUpClass(cls):
os.environ.clear()
os.environ[
"APPINSIGHTS_INSTRUMENTATIONKEY"
] = "1234abcd-5678-4efa-8abc-1234567890ab"
os.environ["APPLICATIONINSIGHTS_STATSBEAT_DISABLED_ALL"] = "true"
cls._exporter = AzureMonitorLogExporter()
cls._log_data = _logs.LogData(
_logs.LogRecord(
timestamp = 1646865018558419456,
trace_id = 125960616039069540489478540494783893221,
span_id = 2909973987304607650,
severity_text = "WARNING",
trace_flags = None,
severity_number = SeverityNumber.WARN,
body = "Test message",
resource = Resource.create(
attributes={"asd":"test_resource"}
),
attributes={
"test": "attribute"
},
),
InstrumentationScope("test_name"),
)
cls._exc_data = _logs.LogData(
_logs.LogRecord(
timestamp = 1646865018558419456,
trace_id = 125960616039069540489478540494783893221,
span_id = 2909973987304607650,
severity_text = "EXCEPTION",
trace_flags = None,
severity_number = SeverityNumber.FATAL,
body = "Test message",
resource = Resource.create(
attributes={"asd":"test_resource"}
),
attributes={
"test": "attribute",
SpanAttributes.EXCEPTION_TYPE: "ZeroDivisionError",
SpanAttributes.EXCEPTION_MESSAGE: "division by zero",
SpanAttributes.EXCEPTION_STACKTRACE: 'Traceback (most recent call last):\n File "test.py", line 38, in <module>\n raise ZeroDivisionError()\nZeroDivisionError\n'
},
),
InstrumentationScope("test_name"),
)
@classmethod
def tearDownClass(cls):
shutil.rmtree(cls._exporter.storage._path, True)
def test_constructor(self):
"""Test the constructor."""
exporter = AzureMonitorLogExporter(
connection_string="InstrumentationKey=4321abcd-5678-4efa-8abc-1234567890ab",
)
self.assertEqual(
exporter._instrumentation_key,
"4321abcd-5678-4efa-8abc-1234567890ab",
)
def test_from_connection_string(self):
exporter = AzureMonitorLogExporter.from_connection_string(
"InstrumentationKey=4321abcd-5678-4efa-8abc-1234567890ab"
)
self.assertTrue(isinstance(exporter, AzureMonitorLogExporter))
self.assertEqual(
exporter._instrumentation_key,
"4321abcd-5678-4efa-8abc-1234567890ab",
)
def test_export_empty(self):
exporter = self._exporter
result = exporter.export([])
self.assertEqual(result, LogExportResult.SUCCESS)
def test_export_failure(self):
exporter = self._exporter
with mock.patch(
"azure.monitor.opentelemetry.exporter.AzureMonitorLogExporter._transmit"
) as transmit: # noqa: E501
transmit.return_value = ExportResult.FAILED_RETRYABLE
storage_mock = mock.Mock()
exporter.storage.put = storage_mock
result = exporter.export([self._log_data])
self.assertEqual(result, LogExportResult.FAILURE)
self.assertEqual(storage_mock.call_count, 1)
def test_export_success(self):
exporter = self._exporter
with mock.patch(
"azure.monitor.opentelemetry.exporter.AzureMonitorLogExporter._transmit"
) as transmit: # noqa: E501
transmit.return_value = ExportResult.SUCCESS
storage_mock = mock.Mock()
exporter._transmit_from_storage = storage_mock
result = exporter.export([self._log_data])
self.assertEqual(result, LogExportResult.SUCCESS)
self.assertEqual(storage_mock.call_count, 1)
@mock.patch("azure.monitor.opentelemetry.exporter.export.logs._exporter._logger")
def test_export_exception(self, logger_mock):
exporter = self._exporter
with mock.patch(
"azure.monitor.opentelemetry.exporter.AzureMonitorLogExporter._transmit",
throw(Exception),
): # noqa: E501
result = exporter.export([self._log_data])
self.assertEqual(result, LogExportResult.FAILURE)
self.assertEqual(logger_mock.exception.called, True)
def test_export_not_retryable(self):
exporter = self._exporter
with mock.patch(
"azure.monitor.opentelemetry.exporter.AzureMonitorLogExporter._transmit"
) as transmit: # noqa: E501
transmit.return_value = ExportResult.FAILED_NOT_RETRYABLE
result = exporter.export([self._log_data])
self.assertEqual(result, LogExportResult.FAILURE)
def test_log_to_envelope_partA(self):
exporter = self._exporter
old_resource = self._log_data.log_record.resource
resource = Resource(
{"service.name": "testServiceName",
"service.namespace": "testServiceNamespace",
"service.instance.id": "testServiceInstanceId"})
self._log_data.log_record.resource = resource
envelope = exporter._log_to_envelope(self._log_data)
self.assertEqual(envelope.instrumentation_key,
"1234abcd-5678-4efa-8abc-1234567890ab")
self.assertIsNotNone(envelope.tags)
self.assertEqual(envelope.tags.get("ai.device.id"), azure_monitor_context["ai.device.id"])
self.assertEqual(envelope.tags.get("ai.device.locale"), azure_monitor_context["ai.device.locale"])
self.assertEqual(envelope.tags.get("ai.device.osVersion"), azure_monitor_context["ai.device.osVersion"])
self.assertEqual(envelope.tags.get("ai.device.type"), azure_monitor_context["ai.device.type"])
self.assertEqual(envelope.tags.get("ai.internal.sdkVersion"), azure_monitor_context["ai.internal.sdkVersion"])
self.assertEqual(envelope.tags.get("ai.cloud.role"), "testServiceNamespace.testServiceName")
self.assertEqual(envelope.tags.get("ai.cloud.roleInstance"), "testServiceInstanceId")
self.assertEqual(envelope.tags.get("ai.internal.nodeName"), "testServiceInstanceId")
trace_id = self._log_data.log_record.trace_id
self.assertEqual(envelope.tags.get("ai.operation.id"), "{:032x}".format(trace_id))
span_id = self._log_data.log_record.span_id
self.assertEqual(envelope.tags.get("ai.operation.parentId"), "{:016x}".format(span_id))
self._log_data.log_record.resource = old_resource
def test_log_to_envelope_partA_default(self):
exporter = self._exporter
old_resource = self._log_data.log_record.resource
resource = Resource(
{"service.name": "testServiceName"})
self._log_data.log_record.resource = resource
envelope = exporter._log_to_envelope(self._log_data)
self.assertEqual(envelope.tags.get("ai.cloud.role"), "testServiceName")
self.assertEqual(envelope.tags.get("ai.cloud.roleInstance"), platform.node())
self.assertEqual(envelope.tags.get("ai.internal.nodeName"), envelope.tags.get("ai.cloud.roleInstance"))
self._log_data.log_record.resource = old_resource
def test_log_to_envelope_log(self):
exporter = self._exporter
envelope = exporter._log_to_envelope(self._log_data)
record = self._log_data.log_record
self.assertEqual(envelope.name, 'Microsoft.ApplicationInsights.Message')
self.assertEqual(envelope.time, ns_to_iso_str(record.timestamp))
self.assertEqual(envelope.data.base_type, 'MessageData')
self.assertEqual(envelope.data.base_data.message, record.body)
self.assertEqual(envelope.data.base_data.severity_level, 2)
self.assertEqual(envelope.data.base_data.properties["test"], "attribute")
def test_log_to_envelope_exception(self):
exporter = self._exporter
envelope = exporter._log_to_envelope(self._exc_data)
record = self._log_data.log_record
self.assertEqual(envelope.name, 'Microsoft.ApplicationInsights.Exception')
self.assertEqual(envelope.time, ns_to_iso_str(record.timestamp))
self.assertEqual(envelope.data.base_type, 'ExceptionData')
self.assertEqual(envelope.data.base_data.severity_level, 4)
self.assertEqual(envelope.data.base_data.properties["test"], "attribute")
self.assertEqual(len(envelope.data.base_data.exceptions), 1)
self.assertEqual(envelope.data.base_data.exceptions[0].type_name, "ZeroDivisionError")
self.assertEqual(envelope.data.base_data.exceptions[0].message, "division by zero")
self.assertTrue(envelope.data.base_data.exceptions[0].has_full_stack)
self.assertEqual(envelope.data.base_data.exceptions[0].stack, 'Traceback (most recent call last):\n File "test.py", line 38, in <module>\n raise ZeroDivisionError()\nZeroDivisionError\n')
class TestAzureLogExporterUtils(unittest.TestCase):
def test_get_log_export_result(self):
self.assertEqual(
_get_log_export_result(ExportResult.SUCCESS),
LogExportResult.SUCCESS,
)
self.assertEqual(
_get_log_export_result(ExportResult.FAILED_NOT_RETRYABLE),
LogExportResult.FAILURE,
)
self.assertEqual(
_get_log_export_result(ExportResult.FAILED_RETRYABLE),
LogExportResult.FAILURE,
)
self.assertEqual(_get_log_export_result(None), None)
def test_get_severity_level(self):
for sev_num in SeverityNumber:
num = sev_num.value
level = _get_severity_level(sev_num)
print(num)
if num in range(0,9):
self.assertEqual(level, 0)
elif num in range(9,13):
self.assertEqual(level, 1)
elif num in range(13,17):
self.assertEqual(level, 2)
elif num in range(17,21):
self.assertEqual(level, 3)
else:
self.assertEqual(level, 4)
|
