Merge pull request #2 from instana/django

Django middlware instrumentation

Author: pglombardo

instana/agent.py

@@ -2,6 +2,7 @@
 import instana.log as l
 import instana.fsm as f
 import instana.agent_const as a
+import threading
 
 try:
     import urllib.request as urllib2
@@ -76,6 +77,7 @@ def full_request_response(self, url, method, o, body, header):
                 request = urllib2.Request(url, self.to_json(o))
                 request.add_header("Content-Type", "application/json")
 
+            # print self.to_json(o)
             response = urllib2.urlopen(request, timeout=2)
 
             if not response:
@@ -96,7 +98,10 @@ def full_request_response(self, url, method, o, body, header):
                     if method == "HEAD":
                         b = True
         except Exception as e:
-            l.error("full_request_response: " + str(e))
+            # No need to show the initial 404s or timeouts.  The agent
+            # should handle those correctly.
+            if type(e) is urllib2.HTTPError and e.code != 404:
+                l.error("%s: full_request_response: %s" % (threading.current_thread().name, str(e)))
 
         return (b, h)
 

instana/fsm.py

@@ -24,6 +24,7 @@ class Fsm(object):
     timer = None
 
     def __init__(self, agent):
+        l.info("Stan is on the scene.  Starting Instana instrumentation.")
         l.debug("initializing fsm")
 
         self.agent = agent
@@ -41,7 +42,7 @@ def __init__(self, agent):
 
     def printstatechange(self, e):
         l.debug('========= (%i#%s) FSM event: %s, src: %s, dst: %s ==========' % \
-            (os.getpid(), t.current_thread().name, e.event, e.src, e.dst))
+                (os.getpid(), t.current_thread().name, e.event, e.src, e.dst))
 
     def reset(self):
         self.fsm.lookup()
@@ -106,6 +107,7 @@ def announce_sensor(self, e):
         else:
             self.agent.set_from(b)
             self.fsm.ready()
+            l.warn("Host agent available. We're in business. (Announced pid: %i)" % p.pid)
             return True
 
     def schedule_retry(self, fun, e, name):

instana/middleware.py

@@ -0,0 +1,30 @@
+import opentracing as ot
+from instana import tracer
+import opentracing.ext.tags as ext
+
+
+class InstanaMiddleware(object):
+    def __init__(self, get_response):
+        self.get_response = get_response
+        ot.global_tracer = tracer.InstanaTracer()
+        self
+
+    def __call__(self, request):
+        env = request.environ
+        if 'HTTP_X_INSTANA_T' in env and 'HTTP_X_INSTANA_S' in env:
+            ctx = ot.global_tracer.extract(ot.Format.HTTP_HEADERS, env)
+            span = ot.global_tracer.start_span("django", child_of=ctx)
+        else:
+            span = ot.global_tracer.start_span("django")
+
+        span.set_tag(ext.HTTP_URL, env['PATH_INFO'])
+        span.set_tag("http.params", env['QUERY_STRING'])
+        span.set_tag(ext.HTTP_METHOD, request.method)
+        span.set_tag("http.host", env['HTTP_HOST'])
+
+        response = self.get_response(request)
+
+        span.set_tag(ext.HTTP_STATUS_CODE, response.status_code)
+        ot.global_tracer.inject(span.context, ot.Format.HTTP_HEADERS, response)
+        span.finish()
+        return response

instana/options.py

@@ -5,7 +5,7 @@ class Options(object):
     service = ''
     agent_host = ''
     agent_port = 0
-    log_level = logging.ERROR
+    log_level = logging.WARN
 
     def __init__(self, **kwds):
         self.__dict__.update(kwds)

instana/propagator.py

@@ -0,0 +1,38 @@
+from __future__ import absolute_import
+import opentracing as ot
+from instana import util
+
+prefix_tracer_state = 'HTTP_X_INSTANA_'
+field_name_trace_id = prefix_tracer_state + 'T'
+field_name_span_id = prefix_tracer_state + 'S'
+field_count = 2
+
+
+class HTTPPropagator():
+    """A Propagator for Format.HTTP_HEADERS. """
+
+    def inject(self, span_context, carrier):
+        carrier[field_name_trace_id] = util.id_to_header(span_context.trace_id)
+        carrier[field_name_span_id] = util.id_to_header(span_context.span_id)
+
+    def extract(self, carrier):  # noqa
+        count = 0
+        span_id, trace_id = (0, 0)
+        for k in carrier:
+            v = carrier[k]
+            k = k.lower()
+            if k == field_name_span_id:
+                span_id = util.header_to_id(v)
+                count += 1
+            elif k == field_name_trace_id:
+                trace_id = util.header_to_id(v)
+                count += 1
+
+        if count != field_count:
+            raise ot.SpanContextCorruptedException()
+
+        return ot.SpanContext(
+            span_id=span_id,
+            trace_id=trace_id,
+            baggage={},
+            sampled=True)

instana/recorder.py

@@ -10,7 +10,7 @@
 
 class InstanaRecorder(SpanRecorder):
     sensor = None
-    registered_spans = ("memcache", "rpc-client", "rpc-server")
+    registered_spans = ("django", "memcache", "rpc-client", "rpc-server")
     entry_kind = ["entry", "server", "consumer"]
     exit_kind = ["exit", "client", "producer"]
     queue = Queue.Queue()
@@ -33,7 +33,7 @@ def report_spans(self):
             if self.sensor.agent.can_send() and self.queue.qsize:
                 url = self.sensor.agent.make_url(a.AGENT_TRACES_URL)
                 self.sensor.agent.request(url, "POST", self.queued_spans())
-            time.sleep(2)
+            time.sleep(1)
 
     def queue_size(self):
         """ Return the size of the queue; how may spans are queued, """
