Merge pull request #257 from phenobarbital/logstash-handler

Logstash Handler Configuration (working example)

examples/test_logstash.py

@@ -5,7 +5,10 @@
 ## set a new logger name
 logger.setName('config.example')
 # verbose debugging:
-logger.verbose('This is a verbose message')
+logger.verbose(
+    'Working Example',
+    extra={"custom_name": "example", "ipaddr": "90.71.169.159"}
+)
 
 # Give Elasticsearch some time to index the new log entry
 sleep(5)
@@ -19,12 +22,12 @@
 # Define the search query
 search_query = {
     "match": {
-        "message": "This is a verbose message"
+        "message": "Working Example"
     }
 }
 
 # Perform the search
-res = es.search(index="logstash-*", query=search_query)
+res = es.search(index="logdb", query=search_query)
 
 
 # Extract the total number of hits

navconfig/logging/__init__.py

@@ -135,6 +135,7 @@
     root={
         'handlers': ['ErrorFileHandler'],
         'level': loglevel,
+        'propagate': True,
     },
 )
 
@@ -165,43 +166,21 @@
 if logging_echo is True:
     logging_config['root']['handlers'].append('console')
 
-if logstash_logging:
+if logstash_logging is True:
     logging.debug(
         "Logstash configuration Enabled."
     )
-    environment = config.ENV if config.ENV is not None else 'production'
-    # basic configuration of Logstash
-    try:
-        import logstash_async  # pylint: disable=W0611
-    except ImportError as ex:
-        raise RuntimeError(
-            "NavConfig: Logstash Logging is enabled but Logstash async \
-                dependency is not installed.\
-            Hint: run 'pip install logstash_async'."
-        ) from ex
-    LOGSTASH_HOST = config.get('LOGSTASH_HOST', fallback='localhost')
-    LOGSTASH_PORT = config.getint('LOGSTASH_PORT', fallback=6000)
-    LOG_TAG = config.get('FLUENT_TAG', fallback='app.log')
-    logging_config['formatters']['logstash'] = {
-        '()': 'logstash_async.formatter.LogstashFormatter',
-        'message_type': 'python-logstash',
-        'fqdn': False,  # Fully qualified domain name. Default value: false.
-        'extra_prefix': 'dev',
-        'extra': {
-            'application': f'{APP_NAME}',
-            'project_path': f'{BASE_DIR}',
-            'environment': environment
-        }
-    }
-    logging_config['handlers']['LogstashHandler'] = {
-        'class': 'logstash_async.handler.AsynchronousLogstashHandler',
-        'formatter': 'logstash',
-        'transport': 'logstash_async.transport.TcpTransport',
-        'host': LOGSTASH_HOST,
-        'port': int(LOGSTASH_PORT),
-        'level': loglevel,
-        'database_path': f'{LOG_DIR}/logstash.db',
-    }
+    ### Importing Logstash Handler and returning Logging Config:
+    from .handlers import LogstashHandler
+    lh = LogstashHandler(
+        config=config
+    )
+    logging_config['formatters']['logstash'] = lh.formatter(
+        application=APP_NAME, path=BASE_DIR
+    )
+    logging_config['handlers']['LogstashHandler'] = lh.handler(
+        loglevel=loglevel, propagate=True
+    )
     if 'root' not in logging_config:
         logging_config['root'] = {}
     if 'handlers' not in logging_config['root']:

navconfig/logging/handlers/__init__.py

@@ -0,0 +1 @@
+from .logstash import LogstashHandler

navconfig/logging/handlers/logstash.py

@@ -0,0 +1,54 @@
+# basic configuration of Logstash
+try:
+    import logstash_async  # pylint: disable=W0611
+except ImportError as ex:
+    raise RuntimeError(
+        "NavConfig: Logstash Logging is enabled but Logstash async \
+            dependency is not installed.\
+        Hint: run 'pip install logstash_async'."
+    ) from ex
+
+
+class LogstashHandler:
+    def __init__(self, config) -> None:
+        self.env = config.ENV if config.ENV is not None else 'production'
+        self.host = config.get('LOGSTASH_HOST', fallback='127.0.0.1')
+        self.port = config.getint('LOGSTASH_PORT', fallback=6000)
+
+    def formatter(
+            self,
+            application: str,
+            path: str,
+            fqdn: bool = False,
+            **kwargs
+    ):
+        return {
+            '()': 'logstash_async.formatter.LogstashFormatter',
+            'message_type': 'python-logstash',
+            'fqdn': fqdn,
+            "extra_prefix": 'dev',
+            'extra': {
+                'application': f'{application}',
+                'project_path': f'{path}',
+                'environment': self.env,
+                **kwargs
+            }
+        }
+
+    def handler(self, loglevel, enable_localdb: bool = False, **kwargs):
+        hdlr = {
+            'class': 'logstash_async.handler.AsynchronousLogstashHandler',
+            'formatter': 'logstash',
+            'transport': 'logstash_async.transport.TcpTransport',
+            'host': self.host,
+            'port': int(self.port),
+            'level': loglevel
+        }
+        if enable_localdb is True:
+            log_dir = kwargs['logdir']
+            hdlr['database_path'] = f'{log_dir}/logstash.db'
+        else:
+            hdlr['database_path'] = ''
+        if 'propagate' in kwargs:
+            hdlr['propagate'] = kwargs['propagate']
+        return hdlr

navconfig/version.py

@@ -3,7 +3,7 @@
 __title__ = 'navconfig'
 __description__ = ('Configuration tool for all Navigator Services '
                    'Tool for accessing Config info from different sources.')
-__version__ = '1.2.1'
+__version__ = '1.2.2'
 __author__ = 'Jesus Lara'
 __author_email__ = '[email protected]'
 __license__ = 'MIT'