Skip to content

Handle "LogRecord.exc_info" being a string #4699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Handle "LogRecord.exc_info" being a string #4699

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b26ba45
:ambulance: Handle "LogRecord.exc_info" being a string
jourdanrodrigues Jul 25, 2025
c967cef
:umbrella: Assert exception properties
jourdanrodrigues Jul 25, 2025
6c43c32
:pencil: Undo unnecessary change
jourdanrodrigues Jul 25, 2025
b500d0f
:sparkles: Address linting and documentation issues
jourdanrodrigues Jul 29, 2025
a26437e
:books: Adhere to the changelog format
jourdanrodrigues Jul 29, 2025
020af24
Merge branch 'main' into logging-handler-exc-info-str
jourdanrodrigues Jul 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import concurrent.futures
import json
import logging
import sys
import threading
import traceback
import warnings
Expand Down Expand Up @@ -568,8 +569,12 @@ def _get_attributes(record: logging.LogRecord) -> _ExtendedAttributes:
attributes[code_attributes.CODE_FUNCTION_NAME] = record.funcName
attributes[code_attributes.CODE_LINE_NUMBER] = record.lineno

if isinstance(record.exc_info, str):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a comment here to explain the motivation?

Copy link
Author

@jourdanrodrigues jourdanrodrigues Jul 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't able to track down why nor how this happens (I tried as hard as I could), like if this was some misconfiguration in my work's project or some lib doing this, and I left such comment in the test that preserves this behavior.

Unfortunately, the only thing I know is that it can be a string and this fixed it in my case.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps a line explaining the motivation would help readers? Doesn't have to be specific, just that the check and overwrite are defensive, preventing errors in some implementations.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jourdanrodrigues are you setting any kind of logging.Filter in the LoggingHandler?

record.exc_info = sys.exc_info()

if record.exc_info:
exctype, value, tb = record.exc_info

if exctype is not None:
attributes[exception_attributes.EXCEPTION_TYPE] = (
exctype.__name__
Expand Down
15 changes: 15 additions & 0 deletions opentelemetry-sdk/tests/logs/test_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

import logging
import os
import sys
import unittest
from unittest.mock import Mock, patch

Expand Down Expand Up @@ -48,6 +49,20 @@ def test_handler_default_log_level(self):
logger.warning("Warning message")
self.assertEqual(processor.emit_count(), 1)

def test_handler_error_exc_info(self):
processor, logger = set_up_test_logging(logging.NOTSET)
exc_info_values = [
# Don't know what caused it in my context, so I'm relying on mocks to replicate the behavior.
# First the `record.exc_info` becomes a string somehow, then `sys.exc_info` brings the tuple.
"Stringified exception",
(None, None, None),
]

with patch.object(sys, "exc_info", side_effect=exc_info_values):
logger.exception("Exception message") # Should not raise exception

assert processor.emit_count() == 1

def test_handler_custom_log_level(self):
processor, logger = set_up_test_logging(logging.ERROR)

Expand Down