logging: StructuredLogHandler writes invalid JSON when trace or span_id contains " or \

Aperta Adatta ai principianti
#19,099 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
68/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
backend

Direzione di ricerca

L’issue indica packages/google-cloud-logging/google/cloud/logging_v2/handlers/structured_log.py e handlers.py; inizia leggendo come StructuredLogHandler formatta e filtra i valori di trace e span. Riproduci l’errore con l’esempio fornito di filter() e format(), quindi controlla i test pertinenti dell’handler. Il lavoro è terminato quando l’output formattato può essere analizzato come JSON e conserva le stringhe di trace e span contenenti virgolette o barre rovesciate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
5.4k
Fork
1.8k
Merge medio
2g 20h
PR unite (30g)
140

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di googleapis/google-cloud-python

Tutte le issue di googleapis/google-cloud-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.