More intelligent package loading semantics (#155)

* Don't load for all processes; More helpful debug boot msgs

* Assure recorder is a singleton

* Update Python versions

* Add direct execution mode; Add info screen

* Update Circle Python version and workflow

* Expand DNL list

* Update copyright year

* Move version to metadata section

Author: pglombardo

.circleci/config.yml

@@ -4,11 +4,9 @@
 #
 version: 2
 jobs:
-  build:
+  build-test-python36:
     docker:
-      # specify the version you desire here
-      # use `-browsers` prefix for selenium tests, e.g. `3.6.1-browsers`
-      - image: circleci/python:3.6.1
+      - image: circleci/python:3.6.8
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -33,7 +31,7 @@ jobs:
       - run:
           name: install dependencies
           command: |
-            python3 -m venv venv
+            python -m venv venv
             . venv/bin/activate
             pip install -U pip
             python setup.py install_egg_info
@@ -54,3 +52,8 @@ jobs:
       - store_artifacts:
           path: test-reports
           destination: test-reports
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build-test-python36

instana/__init__.py

@@ -24,12 +24,8 @@
 from threading import Timer
 import pkg_resources
 
-
-if "INSTANA_MAGIC" in os.environ:
-    pkg_resources.working_set.add_entry("/tmp/instana/python")
-
 __author__ = 'Instana Inc.'
-__copyright__ = 'Copyright 2018 Instana Inc.'
+__copyright__ = 'Copyright 2019 Instana Inc.'
 __credits__ = ['Pavlo Baron', 'Peter Giacomo Lombardo']
 __license__ = 'MIT'
 __maintainer__ = 'Peter Giacomo Lombardo'
@@ -47,14 +43,7 @@ def load(_):
     environment variable.
     """
     if "INSTANA_DEBUG" in os.environ:
-        print("==========================================================")
-        print("Instana: Loading...")
-        print("==========================================================")
-
-
-# User configurable EUM API key for instana.helpers.eum_snippet()
-# pylint: disable=invalid-name
-eum_api_key = ''
+        print("Instana: activated via AUTOWRAPT_BOOTSTRAP")
 
 
 def boot_agent():
@@ -83,8 +72,36 @@ def boot_agent():
 
 
 if "INSTANA_MAGIC" in os.environ:
-    # If we're being loaded into an already running process, then delay agent initialization
-    t = Timer(3.0, boot_agent)
-    t.start()
+    pkg_resources.working_set.add_entry("/tmp/instana/python")
+
+    if "INSTANA_DEBUG" in os.environ:
+        print("Instana: activated via AutoTrace")
+else:
+    if ("INSTANA_DEBUG" in os.environ) and ("AUTOWRAPT_BOOTSTRAP" not in os.environ):
+            print("Instana: activated via manual import")
+
+# User configurable EUM API key for instana.helpers.eum_snippet()
+# pylint: disable=invalid-name
+eum_api_key = ''
+
+# This Python package can be loaded into Python processes one of three ways:
+#   1. manual import statement
+#   2. autowrapt hook
+#   3. dynamically injected remotely
+#
+# With such magic, we may get pulled into Python processes that we have no interest being in.
+# As a safety measure, we maintain a "do not load list" and if this process matches something
+# in that list, then we go sit in a corner quietly and don't load anything at all.
+do_not_load_list = ["pip", "pip2", "pip3", "pipenv", "docker-compose", "easy_install", "easy_install-2.7",
+                    "smtpd.py", "ufw", "unattended-upgrade"]
+
+if os.path.basename(sys.argv[0]) in do_not_load_list:
+    if "INSTANA_DEBUG" in os.environ:
+        print("Instana: No use in monitoring this process type (%s).  Will go sit in a corner quietly.", sys.argv[0])
 else:
-    boot_agent()
+    if "INSTANA_MAGIC" in os.environ:
+        # If we're being loaded into an already running process, then delay agent initialization
+        t = Timer(3.0, boot_agent)
+        t.start()
+    else:
+        boot_agent()

instana/__main__.py

@@ -0,0 +1,40 @@
+print("""\
+============================================================================
+8888888 888b    888  .d8888b. 88888888888     d8888 888b    888        d8888
+  888   8888b   888 d88P  Y88b    888        d88888 8888b   888       d88888
+  888   88888b  888 Y88b.         888       d88P888 88888b  888      d88P888
+  888   888Y88b 888  "Y888b.      888      d88P 888 888Y88b 888     d88P 888
+  888   888 Y88b888     "Y88b.    888     d88P  888 888 Y88b888    d88P  888
+  888   888  Y88888       "888    888    d88P   888 888  Y88888   d88P   888
+  888   888   Y8888 Y88b  d88P    888   d8888888888 888   Y8888  d8888888888
+8888888 888    Y888  "Y8888P"     888  d88P     888 888    Y888 d88P     888
+============================================================================
+
+This is an informational screen for Instana.
+
+See the Instana Python documentation for details on using this package with
+your Python applications, workers, queues and more.
+
+
+Related Blog Posts:
+============================================================================
+
+Monitoring Python with Instana
+https://www.instana.com/blog/monitoring-python-instana/
+
+Zero-Effort, Fully Automatic Distributed Tracing for Python
+https://www.instana.com/blog/zero-effort-fully-automatic-distributed-tracing-for-python/
+
+
+Helpful Links
+============================================================================
+
+Monitoring Python Documentation:
+https://docs.instana.io/ecosystem/python
+
+Help & Support:
+https://support.instana.com/hc/en-us
+
+Python Instrumentation on Github:
+https://github.com/instana/python-sensor/
+""")

instana/singletons.py

@@ -2,7 +2,7 @@
 import opentracing
 
 from .agent import Agent
-from .tracer import InstanaTracer
+from .tracer import InstanaTracer, InstanaRecorder
 
 from distutils.version import LooseVersion
 
@@ -11,6 +11,8 @@
 agent = Agent()
 
 
+span_recorder = InstanaRecorder()
+
 # The global OpenTracing compatible tracer used internally by
 # this package.
 #
@@ -19,11 +21,11 @@
 # import instana
 # instana.tracer.start_span(...)
 #
-tracer = InstanaTracer()
+tracer = InstanaTracer(recorder=span_recorder)
 
 if sys.version_info >= (3,4):
     from opentracing.scope_managers.asyncio import AsyncioScopeManager
-    async_tracer = InstanaTracer(scope_manager=AsyncioScopeManager())
+    async_tracer = InstanaTracer(scope_manager=AsyncioScopeManager(), recorder=span_recorder)
 
 
 # Mock the tornado tracer until tornado is detected and instrumented first
@@ -33,7 +35,7 @@
 def setup_tornado_tracer():
     global tornado_tracer
     from opentracing.scope_managers.tornado import TornadoScopeManager
-    tornado_tracer = InstanaTracer(scope_manager=TornadoScopeManager())
+    tornado_tracer = InstanaTracer(scope_manager=TornadoScopeManager(), recorder=span_recorder)
 
 
 # Set ourselves as the tracer.

instana/tracer.py

@@ -18,9 +18,13 @@
 
 
 class InstanaTracer(BasicTracer):
-    def __init__(self, options=Options(), scope_manager=None):
+    def __init__(self, options=Options(), scope_manager=None, recorder=None):
+
+        if recorder is None:
+            recorder = InstanaRecorder()
+
         super(InstanaTracer, self).__init__(
-            InstanaRecorder(), InstanaSampler(), scope_manager)
+            recorder, InstanaSampler(), scope_manager)
 
         self._propagators[ot.Format.HTTP_HEADERS] = HTTPPropagator()
         self._propagators[ot.Format.TEXT_MAP] = TextPropagator()