Tornado: Polishing & Bug Fixes

instana/__init__.py

@@ -71,8 +71,8 @@ def boot_agent():
             from .instrumentation.aiohttp import client
             from .instrumentation.aiohttp import server
             from .instrumentation import asynqp
-            from .instrumentation.tornado import client
-            from .instrumentation.tornado import server
+        from .instrumentation.tornado import client
+        from .instrumentation.tornado import server
         from .instrumentation import logging
         from .instrumentation import mysqlpython
         from .instrumentation import redis

instana/instrumentation/tornado/client.py

@@ -3,24 +3,20 @@
 import opentracing
 import wrapt
 import functools
-import basictracer
-import sys
 
 from ...log import logger
 from ...singletons import agent, tornado_tracer
 from ...util import strip_secrets
 
 from distutils.version import LooseVersion
 
+try:
+    import tornado
 
-# Tornado >=6.0 switched to contextvars for context management.  This requires changes to the opentracing
-# scope managers which we will tackle soon.
-# Limit Tornado version for the time being.
-if (('tornado' in sys.modules) and
-        hasattr(sys.modules['tornado'], 'version') and
-        (LooseVersion(sys.modules['tornado'].version) < LooseVersion('6.0.0'))):
-    try:
-        import tornado
+    # Tornado >=6.0 switched to contextvars for context management.  This requires changes to the opentracing
+    # scope managers which we will tackle soon.
+    # Limit Tornado version for the time being.
+    if hasattr(tornado, 'version') and (LooseVersion(tornado.version) < LooseVersion('6.0.0')):
 
         @wrapt.patch_function_wrapper('tornado.httpclient', 'AsyncHTTPClient.fetch')
         def fetch_with_instana(wrapped, instance, argv, kwargs):
@@ -81,6 +77,6 @@ def finish_tracing(future, scope):
 
 
         logger.debug("Instrumenting tornado client")
-    except ImportError:
-        pass
+except ImportError:
+    pass
 

instana/instrumentation/tornado/server.py

@@ -3,46 +3,45 @@
 import opentracing
 from opentracing.scope_managers.tornado import tracer_stack_context
 import wrapt
-import sys
 
 from ...log import logger
 from ...singletons import agent, tornado_tracer
 from ...util import strip_secrets
 
 from distutils.version import LooseVersion
 
-# Tornado >=6.0 switched to contextvars for context management.  This requires changes to the opentracing
-# scope managers which we will tackle soon.
-# Limit Tornado version for the time being.
-if (('tornado' in sys.modules) and
-        hasattr(sys.modules['tornado'], 'version') and
-        (LooseVersion(sys.modules['tornado'].version) < LooseVersion('6.0.0'))):
+try:
+    import tornado
 
-    try:
-        import tornado
+    # Tornado >=6.0 switched to contextvars for context management.  This requires changes to the opentracing
+    # scope managers which we will tackle soon.
+    # Limit Tornado version for the time being.
+    if hasattr(tornado, 'version') and (LooseVersion(tornado.version) < LooseVersion('6.0.0')):
 
         @wrapt.patch_function_wrapper('tornado.web', 'RequestHandler._execute')
         def execute_with_instana(wrapped, instance, argv, kwargs):
             try:
-                ctx = tornado_tracer.extract(opentracing.Format.HTTP_HEADERS, instance.request.headers)
-                scope = tornado_tracer.start_active_span('tornado-server', child_of=ctx)
+                with tracer_stack_context():
+                    ctx = tornado_tracer.extract(opentracing.Format.HTTP_HEADERS, instance.request.headers)
+                    scope = tornado_tracer.start_active_span('tornado-server', child_of=ctx)
 
-                # Query param scrubbing
-                if instance.request.query is not None and len(instance.request.query) > 0:
-                    cleaned_qp = strip_secrets(instance.request.query, agent.secrets_matcher, agent.secrets_list)
-                    scope.span.set_tag("http.params", cleaned_qp)
+                    # Query param scrubbing
+                    if instance.request.query is not None and len(instance.request.query) > 0:
+                        cleaned_qp = strip_secrets(instance.request.query, agent.secrets_matcher, agent.secrets_list)
+                        scope.span.set_tag("http.params", cleaned_qp)
 
