logging: StructuredLogHandler writes invalid JSON when trace or span_id contains " or \
Maintainer antworten meist innerhalb von 2 Tagen
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 68/100
Rechercherichtung
Der Issue verweist auf packages/google-cloud-logging/google/cloud/logging_v2/handlers/structured_log.py und handlers.py; lies zunächst nach, wie StructuredLogHandler Trace- und Span-Werte formatiert und filtert. Reproduziere den Fehler mit dem bereitgestellten Beispiel für filter() und format() und prüfe anschließend die relevanten Handler-Tests. Das Ziel ist erreicht, wenn sich die formatierte Ausgabe als JSON parsen lässt und Trace- und Span-Zeichenfolgen mit Anführungszeichen oder Backslashes erhalten bleiben.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Determine this is the right repository
- I determined this is the correct repository in which to report this bug.
Summary of the issue
StructuredLogHandler writes invalid JSON when a trace or span id contains " or \. Its format string puts %(_trace_str)s and %(_span_id_str)s inside JSON quotes (structured_log.py#L33), and the filter copies the raw values (handlers.py#L111) without JSON escaping. The handler's own X-Cloud-Trace-Context parser accepts only [\w-]+ (_helpers.py#L195), so the default path is safe. Values set explicitly (extra={"trace": ...}, a logging filter, a framework integration) go into the line as-is, and Cloud Logging receives one broken text line instead of a structured entry.
Expected: valid JSON with both strings preserved. Actual: json.loads fails (Expecting ',' delimiter for the quote, Invalid \escape for the backslash).
API client name and version
google-cloud-logging 3.17.0 (also 3.12.1)
Reproduction steps: code
No client, credentials or network: only filter() and format() run.
"""Explicit trace/span strings must round-trip through structured JSON logging."""
import json
import logging
import sys
import traceback
from importlib.metadata import version
control = True
try:
print("google-cloud-logging", version("google-cloud-logging"), flush=True)
from google.cloud.logging_v2.handlers import StructuredLogHandler
handler = StructuredLogHandler()
def encode(trace_value, span_value):
record = logging.LogRecord("repro", logging.INFO, "repro.py", 1, "hello", (), None)
record.trace = trace_value
record.span_id = span_value
assert handler.filter(record)
return handler.format(record) # No emit(), client, credentials, or network.
trace_key = "logging.googleapis.com/trace"
span_key = "logging.googleapis.com/spanId"
decoded = json.loads(encode("projects/p/traces/abc", "123"))
assert decoded[trace_key] == "projects/p/traces/abc" and decoded[span_key] == "123"
print("CONTROL PASSED: plain trace/span values round-trip through valid JSON")
control = False
failures = []
for label, trace_value, span_value in (
("trace quote", 'projects/p/traces/a"b', "123"),
("span backslash", "projects/p/traces/abc", r"bad\span"),
):
try:
decoded = json.loads(encode(trace_value, span_value))
except json.JSONDecodeError as error:
failures.append(f"{label}: {error.msg}")
else:
if decoded[trace_key] != trace_value or decoded[span_key] != span_value:
failures.append(f"{label}: value corrupted")
handler.close()
prefix = "BUG REPRODUCED: " if failures else "NOT REPRODUCED: "
print(prefix + f"escaping failures={failures}; expected valid JSON preserving both strings")
except Exception:
traceback.print_exc()
if control:
print("CONTROL FAILED")
sys.exit(2 if control else 1)
Output:
google-cloud-logging 3.17.0
CONTROL PASSED: plain trace/span values round-trip through valid JSON
BUG REPRODUCED: escaping failures=["trace quote: Expecting ',' delimiter", 'span backslash: Invalid \\escape']; expected valid JSON preserving both strings
OS & version + platform
Linux
Python environment
Python 3.11
Additional context
Escaping these two fields like the message (json.dumps(value)[1:-1]) would fix it, or validating them against the same pattern the header parser uses.
- Vorherrschende Sprache
- Python
- Sterne
- 5.4k
- Forks
- 1.8k
- Ø Merge
- 2 T. 20 Std.
- Gemergte PRs (30 T.)
- 140
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus googleapis/google-cloud-python
-
firestore: field path with a quoted name ending in a backslash is misparsedEvtl. vergeben @sebxt hat das vor 28 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
googleapis/google-cloud-python#18771 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
api: spanner type: feature request
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
googleapis/google-cloud-python#18584 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
auth: `impersonated_credentials` loses `subject` on copy, so `with_scopes()` and `with_quota_project()` turn off domain wide delegationEvtl. vergeben @Om-singhaI hat das vor 57 Tagen übernommen. Offenauth priority: p2 type: bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
googleapis/google-cloud-python#18428 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
A client called `run_in_transaction` be stuck if Spanner is downEvtl. vergeben @founderinaction hat das vor 10 Tagen übernommen. Offenpriority: p2 type: bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
googleapis/google-cloud-python#18375 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 2 Tagen
-
ci: enable --strict flag in presubmit twine_checkEvtl. wieder frei @ohmayr hat das vor 47 Tagen übernommen, und es ist kein Pull Request offen. Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 76/100
googleapis/google-cloud-python#18339 · 1 Kommentar · 1 zugewiesene Person ·
Maintainer antworten meist innerhalb von 2 Tagen
Alle Issues in googleapis/google-cloud-python
Ähnliche Issues
-
area-templates triage:bot-seen triage:needs-human
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
microsoft/aspire#22356 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
[Train] An elastic ScalingConfig(num_workers=(0, 0)) is accepted and the run waits foreverEvtl. vergeben @wguo7 hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
ray-project/ray#68217 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
PairwiseComparisonEvaluator records A when a judge's final verdict is B or C after mentioning [[A]]Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
run-llama/llama_index#24279 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
area:docs good first issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
On PyPy, _has_type against an abstract base class lets a metaclass's own exception out of a refusalOffen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
btclib-org/btclib#3139 ·
Maintainer antworten meist innerhalb von 1 Tag