Merge pull request #50 from instana/centralize-service-name

Centralize & simplify service naming

Author: pglombardo

Configuration.md

@@ -11,6 +11,20 @@ export INSTANA_AGENT_IP = '127.0.0.1'
 export INSTANA_AGENT_PORT = '42699'
 ```
 
+## Setting the Service Name
+
+If you'd like to assign a single service name for the entire application you can do so by setting an environment variable or via code:
+
+```
+export INSTANA_SERVICE_NAME=myservice
+```
+
+or
+
+```Python
+instana.service_name = "myservice"
+```
+
 ## Debugging & More Verbosity
 
 Setting `INSTANA_DEV` to a non nil value will enable extra logging output generally useful

instana/__init__.py

@@ -49,3 +49,14 @@
 
 # Set ourselves as the tracer.
 opentracing.tracer = internal_tracer
+
+# Optional application wide service name.
+# Can be configured via environment variable or via code:
+#
+# export INSTANA_SERVICE_NAME=myservice
+#   or
+# instana.service_name = "myservice"
+service_name = None
+
+if "INSTANA_SERVICE_NAME" in os.environ:
+    service_name = os.environ["INSTANA_SERVICE_NAME"]

instana/meter.py

@@ -1,13 +1,14 @@
 import threading as t
-from instana import log
 import resource
 import os
 import gc as gc_
 import sys
-import instana.agent_const as a
 import copy
 import time
 from types import ModuleType
+import instana
+from .log import logger as log
+from .agent_const import AGENT_DATA_URL
 
 
 class Snapshot(object):
@@ -144,14 +145,14 @@ def process(self):
                 md = copy.deepcopy(cm).delta_data(self.last_metrics)
 
             ed = EntityData(pid=self.sensor.agent.from_.pid, snapshot=ss, metrics=md)
-            url = self.sensor.agent.make_url(a.AGENT_DATA_URL)
+            url = self.sensor.agent.make_url(AGENT_DATA_URL)
             self.sensor.agent.request(url, "POST", ed)
             self.last_metrics = cm.__dict__
 
     def collect_snapshot(self):
         try:
-            if self.sensor.service_name:
-                appname = self.sensor.service_name
+            if instana.service_name:
+                appname = instana.service_name
             elif "FLASK_APP" in os.environ:
                 appname = os.environ["FLASK_APP"]
             elif "DJANGO_SETTINGS_MODULE" in os.environ:

instana/options.py

@@ -9,7 +9,16 @@ class Options(object):
     log_level = logging.WARN
 
     def __init__(self, **kwds):
+        """ Initialize Options
+        Respect any environment variables that may be set.
+        """
         if "INSTANA_DEV" in os.environ:
             self.log_level = logging.DEBUG
 
+        if "INSTANA_AGENT_IP" in os.environ:
+            self.agent_host = os.environ["INSTANA_AGENT_IP"]
+
+        if "INSTANA_AGENT_PORT" in os.environ:
+            self.agent_port = os.environ["INSTANA_AGENT_PORT"]
+
         self.__dict__.update(kwds)

instana/recorder.py

@@ -1,11 +1,13 @@
-from basictracer import Sampler, SpanRecorder
-import instana.agent_const as a
 import threading as t
-import opentracing.ext.tags as ext
 import socket
-import instana.span as sd
 import time
 import os
+import instana
+
+import opentracing.ext.tags as ext
+from basictracer import Sampler, SpanRecorder
+from .span import CustomData, Data, HttpData, InstanaSpan, SDKData
+from .agent_const import AGENT_TRACES_URL
 
 import sys
 if sys.version_info.major is 2:
@@ -37,7 +39,7 @@ def report_spans(self):
         """ Periodically report the queued spans """
         while 1:
             if self.sensor.agent.can_send() and self.queue.qsize() > 0:
-                url = self.sensor.agent.make_url(a.AGENT_TRACES_URL)
+                url = self.sensor.agent.make_url(AGENT_TRACES_URL)
                 self.sensor.agent.request(url, "POST", self.queued_spans())
             time.sleep(1)
 
@@ -78,17 +80,17 @@ def record_span(self, span):
 
     def build_registered_span(self, span):
         """ Takes a BasicSpan and converts it into a registered InstanaSpan """
-        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)))
+        data = Data(http=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=CustomData(tags=span.tags,
+                    logs=self.collect_logs(span)))
         entityFrom = {'e': self.sensor.agent.from_.pid,
                       'h': self.sensor.agent.from_.agentUuid}
 
-        return sd.InstanaSpan(
+        return InstanaSpan(
                     n=span.operation_name,
                     t=span.context.trace_id,
                     p=span.parent_id,
@@ -103,21 +105,18 @@ def build_registered_span(self, span):
     def build_sdk_span(self, span):
         """ Takes a BasicSpan and converts into an SDK type InstanaSpan """
 
-        custom_data = sd.CustomData(
-                            tags=span.tags,
-                            logs=self.collect_logs(span))
+        custom_data = CustomData(tags=span.tags,
+                                 logs=self.collect_logs(span))
 
-        sdk_data = sd.SDKData(
-                    name=span.operation_name,
-                    custom=custom_data
-        )
+        sdk_data = SDKData(name=span.operation_name,
+                           custom=custom_data)
 
         sdk_data.Type = self.get_span_kind(span)
-        data = sd.Data(service=self.get_service_name(span), sdk=sdk_data)
+        data = Data(service=self.get_service_name(span), sdk=sdk_data)
         entityFrom = {'e': self.sensor.agent.from_.pid,
                       'h': self.sensor.agent.from_.agentUuid}
 
-        return sd.InstanaSpan(
+        return InstanaSpan(
                     t=span.context.trace_id,
                     p=span.parent_id,
                     s=span.context.span_id,
@@ -152,7 +151,7 @@ def get_host_name(self, span):
         return "localhost"
 
     def get_service_name(self, span):
-        return self.sensor.service_name
+        return instana.service_name
 
     def get_span_kind(self, span):
         kind = ""

instana/sensor.py

@@ -1,33 +1,28 @@
-import instana.options as o
-import instana.meter as m
-import instana.agent as a
-from instana import log
+from __future__ import absolute_import
+from .options import Options
+from .meter import Meter
+from .agent import Agent
+import instana.log as log
 
 
 class Sensor(object):
     options = None
     meter = None
-    service_name = None
     agent = None
 
     def __init__(self, options):
         self.set_options(options)
         log.init(options.log_level)
-        self.configure_service_name()
-        self.agent = a.Agent(self)
-        self.meter = m.Meter(self)
+        self.agent = Agent(self)
+        self.meter = Meter(self)
 
         log.debug("initialized sensor")
 
     def set_options(self, options):
         self.options = options
         if not self.options:
-            self.options = o.Options()
-
-    def configure_service_name(self):
-        if self.options:
-            self.service_name = self.options.service
+            self.options = Options()
 
     def handle_fork(self):
-        self.agent = a.Agent(self)
-        self.meter = m.Meter(self)
+        self.agent = Agent(self)
+        self.meter = Meter(self)