-                scope.span.set_tag("http.host", instance.request.host)
-                scope.span.set_tag("http.method", instance.request.method)
-                scope.span.set_tag("http.path", instance.request.path)
+                    url = "%s://%s%s" % (instance.request.protocol, instance.request.host, instance.request.path)
+                    scope.span.set_tag("http.url", url)
+                    scope.span.set_tag("http.method", instance.request.method)
 
-                # Custom header tracking support
-                if agent.extra_headers is not None:
-                    for custom_header in agent.extra_headers:
-                        if custom_header in instance.request.headers:
-                            scope.span.set_tag("http.%s" % custom_header, instance.request.headers[custom_header])
+                    scope.span.set_tag("handler", instance.__class__.__name__)
+
+                    # Custom header tracking support
+                    if agent.extra_headers is not None:
+                        for custom_header in agent.extra_headers:
+                            if custom_header in instance.request.headers:
+                                scope.span.set_tag("http.%s" % custom_header, instance.request.headers[custom_header])
 
-                with tracer_stack_context():
                     setattr(instance.request, "_instana", scope)
 
                     # Set the context response headers now because tornado doesn't give us a better option to do so
@@ -82,7 +81,6 @@ def on_finish_with_instana(wrapped, instance, argv, kwargs):
                         scope.span.set_tag("ec", ec + 1)
 
                 scope.span.set_tag("http.status_code", status_code)
-                scope.span.finish()
                 scope.close()
 
                 return wrapped(*argv, **kwargs)
@@ -104,6 +102,6 @@ def log_exception_with_instana(wrapped, instance, argv, kwargs):
                 logger.debug("tornado log_exception", exc_info=True)
 
         logger.debug("Instrumenting tornado server")
-    except ImportError:
-        pass
+except ImportError:
+    pass
 

instana/meter.py

@@ -136,6 +136,9 @@ def reset(self):
         self.last_collect = None
         self.last_metrics = None
         self.snapshot_countdown = 0
+
+    def handle_fork(self):
+        self.reset()
         self.run()
 
     def collect_and_report(self):

instana/recorder.py

@@ -24,9 +24,9 @@
 class InstanaRecorder(SpanRecorder):
     registered_spans = ("aiohttp-client", "aiohttp-server", "django", "log", "memcache", "mysql",
                         "rabbitmq", "redis", "rpc-client", "rpc-server", "sqlalchemy", "soap",
-                        "tornado-server", "tornado-client", "urllib3", "wsgi")
-    http_spans = ("aiohttp-client", "aiohttp-server", "django", "http", "soap", "tornado-server",
-                  "tornado-client", "urllib3", "wsgi")
+                        "tornado-client", "tornado-server", "urllib3", "wsgi")
+    http_spans = ("aiohttp-client", "aiohttp-server", "django", "http", "soap", "tornado-client",
+                  "tornado-server", "urllib3", "wsgi")
 
     exit_spans = ("aiohttp-client", "log", "memcache", "mysql", "rabbitmq", "redis", "rpc-client",
                   "sqlalchemy", "soap", "tornado-client", "urllib3")
@@ -100,7 +100,9 @@ def record_span(self, span):
 
     def build_registered_span(self, span):
         """ Takes a BasicSpan and converts it into a registered JsonSpan """
-        data = Data(baggage=span.context.baggage)
+        data = Data()
+        if len(span.context.baggage) > 0:
+            data.baggage = span.context.baggage
 
         kind = 1 # entry
         if span.operation_name in self.exit_spans:

instana/sensor.py

@@ -24,7 +24,8 @@ def set_options(self, options):
             self.options = Options()
 
     def handle_fork(self):
-        self.meter.reset()
+        # Nothing to do for the Sensor;  Pass onto Meter
+        self.meter.handle_fork()
 
 
 global_sensor = None

instana/singletons.py

@@ -1,8 +1,11 @@
 import sys
 import opentracing
 
-from .agent import Agent  # noqa
-from .tracer import InstanaTracer  # noqa
+from .agent import Agent
+from .tracer import InstanaTracer
+
+from distutils.version import LooseVersion
+
 
 # The Instana Agent which carries along with it a Sensor that collects metrics.
 agent = Agent()
