148 lines
4.8 KiB
Python
148 lines
4.8 KiB
Python
import asyncio
|
|
import json
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
from opentelemetry.sdk.trace import TracerProvider
|
|
from opentelemetry.sdk.trace.export import SimpleSpanProcessor
|
|
from opentelemetry.sdk.trace.export.in_memory_span_exporter import (
|
|
InMemorySpanExporter,
|
|
)
|
|
|
|
from src import telemetry
|
|
|
|
|
|
@pytest.fixture
|
|
def signals(monkeypatch):
|
|
exporter = InMemorySpanExporter()
|
|
provider = TracerProvider()
|
|
provider.add_span_processor(SimpleSpanProcessor(exporter))
|
|
logs = []
|
|
monkeypatch.setattr(
|
|
telemetry,
|
|
"_state",
|
|
SimpleNamespace(
|
|
tracer=provider.get_tracer("synthetic-test"),
|
|
service="messenger-api",
|
|
logger=SimpleNamespace(emit=lambda **record: logs.append(record)),
|
|
),
|
|
)
|
|
yield exporter, logs
|
|
provider.shutdown()
|
|
|
|
|
|
def test_trace_context_survives_separate_publish_and_consume(signals):
|
|
exporter, _ = signals
|
|
with telemetry.span("upload") as upload:
|
|
accepted_context = telemetry.carrier()
|
|
with telemetry.span(
|
|
"publish", kind=telemetry.SpanKind.PRODUCER, parent=accepted_context
|
|
) as publish:
|
|
notification = telemetry.carrier()
|
|
with telemetry.span(
|
|
"consume", kind=telemetry.SpanKind.CONSUMER, parent=notification
|
|
) as consume:
|
|
with telemetry.span("s3.put"):
|
|
pass
|
|
spans = {s.name: s for s in exporter.get_finished_spans()}
|
|
assert len({s.context.trace_id for s in spans.values()}) == 1
|
|
assert spans["publish"].parent.span_id == upload.get_span_context().span_id
|
|
assert (
|
|
spans["consume"].parent.span_id == publish.get_span_context().span_id
|
|
)
|
|
assert spans["s3.put"].parent.span_id == consume.get_span_context().span_id
|
|
|
|
|
|
def test_secret_in_exception_and_unapproved_fields_is_not_exported(
|
|
signals, capsys
|
|
):
|
|
exporter, logs = signals
|
|
sensitive = "SyntheticSensitiveValueForPrivacyProbe"
|
|
with pytest.raises(ValueError):
|
|
with telemetry.span(
|
|
"db.operation", attributes={"db.query.text": sensitive}
|
|
):
|
|
telemetry.log(
|
|
"request.failed",
|
|
request_id="safe-request",
|
|
password=sensitive,
|
|
Authorization=sensitive,
|
|
body=sensitive,
|
|
)
|
|
raise ValueError(sensitive)
|
|
exported = exporter.get_finished_spans()[0]
|
|
assert exported.events == ()
|
|
assert sensitive not in str(exported.attributes)
|
|
assert sensitive not in exported.status.description
|
|
assert sensitive not in json.dumps(logs, default=str)
|
|
assert sensitive not in capsys.readouterr().out
|
|
|
|
|
|
def test_http_metrics_use_route_template_and_bounded_method(
|
|
signals, monkeypatch, capsys
|
|
):
|
|
exporter, logs = signals
|
|
counts = []
|
|
monkeypatch.setattr(
|
|
telemetry, "count", lambda name, **kw: counts.append((name, kw))
|
|
)
|
|
sensitive = "SyntheticPrivateFilenameAndToken"
|
|
|
|
async def application(scope, receive, send):
|
|
scope["route"] = SimpleNamespace(
|
|
path="/api/v1/chats/{chat_id}/messages"
|
|
)
|
|
await send({"type": "http.response.start", "status": 201})
|
|
await send({"type": "http.response.body", "body": sensitive.encode()})
|
|
|
|
async def send(_):
|
|
pass
|
|
|
|
scope = {
|
|
"type": "http",
|
|
"path": "/api/v1/chats/" + sensitive + "/messages",
|
|
"query_string": sensitive.encode(),
|
|
"method": "CUSTOM_UNBOUNDED_METHOD",
|
|
"headers": [(b"authorization", sensitive.encode())],
|
|
"state": {"request_id": "safe-request"},
|
|
}
|
|
asyncio.run(telemetry.TelemetryMiddleware(application)(scope, None, send))
|
|
assert (
|
|
counts[0][1]["attributes"]["route"]
|
|
== "/api/v1/chats/{chat_id}/messages"
|
|
)
|
|
assert counts[0][1]["attributes"]["method"] == "OTHER"
|
|
assert sensitive not in json.dumps(logs, default=str)
|
|
assert sensitive not in str(exporter.get_finished_spans()[0].attributes)
|
|
assert sensitive not in capsys.readouterr().out
|
|
|
|
|
|
def test_large_tracestate_cannot_break_durable_job_contract(signals):
|
|
from datetime import UTC, datetime
|
|
from uuid import uuid4
|
|
|
|
from src.pipeline import validate_job
|
|
|
|
trace_id = uuid4().hex
|
|
incoming = {
|
|
"traceparent": "00-" + trace_id + "-" + uuid4().hex[:16] + "-01",
|
|
"tracestate": ",".join(
|
|
"vendor" + str(i) + "=" + "x" * 200 for i in range(3)
|
|
),
|
|
}
|
|
with telemetry.span("upload", parent=incoming):
|
|
retained = telemetry.carrier()
|
|
message = {
|
|
"schema_version": 1,
|
|
"job_id": str(uuid4()),
|
|
"type": "attachment.process.v1",
|
|
"attachment_id": str(uuid4()),
|
|
"pipeline_version": 1,
|
|
"attempt": 1,
|
|
"created_at": datetime.now(UTC).isoformat(),
|
|
**retained,
|
|
}
|
|
assert validate_job(message) == message
|
|
assert retained["traceparent"].split("-")[1] == trace_id
|
|
assert "tracestate" not in retained
|