Opentrace device lists

synapse/logging/opentracing.py

@@ -92,7 +92,7 @@ def interesting_function(*args, **kwargs):
 
    from synapse.logging.opentracing import trace
 
-   @trace(operation_name="A *much* better operation name")
+   @trace(operation_name="a_better_operation_name")
    def interesting_badly_named_function(*args, **kwargs):
        # Does all kinds of cool and expected things
        return something_usual_and_useful
@@ -641,19 +641,22 @@ def extract_text_map(carrier):
 # Tracing decorators
 
 
-def trace(func=None, operation_name=None):
+def trace(func=None, opname=None):
     """
     Decorator to trace a function.
-    Sets the operation name to that of the function's.
+    Sets the operation name to that of the function's or that given
+    as operation_name. See the module's doc string for usage
+    examples.
     """
 
-    if func and not operation_name:
-        operation_name = func.__name__
-
     def decorator(func):
         if opentracing is None:
             return func
 
+        # Doing this weird assignment thing to get around local variable
+        # referenced before assignment 'bug' raised by checkstyle
+        operation_name = opname if opname else func.__name__
+
         @wraps(func)
         def _trace_inner(self, *args, **kwargs):
             if opentracing is None:

synapse/rest/client/v2_alpha/keys.py

@@ -69,7 +69,7 @@ def __init__(self, hs):
         self.auth = hs.get_auth()
         self.e2e_keys_handler = hs.get_e2e_keys_handler()
 
-    @trace(operation_name="upload_keys")
+    @trace(opname="upload_keys")
     @defer.inlineCallbacks
     def on_POST(self, request, device_id):
         requester = yield self.auth.get_user_by_req(request, allow_guest=True)

synapse/rest/client/v2_alpha/sendtodevice.py

@@ -43,7 +43,7 @@ def __init__(self, hs):
         self.txns = HttpTransactionCache(hs)
         self.device_message_handler = hs.get_device_message_handler()
 
-    @trace(operation_name="sendToDevice")
+    @trace(opname="sendToDevice")
     def on_PUT(self, request, message_type, txn_id):
         set_tag("message_type", message_type)
         set_tag("txn_id", txn_id)

synapse/storage/devices.py

@@ -357,7 +357,7 @@ def get_user_devices_from_cache(self, query_list):
         set_tag("in_cache", results)
         set_tag("not_in_cache", user_ids_not_in_cache)
 
-        return (user_ids_not_in_cache, results)
+        return user_ids_not_in_cache, results
 
     @cachedInlineCallbacks(num_args=2, tree=True)
     def _get_cached_user_device(self, user_id, device_id):