mirror of
https://git.anonymousland.org/anonymousland/synapse-product.git
synced 2024-12-11 04:44:19 -05:00
Set opentracing priority before setting other tags (#10092)
... because tags on spans which aren't being sampled get thrown away.
This commit is contained in:
parent
3f96dbbda7
commit
ed53bf314f
1
changelog.d/10092.bugfix
Normal file
1
changelog.d/10092.bugfix
Normal file
@ -0,0 +1 @@
|
|||||||
|
Fix a bug in the `force_tracing_for_users` option introduced in Synapse v1.35 which meant that the OpenTracing spans produced were missing most tags.
|
@ -206,11 +206,11 @@ class Auth:
|
|||||||
requester = create_requester(user_id, app_service=app_service)
|
requester = create_requester(user_id, app_service=app_service)
|
||||||
|
|
||||||
request.requester = user_id
|
request.requester = user_id
|
||||||
|
if user_id in self._force_tracing_for_users:
|
||||||
|
opentracing.set_tag(opentracing.tags.SAMPLING_PRIORITY, 1)
|
||||||
opentracing.set_tag("authenticated_entity", user_id)
|
opentracing.set_tag("authenticated_entity", user_id)
|
||||||
opentracing.set_tag("user_id", user_id)
|
opentracing.set_tag("user_id", user_id)
|
||||||
opentracing.set_tag("appservice_id", app_service.id)
|
opentracing.set_tag("appservice_id", app_service.id)
|
||||||
if user_id in self._force_tracing_for_users:
|
|
||||||
opentracing.set_tag(opentracing.tags.SAMPLING_PRIORITY, 1)
|
|
||||||
|
|
||||||
return requester
|
return requester
|
||||||
|
|
||||||
@ -259,12 +259,12 @@ class Auth:
|
|||||||
)
|
)
|
||||||
|
|
||||||
request.requester = requester
|
request.requester = requester
|
||||||
|
if user_info.token_owner in self._force_tracing_for_users:
|
||||||
|
opentracing.set_tag(opentracing.tags.SAMPLING_PRIORITY, 1)
|
||||||
opentracing.set_tag("authenticated_entity", user_info.token_owner)
|
opentracing.set_tag("authenticated_entity", user_info.token_owner)
|
||||||
opentracing.set_tag("user_id", user_info.user_id)
|
opentracing.set_tag("user_id", user_info.user_id)
|
||||||
if device_id:
|
if device_id:
|
||||||
opentracing.set_tag("device_id", device_id)
|
opentracing.set_tag("device_id", device_id)
|
||||||
if user_info.token_owner in self._force_tracing_for_users:
|
|
||||||
opentracing.set_tag(opentracing.tags.SAMPLING_PRIORITY, 1)
|
|
||||||
|
|
||||||
return requester
|
return requester
|
||||||
except KeyError:
|
except KeyError:
|
||||||
|
@ -37,6 +37,7 @@ from synapse.http.servlet import (
|
|||||||
)
|
)
|
||||||
from synapse.logging.context import run_in_background
|
from synapse.logging.context import run_in_background
|
||||||
from synapse.logging.opentracing import (
|
from synapse.logging.opentracing import (
|
||||||
|
SynapseTags,
|
||||||
start_active_span,
|
start_active_span,
|
||||||
start_active_span_from_request,
|
start_active_span_from_request,
|
||||||
tags,
|
tags,
|
||||||
@ -314,7 +315,7 @@ class BaseFederationServlet:
|
|||||||
raise
|
raise
|
||||||
|
|
||||||
request_tags = {
|
request_tags = {
|
||||||
"request_id": request.get_request_id(),
|
SynapseTags.REQUEST_ID: request.get_request_id(),
|
||||||
tags.SPAN_KIND: tags.SPAN_KIND_RPC_SERVER,
|
tags.SPAN_KIND: tags.SPAN_KIND_RPC_SERVER,
|
||||||
tags.HTTP_METHOD: request.get_method(),
|
tags.HTTP_METHOD: request.get_method(),
|
||||||
tags.HTTP_URL: request.get_redacted_uri(),
|
tags.HTTP_URL: request.get_redacted_uri(),
|
||||||
|
@ -265,6 +265,12 @@ class SynapseTags:
|
|||||||
# Whether the sync response has new data to be returned to the client.
|
# Whether the sync response has new data to be returned to the client.
|
||||||
SYNC_RESULT = "sync.new_data"
|
SYNC_RESULT = "sync.new_data"
|
||||||
|
|
||||||
|
# incoming HTTP request ID (as written in the logs)
|
||||||
|
REQUEST_ID = "request_id"
|
||||||
|
|
||||||
|
# HTTP request tag (used to distinguish full vs incremental syncs, etc)
|
||||||
|
REQUEST_TAG = "request_tag"
|
||||||
|
|
||||||
|
|
||||||
# Block everything by default
|
# Block everything by default
|
||||||
# A regex which matches the server_names to expose traces for.
|
# A regex which matches the server_names to expose traces for.
|
||||||
@ -824,7 +830,7 @@ def trace_servlet(request: "SynapseRequest", extract_context: bool = False):
|
|||||||
return
|
return
|
||||||
|
|
||||||
request_tags = {
|
request_tags = {
|
||||||
"request_id": request.get_request_id(),
|
SynapseTags.REQUEST_ID: request.get_request_id(),
|
||||||
tags.SPAN_KIND: tags.SPAN_KIND_RPC_SERVER,
|
tags.SPAN_KIND: tags.SPAN_KIND_RPC_SERVER,
|
||||||
tags.HTTP_METHOD: request.get_method(),
|
tags.HTTP_METHOD: request.get_method(),
|
||||||
tags.HTTP_URL: request.get_redacted_uri(),
|
tags.HTTP_URL: request.get_redacted_uri(),
|
||||||
@ -833,9 +839,9 @@ def trace_servlet(request: "SynapseRequest", extract_context: bool = False):
|
|||||||
|
|
||||||
request_name = request.request_metrics.name
|
request_name = request.request_metrics.name
|
||||||
if extract_context:
|
if extract_context:
|
||||||
scope = start_active_span_from_request(request, request_name, tags=request_tags)
|
scope = start_active_span_from_request(request, request_name)
|
||||||
else:
|
else:
|
||||||
scope = start_active_span(request_name, tags=request_tags)
|
scope = start_active_span(request_name)
|
||||||
|
|
||||||
with scope:
|
with scope:
|
||||||
try:
|
try:
|
||||||
@ -845,4 +851,11 @@ def trace_servlet(request: "SynapseRequest", extract_context: bool = False):
|
|||||||
# with JsonResource).
|
# with JsonResource).
|
||||||
scope.span.set_operation_name(request.request_metrics.name)
|
scope.span.set_operation_name(request.request_metrics.name)
|
||||||
|
|
||||||
scope.span.set_tag("request_tag", request.request_metrics.start_context.tag)
|
# set the tags *after* the servlet completes, in case it decided to
|
||||||
|
# prioritise the span (tags will get dropped on unprioritised spans)
|
||||||
|
request_tags[
|
||||||
|
SynapseTags.REQUEST_TAG
|
||||||
|
] = request.request_metrics.start_context.tag
|
||||||
|
|
||||||
|
for k, v in request_tags.items():
|
||||||
|
scope.span.set_tag(k, v)
|
||||||
|
@ -22,7 +22,11 @@ from prometheus_client.core import REGISTRY, Counter, Gauge
|
|||||||
from twisted.internet import defer
|
from twisted.internet import defer
|
||||||
|
|
||||||
from synapse.logging.context import LoggingContext, PreserveLoggingContext
|
from synapse.logging.context import LoggingContext, PreserveLoggingContext
|
||||||
from synapse.logging.opentracing import noop_context_manager, start_active_span
|
from synapse.logging.opentracing import (
|
||||||
|
SynapseTags,
|
||||||
|
noop_context_manager,
|
||||||
|
start_active_span,
|
||||||
|
)
|
||||||
from synapse.util.async_helpers import maybe_awaitable
|
from synapse.util.async_helpers import maybe_awaitable
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
@ -202,7 +206,9 @@ def run_as_background_process(desc: str, func, *args, bg_start_span=True, **kwar
|
|||||||
try:
|
try:
|
||||||
ctx = noop_context_manager()
|
ctx = noop_context_manager()
|
||||||
if bg_start_span:
|
if bg_start_span:
|
||||||
ctx = start_active_span(desc, tags={"request_id": str(context)})
|
ctx = start_active_span(
|
||||||
|
desc, tags={SynapseTags.REQUEST_ID: str(context)}
|
||||||
|
)
|
||||||
with ctx:
|
with ctx:
|
||||||
return await maybe_awaitable(func(*args, **kwargs))
|
return await maybe_awaitable(func(*args, **kwargs))
|
||||||
except Exception:
|
except Exception:
|
||||||
|
Loading…
Reference in New Issue
Block a user