Merge pull request #1 from instana/final_leg

First Release

Author: pglombardo

.travis.yml

@@ -0,0 +1,6 @@
+language: python
+python:
+  - "2.7"
+  - "3.6"
+install: "pip install -r requirements.txt"
+script: nosetests

README.md

@@ -1 +1,37 @@
-# python-sensor
+<div align="center">
+<img src="https://disznc.s3.amazonaws.com/Python-1-2017-06-29-at-22.34.00.png"/>
+</div>
+
+# Instana
+
+The instana package provides Python metrics and traces (request, queue & cross-host) for [Instana](https://www.instana.com/).
+
+## Note
+
+This package supports Python 2.7 or greater.
+
+Any and all feedback is welcome.  Happy Python visibility.
+
+## Installation
+
+    $ pip install instana
+
+## Usage
+
+The instana package is a zero configuration tool that will automatically collect key metrics from your Python processes.  Just install and go.
+
+## Tracing
+
+This Python package supports [OpenTracing](http://opentracing.io/).
+
+## Documentation
+
+You can find more documentation covering supported components and minimum versions in the Instana [documentation portal](https://instana.atlassian.net/wiki/display/DOCS/Python).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/instana/python-sensor.
+
+## More
+
+Want to instrument other languages?  See our [Nodejs instrumentation](https://github.com/instana/nodejs-sensor), [Go instrumentation](https://github.com/instana/golang-sensor), [Ruby instrumentation](https://github.com/instana/ruby-sensor) or [many other supported technologies](https://www.instana.com/supported-technologies/).

instana/agent.py

@@ -8,6 +8,7 @@
 except ImportError:
     import urllib2
 
+
 class From(object):
     pid = ""
     hostId = ""
@@ -42,10 +43,11 @@ def __init__(self, sensor):
         self.reset()
 
     def to_json(self, o):
-        return json.dumps(o, default=lambda o: o.__dict__, sort_keys=False,separators=(',', ':')).encode()
+        return json.dumps(o, default=lambda o: o.__dict__,
+                          sort_keys=False, separators=(',', ':')).encode()
 
     def can_send(self):
-        return self.fsm.fsm.current == "ready"
+        return self.fsm.fsm.current == "good2go"
 
     def head(self, url):
         return self.request(url, "HEAD", None)
@@ -94,7 +96,7 @@ def full_request_response(self, url, method, o, body, header):
                     if method == "HEAD":
                         b = True
         except Exception as e:
-            l.error(str(e))
+            l.error("full_request_response: " + str(e))
 
         return (b, h)
 

instana/custom.py

@@ -1,6 +1,6 @@
 import subprocess
 import os
-import sys
+import psutil
 import threading as t
 import fysom as f
 import instana.log as l
@@ -17,35 +17,34 @@ def __init__(self, **kwds):
 
 
 class Fsm(object):
-    E_START = "start"
-    E_LOOKUP = "lookup"
-    E_ANNOUNCE = "announce"
-    E_TEST = "test"
-
     RETRY_PERIOD = 30
 
     agent = None
     fsm = None
+    timer = None
 
     def __init__(self, agent):
         l.debug("initializing fsm")
 
         self.agent = agent
         self.fsm = f.Fysom({
-            "initial": "none",
+            "initial": "lostandalone",
             "events": [
-                {"name": self.E_START, "src": [
-                    "none", "unannounced", "announced", "ready"], "dst": "init"},
-                {"name": self.E_LOOKUP, "src": "init", "dst": "unannounced"},
-                {"name": self.E_ANNOUNCE, "src": "unannounced", "dst": "announced"},
-                {"name": self.E_TEST, "src": "announced", "dst": "ready"}],
+                ("startup",  "*",            "lostandalone"),
+                ("lookup",   "lostandalone", "found"),
+                ("announce", "found",        "announced"),
+                ("ready",    "announced",    "good2go")],
             "callbacks": {
-                "onstart": self.lookup_agent_host,
-                "onenterunannounced": self.announce_sensor,
-                "onenterannounced": self.test_agent}})
+                "onlookup":       self.lookup_agent_host,
+                "onannounce":     self.announce_sensor,
+                "onchangestate":  self.printstatechange}})
+
+    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))
 
     def reset(self):
-        self.fsm.start()
+        self.fsm.lookup()
 
     def lookup_agent_host(self, e):
         if self.agent.sensor.options.agent_host != "":
@@ -56,17 +55,19 @@ def lookup_agent_host(self, e):
         h = self.check_host(host)
         if h == a.AGENT_HEADER:
             self.agent.set_host(host)
-            self.fsm.lookup()
+            self.fsm.announce()
         else:
             host = self.get_default_gateway()
             if host:
                 self.check_host(host)
                 if h == a.AGENT_HEADER:
                     self.agent.set_host(host)
