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

Abierto Apto para principiantes
#19,099 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
68/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
backend

Línea de trabajo

El issue señala packages/google-cloud-logging/google/cloud/logging_v2/handlers/structured_log.py y handlers.py; empieza leyendo cómo StructuredLogHandler da formato y filtra los valores de trace y span. Reproduce el fallo con el ejemplo proporcionado de filter() y format() y, después, revisa las pruebas pertinentes del handler. Se considera terminado cuando la salida formateada se puede analizar como JSON y conserva las cadenas de trace y span que contienen comillas o barras invertidas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
5.4k
Forks
1.8k
Merge medio
2 d 20 h
PR fusionados (30 d)
140

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de googleapis/google-cloud-python

Todos los issues de googleapis/google-cloud-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.