@@ -72,21 +72,20 @@ def record_span(self, span):
 
     def build_registered_span(self, span):
         """ Takes a BasicSpan and converts it into a registered InstanaSpan """
-        data = sd.Data(service=self.get_service_name(span),
-                       http=sd.HttpData(host=self.get_host_name(span),
+        data = sd.Data(http=sd.HttpData(host=self.get_host_name(span),
                                         url=self.get_string_tag(span, ext.HTTP_URL),
                                         method=self.get_string_tag(span, ext.HTTP_METHOD),
                                         status=self.get_tag(span, ext.HTTP_STATUS_CODE)),
                        baggage=span.context.baggage,
                        custom=sd.CustomData(tags=span.tags,
                                             logs=self.collect_logs(span)))
         return sd.InstanaSpan(
+                    n=span.operation_name,
                     t=span.context.trace_id,
                     p=span.parent_id,
                     s=span.context.span_id,
                     ts=int(round(span.start_time * 1000)),
                     d=int(round(span.duration * 1000)),
-                    n=self.get_http_type(span),
                     f=self.sensor.agent.from_,
                     data=data)
 
@@ -102,13 +101,7 @@ def build_sdk_span(self, span):
                     custom=custom_data
         )
 
-        if "span.kind" in span.tags:
-            if span.tags["span.kind"] in self.entry_kind:
-                sdk_data.Type = "entry"
-            elif span.tags["span.kind"] in self.exit_kind:
-                sdk_data.Type = "exit"
-            else:
-                sdk_data.Type = "local"
+        sdk_data.Type = self.get_span_kind(span)
 
         data = sd.Data(service=self.get_service_name(span),
                        sdk=sdk_data)
@@ -137,7 +130,7 @@ def get_string_tag(self, span, tag):
         return ret
 
     def get_host_name(self, span):
-        h = self.get_string_tag(span, ext.PEER_HOSTNAME)
+        h = self.get_string_tag(span, "http.host")
         if len(h) > 0:
             return h
 
@@ -158,12 +151,16 @@ def get_service_name(self, span):
 
         return self.sensor.service_name
 
-    def get_http_type(self, span):
-        k = self.get_string_tag(span, ext.SPAN_KIND)
-        if k == ext.SPAN_KIND_RPC_CLIENT:
-            return http.HTTP_CLIENT
-
-        return http.HTTP_SERVER
+    def get_span_kind(self, span):
+        kind = ""
+        if "span.kind" in span.tags:
+            if span.tags["span.kind"] in self.entry_kind:
+                kind = "entry"
+            elif span.tags["span.kind"] in self.exit_kind:
+                kind = "exit"
+            else:
+                kind = "local"
+        return kind
 
     def collect_logs(self, span):
         logs = {}

instana/tracer.py

@@ -1,10 +1,10 @@
 import time
 from basictracer import BasicTracer
 import instana.recorder as r
-import opentracing
+import opentracing as ot
 import instana.options as o
 import instana.sensor as s
-import instana.log as ilog
+import instana.propagator as tp
 
 from basictracer.context import SpanContext
 from basictracer.span import BasicSpan
@@ -29,6 +29,8 @@ def __init__(self, options=o.Options()):
         super(InstanaTracer, self).__init__(
             r.InstanaRecorder(self.sensor), r.InstanaSampler())
 
+        self._propagators[ot.Format.HTTP_HEADERS] = tp.HTTPPropagator()
+
     def start_span(
             self,
             operation_name=None,
@@ -44,7 +46,7 @@ def start_span(
         parent_ctx = None
         if child_of is not None:
             parent_ctx = (
-                child_of if isinstance(child_of, opentracing.SpanContext)
+                child_of if isinstance(child_of, ot.SpanContext)
                 else child_of.context)
         elif references is not None and len(references) > 0:
             # TODO only the first reference is currently used
@@ -71,6 +73,18 @@ def start_span(
             tags=tags,
             start_time=start_time)
 
+    def inject(self, span_context, format, carrier):
+        if format in self._propagators:
+            self._propagators[format].inject(span_context, carrier)
+        else:
+            raise ot.UnsupportedFormatException()
+
+    def extract(self, format, carrier):
+        if format in self._propagators:
+            return self._propagators[format].extract(carrier)
+        else:
+            raise ot.UnsupportedFormatException()
+
 
 def init(options):
-    opentracing.tracer = InstanaTracer(options)
+    ot.tracer = InstanaTracer(options)

setup.py

@@ -1,19 +1,35 @@
 from setuptools import setup, find_packages
 
 setup(name='instana',
-      version='0.0.1',
-      url='https://github.com/instana/python-sensor',
+      version='0.0.1.2',
+      download_url='https://github.com/instana/python-sensor',
+      url='https://www.instana.com/',
       license='MIT',
       author='Instana Inc.',
       author_email='[email protected]',
       description='Metrics sensor and trace collector for Instana',
       packages=find_packages(exclude=['tests', 'examples']),
-      long_description=open('README.md').read(),
+      long_description="The instana package provides Python metrics and traces for Instana.",
       zip_safe=False,
       setup_requires=['nose>=1.0',
                       'fysom>=2.1.2',
                       'opentracing>=1.2.1,<1.3',
                       'basictracer>=2.2.0',
                       'psutil>=5.1.3'],
       test_suite='nose.collector',
-      keywords=['performance', 'opentracing', 'metrics', 'monitoring'])
+      keywords=['performance', 'opentracing', 'metrics', 'monitoring'],
+      classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Information Technology',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Topic :: System :: Monitoring',
+        'Topic :: System :: Networking :: Monitoring',
+        'Topic :: Software Development :: Libraries :: Python Modules'])