diff --git a/changelogs/fragments/3496-callback_opentelemetry-enrich_stacktraces.yml b/changelogs/fragments/3496-callback_opentelemetry-enrich_stacktraces.yml new file mode 100644 index 0000000000..d273083b08 --- /dev/null +++ b/changelogs/fragments/3496-callback_opentelemetry-enrich_stacktraces.yml @@ -0,0 +1,2 @@ +minor_changes: + - opentelemetry callback plugin - enriched the stacktrace information with the ``message``, ``exception`` and ``stderr`` fields from the failed task (https://github.com/ansible-collections/community.general/pull/3496). diff --git a/plugins/callback/opentelemetry.py b/plugins/callback/opentelemetry.py index fe43743fdd..b48d22b049 100644 --- a/plugins/callback/opentelemetry.py +++ b/plugins/callback/opentelemetry.py @@ -241,15 +241,10 @@ class OpenTelemetrySource(object): res = host_data.result._result rc = res.get('rc', 0) if host_data.status == 'failed': - if res.get('exception') is not None: - message = res['exception'].strip().split('\n')[-1] - elif 'msg' in res: - message = res['msg'] - else: - message = 'failed' + message = self.get_error_message(res) status = Status(status_code=StatusCode.ERROR, description=message) # Record an exception with the task message - span.record_exception(BaseException(message)) + span.record_exception(BaseException(self.enrich_error_message(res))) elif host_data.status == 'skipped': if 'skip_reason' in res: message = res['skip_reason'] @@ -276,6 +271,24 @@ class OpenTelemetrySource(object): if attributeValue is not None: span.set_attribute(attributeName, attributeValue) + @staticmethod + def get_error_message(result): + if result.get('exception') is not None: + return OpenTelemetrySource._last_line(result['exception']) + return result.get('msg', 'failed') + + @staticmethod + def _last_line(text): + lines = text.strip().split('\n') + return lines[-1] + + @staticmethod + def enrich_error_message(result): + message = result.get('msg', 'failed') + exception = result.get('exception') + stderr = result.get('stderr') + return ('message: "{0}"\nexception: "{1}"\nstderr: "{2}"').format(message, exception, stderr) + class CallbackModule(CallbackBase): """ diff --git a/tests/unit/plugins/callback/test_opentelemetry.py b/tests/unit/plugins/callback/test_opentelemetry.py index 7fcfc5cddb..d7ff845bd2 100644 --- a/tests/unit/plugins/callback/test_opentelemetry.py +++ b/tests/unit/plugins/callback/test_opentelemetry.py @@ -91,3 +91,38 @@ class TestOpentelemetry(unittest.TestCase): self.assertEqual(host_data.uuid, 'include') self.assertEqual(host_data.name, 'include') self.assertEqual(host_data.status, 'ok') + + def test_get_error_message(self): + test_cases = ( + ('my-exception', 'my-msg', None, 'my-exception'), + (None, 'my-msg', None, 'my-msg'), + (None, None, None, 'failed'), + ) + + for tc in test_cases: + result = self.opentelemetry.get_error_message(generate_test_data(tc[0], tc[1], tc[2])) + self.assertEqual(result, tc[3]) + + def test_enrich_error_message(self): + test_cases = ( + ('my-exception', 'my-msg', 'my-stderr', 'message: "my-msg"\nexception: "my-exception"\nstderr: "my-stderr"'), + ('my-exception', None, 'my-stderr', 'message: "failed"\nexception: "my-exception"\nstderr: "my-stderr"'), + (None, 'my-msg', 'my-stderr', 'message: "my-msg"\nexception: "None"\nstderr: "my-stderr"'), + ('my-exception', 'my-msg', None, 'message: "my-msg"\nexception: "my-exception"\nstderr: "None"'), + ('my-exception', 'my-msg', '\nline1\nline2', 'message: "my-msg"\nexception: "my-exception"\nstderr: "\nline1\nline2"') + ) + + for tc in test_cases: + result = self.opentelemetry.enrich_error_message(generate_test_data(tc[0], tc[1], tc[2])) + self.assertEqual(result, tc[3]) + + +def generate_test_data(exception=None, msg=None, stderr=None): + res_data = OrderedDict() + if exception: + res_data['exception'] = exception + if msg: + res_data['msg'] = msg + if stderr: + res_data['stderr'] = stderr + return res_data