Added Unix Socket Domain Transport (#6)

Added Unix Socket Domain Transport

Author: jaygel179

.gitignore

@@ -107,3 +107,6 @@ venv.bak/
 
 # Intellij
 .idea
+
+# Protobuf
+*.proto

requirements.txt

@@ -1,5 +1,7 @@
 mock==2.0.0
+protobuf==3.9.1
 pytest==4.3.0
 pytest-cov==2.6.1
 requests==2.21.0
+requests-unixsocket==0.2.0
 retrying==1.3.3

setup.py

@@ -32,8 +32,10 @@
     keywords=['logging', 'stackify', 'exception'],
     classifiers=["Programming Language :: Python"],
     install_requires=[
+        'protobuf>=3.9.1',
         'retrying>=1.2.3',
-        'requests>=2.4.1'
+        'requests>=2.4.1',
+        'requests-unixsocket>=0.2.0'
     ],
     test_suite='tests',
     tests_requires=[

stackify/__init__.py

@@ -7,7 +7,6 @@
 import inspect
 import atexit
 
-from stackify.application import ApiConfiguration  # noqa
 from stackify.constants import DEFAULT_LEVEL
 from stackify.handler import StackifyHandler
 

stackify/application.py

@@ -4,6 +4,12 @@
 API_URL = 'https://api.stackify.com'
 IDENTIFY_URL = '/Metrics/IdentifyApp'
 LOG_SAVE_URL = '/Log/Save'
+
+# using `%2F` instead of `/` as per package documentation
+DEFAULT_SOCKET_FILE = '%2Fusr%2Flocal%2Fstackify%2Fstackify.sock'
+SOCKET_URL = 'http+unix://' + DEFAULT_SOCKET_FILE
+SOCKET_LOG_URL = '/log'
+
 API_REQUEST_INTERVAL_IN_SEC = 30
 
 MAX_BATCH = 100
@@ -19,3 +25,14 @@
     logging.NOTSET: 'NOTSET'
 }
 DEFAULT_LEVEL = logging.INFO
+
+# this is used to separate builtin keys from user-specified keys
+RECORD_VARS = set(logging.LogRecord('', '', '', '', '', '', '', '').__dict__.keys())
+
+# the "message" attribute is saved on the record object by a Formatter
+RECORD_VARS.add('message')
+RECORD_VARS.add('trans_id')
+RECORD_VARS.add('log_id')
+
+TRANSPORT_TYPE_DEFAULT = 'default'
+TRANSPORT_TYPE_AGENT_SOCKET = 'agent_socket'

stackify/constants.py

@@ -1,3 +1,4 @@
+import copy
 import logging
 import atexit
 
@@ -11,13 +12,11 @@
 except ImportError:  # pragma: no cover
     import queue
 
-from stackify.application import get_configuration
 from stackify.constants import API_REQUEST_INTERVAL_IN_SEC
 from stackify.constants import MAX_BATCH
 from stackify.constants import QUEUE_SIZE
-from stackify.http import HTTPClient
-from stackify.log import LogMsg, LogMsgGroup
 from stackify.timer import RepeatedTimer
+from stackify.transport import Transport
 
 
 internal_logger = logging.getLogger(__name__)
@@ -56,6 +55,10 @@ def enqueue(self, record):
             self.queue.get_nowait()
             self.queue.put_nowait(record)
 
+    def prepare(self, record):
+        record = copy.copy(record)
+        return record
+
 
 class StackifyListener(QueueListener):
     '''
@@ -65,24 +68,15 @@ class StackifyListener(QueueListener):
     def __init__(self, queue_, max_batch=MAX_BATCH, config=None, **kwargs):
         super(StackifyListener, self).__init__(queue_)
 
-        if config is None:
-            config = get_configuration(**kwargs)
-
         self.max_batch = max_batch
         self.messages = []
-        self.http = HTTPClient(config)
+        self.transport = Transport(config, **kwargs)
         self.timer = RepeatedTimer(API_REQUEST_INTERVAL_IN_SEC, self.send_group)
 
         self._started = False
 
     def handle(self, record):
-        if not self.http.identified:
-            internal_logger.debug('Identifying application')
-            self.http.identify_application()
-
-        msg = LogMsg()
-        msg.from_record(record)
-        self.messages.append(msg)
+        self.messages.append(self.transport.create_message(record))
 
         if len(self.messages) >= self.max_batch:
             self.send_group()
@@ -91,9 +85,9 @@ def send_group(self):
         if not self.messages:
             return
 
-        group = LogMsgGroup(self.messages)
+        group_message = self.transport.create_group_message(self.messages)
         try:
-            self.http.send_log_group(group)
+            self.transport.send(group_message)
         except Exception:
             internal_logger.exception('Could not send {} log messages, discarding'.format(len(self.messages)))
         del self.messages[:]
@@ -103,8 +97,8 @@ def start(self):
 
         if not self._started:
             super(StackifyListener, self).start()
-            self.timer.start()
             self._started = True
+            self.timer.start()
 
     def stop(self):
         internal_logger.debug('Shutting down listener')