@@ -20,10 +23,10 @@
 
 if sys.version_info >= (3,4):
     from opentracing.scope_managers.asyncio import AsyncioScopeManager
-    from opentracing.scope_managers.tornado import TornadoScopeManager
-
     async_tracer = InstanaTracer(scope_manager=AsyncioScopeManager())
-    tornado_tracer = InstanaTracer(scope_manager=TornadoScopeManager())
+
+from opentracing.scope_managers.tornado import TornadoScopeManager
+tornado_tracer = InstanaTracer(scope_manager=TornadoScopeManager())
 
 # Set ourselves as the tracer.
 opentracing.tracer = tracer

tests/test_tornado_client.py

@@ -64,8 +64,7 @@ async def test():
 
         self.assertEqual("tornado-server", server_span.n)
         self.assertEqual(200, server_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", server_span.data.http.host)
-        self.assertEqual("/", server_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/", server_span.data.http.url)
         self.assertIsNone(server_span.data.http.params)
         self.assertEqual("GET", server_span.data.http.method)
         self.assertIsNotNone(server_span.stack)
@@ -125,8 +124,7 @@ async def test():
 
         self.assertEqual("tornado-server", server_span.n)
         self.assertEqual(200, server_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", server_span.data.http.host)
-        self.assertEqual("/", server_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/", server_span.data.http.url)
         self.assertIsNone(server_span.data.http.params)
         self.assertEqual("POST", server_span.data.http.method)
         self.assertIsNotNone(server_span.stack)
@@ -190,8 +188,7 @@ async def test():
 
         self.assertEqual("tornado-server", server_span.n)
         self.assertEqual(200, server_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", server_span.data.http.host)
-        self.assertEqual("/", server_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/", server_span.data.http.url)
         self.assertIsNone(server_span.data.http.params)
         self.assertEqual("GET", server_span.data.http.method)
         self.assertIsNotNone(server_span.stack)
@@ -200,8 +197,7 @@ async def test():
 
         self.assertEqual("tornado-server", server301_span.n)
         self.assertEqual(301, server301_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", server301_span.data.http.host)
-        self.assertEqual("/301", server301_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/301", server301_span.data.http.url)
         self.assertIsNone(server301_span.data.http.params)
         self.assertEqual("GET", server301_span.data.http.method)
         self.assertIsNotNone(server301_span.stack)
@@ -264,8 +260,7 @@ async def test():
 
         self.assertEqual("tornado-server", server_span.n)
         self.assertEqual(405, server_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", server_span.data.http.host)
-        self.assertEqual("/405", server_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/405", server_span.data.http.url)
         self.assertIsNone(server_span.data.http.params)
         self.assertEqual("GET", server_span.data.http.method)
         self.assertIsNotNone(server_span.stack)
@@ -328,8 +323,7 @@ async def test():
 
         self.assertEqual("tornado-server", server_span.n)
         self.assertEqual(500, server_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", server_span.data.http.host)
-        self.assertEqual("/500", server_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/500", server_span.data.http.url)
         self.assertIsNone(server_span.data.http.params)
         self.assertEqual("GET", server_span.data.http.method)
         self.assertIsNotNone(server_span.stack)
@@ -392,8 +386,7 @@ async def test():
 
         self.assertEqual("tornado-server", server_span.n)
         self.assertEqual(504, server_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", server_span.data.http.host)
-        self.assertEqual("/504", server_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/504", server_span.data.http.url)
         self.assertIsNone(server_span.data.http.params)
         self.assertEqual("GET", server_span.data.http.method)
         self.assertIsNotNone(server_span.stack)
@@ -453,8 +446,7 @@ async def test():
 
         self.assertEqual("tornado-server", server_span.n)
         self.assertEqual(200, server_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", server_span.data.http.host)
-        self.assertEqual("/", server_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/", server_span.data.http.url)
         self.assertEqual('secret=<redacted>', server_span.data.http.params)
         self.assertEqual("GET", server_span.data.http.method)
         self.assertIsNotNone(server_span.stack)

tests/test_tornado_server.py

@@ -78,8 +78,7 @@ async def test():
 
         self.assertEqual("tornado-server", tornado_span.n)
         self.assertEqual(200, tornado_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", tornado_span.data.http.host)
-        self.assertEqual("/", tornado_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/", tornado_span.data.http.url)
         self.assertIsNone(tornado_span.data.http.params)
         self.assertEqual("GET", tornado_span.data.http.method)
         self.assertIsNotNone(tornado_span.stack)
@@ -139,8 +138,7 @@ async def test():
 
         self.assertEqual("tornado-server", tornado_span.n)
         self.assertEqual(200, tornado_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", tornado_span.data.http.host)
-        self.assertEqual("/", tornado_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/", tornado_span.data.http.url)
         self.assertIsNone(tornado_span.data.http.params)
         self.assertEqual("POST", tornado_span.data.http.method)
         self.assertIsNotNone(tornado_span.stack)
@@ -205,8 +203,7 @@ async def test():
 
         self.assertEqual("tornado-server", tornado_301_span.n)
         self.assertEqual(301, tornado_301_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", tornado_301_span.data.http.host)
-        self.assertEqual("/301", tornado_301_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/301", tornado_301_span.data.http.url)
         self.assertIsNone(tornado_span.data.http.params)
         self.assertEqual("GET", tornado_301_span.data.http.method)
         self.assertIsNotNone(tornado_301_span.stack)
@@ -215,8 +212,7 @@ async def test():
 
         self.assertEqual("tornado-server", tornado_span.n)
         self.assertEqual(200, tornado_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", tornado_span.data.http.host)
-        self.assertEqual("/", tornado_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/", tornado_span.data.http.url)
         self.assertEqual("GET", tornado_span.data.http.method)
         self.assertIsNotNone(tornado_span.stack)
         self.assertTrue(type(tornado_span.stack) is list)
@@ -275,8 +271,7 @@ async def test():
 
         self.assertEqual("tornado-server", tornado_span.n)
         self.assertEqual(405, tornado_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", tornado_span.data.http.host)
-        self.assertEqual("/405", tornado_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/405", tornado_span.data.http.url)
         self.assertIsNone(tornado_span.data.http.params)
         self.assertEqual("GET", tornado_span.data.http.method)
         self.assertIsNotNone(tornado_span.stack)
@@ -336,8 +331,7 @@ async def test():
 
         self.assertEqual("tornado-server", tornado_span.n)
         self.assertEqual(500, tornado_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", tornado_span.data.http.host)
-        self.assertEqual("/500", tornado_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/500", tornado_span.data.http.url)
         self.assertIsNone(tornado_span.data.http.params)
         self.assertEqual("GET", tornado_span.data.http.method)
         self.assertIsNotNone(tornado_span.stack)
@@ -398,8 +392,7 @@ async def test():
 
         self.assertEqual("tornado-server", tornado_span.n)
         self.assertEqual(504, tornado_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", tornado_span.data.http.host)
-        self.assertEqual("/504", tornado_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/504", tornado_span.data.http.url)
         self.assertIsNone(tornado_span.data.http.params)
         self.assertEqual("GET", tornado_span.data.http.method)
         self.assertIsNotNone(tornado_span.stack)
@@ -460,8 +453,7 @@ async def test():
 
         self.assertEqual("tornado-server", tornado_span.n)
         self.assertEqual(200, tornado_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", tornado_span.data.http.host)
-        self.assertEqual("/", tornado_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/", tornado_span.data.http.url)
         self.assertEqual("secret=<redacted>", tornado_span.data.http.params)
         self.assertEqual("GET", tornado_span.data.http.method)
         self.assertIsNotNone(tornado_span.stack)
@@ -529,8 +521,7 @@ async def test():
 
         self.assertEqual("tornado-server", tornado_span.n)
         self.assertEqual(200, tornado_span.data.http.status)
-        self.assertEqual("127.0.0.1:4133", tornado_span.data.http.host)
-        self.assertEqual("/", tornado_span.data.http.path)
+        self.assertEqual("http://127.0.0.1:4133/", tornado_span.data.http.url)
         self.assertEqual("secret=<redacted>", tornado_span.data.http.params)
         self.assertEqual("GET", tornado_span.data.http.method)
         self.assertIsNotNone(tornado_span.stack)