Logging the literal string "None" is silently dropped (payload becomes empty)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 85/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- python
- Domain
- observability
Research direction
Start in google/cloud/logging_v2/handlers/handlers.py at _format_and_parse_message, then run the provided LogRecord reproduction for "None", "hello", and "". Done means the literal string "None" remains in the parsed payload while the existing cases retain their expected results.
Written by the indexing model from the issue text.
Description
- I determined this is the correct repository in which to report this bug.
Summary of the issue
Context
Using CloudLoggingHandler / StructuredLogHandler via the Python standard logging module, I logged the string "None" (e.g. logging.getLogger().info("None")).
Expected Behavior:
The log entry payload should contain the text "None", just like any other string.
Actual Behavior:
The message is silently dropped: the parsed payload becomes None (empty), so the log content disappears.
API client name and version
google-cloud-logging v3.15.0 (also present on current main)
Reproduction steps: code
import logging
from google.cloud.logging_v2.handlers import handlers as H
class FakeHandler(logging.Handler):
pass
h = FakeHandler()
h.setFormatter(logging.Formatter())
def rec(msg):
return logging.LogRecord("n", logging.INFO, "p", 1, msg, (), None)
for msg in ["None", "hello", ""]:
print(repr(msg), "->", repr(H._format_and_parse_message(rec(msg), h)))
Reproduction steps: actual results
'None' -> None # the user's message is dropped
'hello' -> 'hello'
'' -> ''
Reproduction steps: expected results
'None' -> 'None' # the literal string should be preserved
'hello' -> 'hello'
'' -> ''
OS & version + platform
Any (logic bug, platform-independent)
Python environment
Python 3.12
Additional context
Root cause in google/cloud/logging_v2/handlers/handlers.py (_format_and_parse_message):
if message != "None":
passed_json_fields["message"] = message
...
return message if message != "None" else None
The intent appears to be detecting a record whose msg is the Python object None (which logging.Formatter renders as the string "None"). But comparing the formatted string against "None" also matches a legitimate user message of the literal text "None", dropping it. Detecting emptiness from record.msg is None (before formatting) rather than from the formatted output would avoid the false positive.
- Dominant language
- Python
- Stars
- 5.4k
- Forks
- 1.8k
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 93
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from googleapis/google-cloud-python
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
googleapis/google-cloud-python#18428 ·
-
priority: p2 type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
googleapis/google-cloud-python#18375 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 76/100
googleapis/google-cloud-python#18339 ·
-
auth priority: p2
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
googleapis/google-cloud-python#18315 ·
-
priority: p2 type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
googleapis/google-cloud-python#18260 ·
All issues in googleapis/google-cloud-python
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100