logging: StructuredLogHandler writes invalid JSON when trace or span_id contains " or \
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
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
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de googleapis/google-cloud-python
-
firestore: field path with a quoted name ending in a backslash is misparsedPosiblemente ocupada @sebxt la tomó hace 28 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
googleapis/google-cloud-python#18771 ·
Los mantenedores suelen responder en 2 días
-
api: spanner type: feature request
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
googleapis/google-cloud-python#18584 ·
Los mantenedores suelen responder en 2 días
-
auth: `impersonated_credentials` loses `subject` on copy, so `with_scopes()` and `with_quota_project()` turn off domain wide delegationPosiblemente ocupada @Om-singhaI la tomó hace 57 días. Abiertoauth priority: p2 type: bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
googleapis/google-cloud-python#18428 ·
Los mantenedores suelen responder en 2 días
-
A client called `run_in_transaction` be stuck if Spanner is downPosiblemente ocupada @founderinaction la tomó hace 10 días. Abiertopriority: p2 type: bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
googleapis/google-cloud-python#18375 · 1 comentario ·
Los mantenedores suelen responder en 2 días
-
ci: enable --strict flag in presubmit twine_checkQuizá libre de nuevo @ohmayr la tomó hace 47 días y no hay ningún pull request abierto. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 76/100
googleapis/google-cloud-python#18339 · 1 comentario · 1 asignado ·
Los mantenedores suelen responder en 2 días
Todos los issues de googleapis/google-cloud-python
Issues similares
-
area-templates triage:bot-seen triage:needs-human
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
microsoft/aspire#22356 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[Train] An elastic ScalingConfig(num_workers=(0, 0)) is accepted and the run waits foreverPosiblemente ocupada @wguo7 la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
ray-project/ray#68217 ·
Los mantenedores suelen responder en 2 días
-
PairwiseComparisonEvaluator records A when a judge's final verdict is B or C after mentioning [[A]]Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
run-llama/llama_index#24279 ·
Los mantenedores suelen responder en 2 días
-
area:docs good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
On PyPy, _has_type against an abstract base class lets a metaclass's own exception out of a refusalAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
btclib-org/btclib#3139 ·
Los mantenedores suelen responder en 1 día