-                    self.fsm.lookup()
+                    self.fsm.announce()
             else:
                 l.error("Cannot lookup agent host. Scheduling retry.")
-                self.schedule_retry(self.lookup_agent_host, e)
+                self.schedule_retry(self.lookup_agent_host, e, "agent_lookup")
+                return False
+        return True
 
     def get_default_gateway(self):
         l.debug("checking default gateway")
@@ -91,29 +92,36 @@ def check_host(self, host):
 
     def announce_sensor(self, e):
         l.debug("announcing sensor to the agent")
-
-        d = Discovery(pid=os.getpid(),
-                      name=sys.executable,
-                      args=sys.argv[0:])
+        p = psutil.Process(os.getpid())
+        d = Discovery(pid=p.pid,
+                      name=p.cmdline()[0],
+                      args=p.cmdline()[1:])
 
         (b, _) = self.agent.request_response(
             self.agent.make_url(a.AGENT_DISCOVERY_URL), "PUT", d)
         if not b:
             l.error("Cannot announce sensor. Scheduling retry.")
-            self.schedule_retry(self.announce_sensor, e)
+            self.schedule_retry(self.announce_sensor, e, "announce")
+            return False
         else:
             self.agent.set_from(b)
-            self.fsm.announce()
+            self.fsm.ready()
+            return True
 
-    def schedule_retry(self, fun, e):
-        t.Timer(self.RETRY_PERIOD, fun, [e]).start()
+    def schedule_retry(self, fun, e, name):
+        l.error("Scheduling: " + name)
+        self.timer = t.Timer(self.RETRY_PERIOD, fun, [e])
+        self.timer.daemon = True
+        self.timer.name = name
+        self.timer.start()
+        l.debug('Threadlist: %s', str(t.enumerate()))
 
     def test_agent(self, e):
         l.debug("testing communication with the agent")
 
         (b, _) = self.agent.head(self.agent.make_url(a.AGENT_DATA_URL))
 
         if not b:
-            self.schedule_retry(self.test_agent, e)
+            self.schedule_retry(self.test_agent, e, "agent test")
         else:
             self.fsm.test()

instana/data.py

@@ -1,6 +1,7 @@
 import logging as l
+import os
 
-logger = l.getLogger('instana')
+logger = l.getLogger('instana(' + str(os.getpid()) + ')')
 
 
 def init(level):

instana/fsm.py

@@ -5,6 +5,8 @@
 import gc as gc_
 import sys
 import instana.agent_const as a
+import copy
+import time
 
 
 class Snapshot(object):
@@ -63,6 +65,17 @@ class Metrics(object):
     def __init__(self, **kwds):
         self.__dict__.update(kwds)
 
+    def delta_data(self, delta):
+        data = self.__dict__
+        if delta is None:
+            return data
+
+        unchanged_items = set(data.items()) & set(delta.items())
+        for x in unchanged_items:
+            data.pop(x[0])
+
+        return data
+
 
 class EntityData(object):
     pid = 0
@@ -75,33 +88,44 @@ def __init__(self, **kwds):
 
 class Meter(object):
     SNAPSHOT_PERIOD = 600
-    snapshot_countdown = 1
+    snapshot_countdown = 30
     sensor = None
     last_usage = None
     last_collect = None
+    timer = None
+    last_metrics = None
 
     def __init__(self, sensor):
         self.sensor = sensor
-        self.tick()
+        self.run()
+
+    def run(self):
+        self.timer = t.Thread(target=self.collect_and_report)
+        self.timer.daemon = True
+        self.timer.name = "Instana Metric Collection"
+        self.timer.start()
 
-    def tick(self):
-        t.Timer(1, self.process).start()
+    def collect_and_report(self):
+        while 1:
+            self.process()
+            time.sleep(1)
 
     def process(self):
         if self.sensor.agent.can_send():
             self.snapshot_countdown = self.snapshot_countdown - 1
             s = None
+            cm = self.collect_metrics()
             if self.snapshot_countdown == 0:
                 self.snapshot_countdown = self.SNAPSHOT_PERIOD
                 s = self.collect_snapshot()
-
-            m = self.collect_metrics()
-            d = EntityData(pid=os.getpid(), snapshot=s, metrics=m)
-
-            t.Thread(target=self.sensor.agent.request,
-                     args=(self.sensor.agent.make_url(a.AGENT_DATA_URL), "POST", d)).start()
-
-        self.tick()
+                md = cm.delta_data(None)
+            else:
+                md = copy.deepcopy(cm).delta_data(self.last_metrics)
+
+            d = EntityData(pid=os.getpid(), snapshot=s, metrics=md)
+            self.sensor.agent.request(
+                self.sensor.agent.make_url(a.AGENT_DATA_URL), "POST", d)
+            self.last_metrics = cm.__dict__
 
     def collect_snapshot(self):
         try: