Add AzPostgresLogDurationEvent event plugin

Added AzPostgresLogDurationEvent event plugin. This plugin evaluates Azure Postgres instances and generates an event of type `postgres_log_duration_event` if the `log_duration` setting is disabled. Enabling log_duration helps the PostgreSQL Database to Logs the duration of each completed SQL statement which in turn generates query and error logs. Query and error logs can be used to identify, troubleshoot, and repair configuration errors and sub-optimal performance.
cloudmarker · Feb 29, 2020 · 83d5097 · 83d5097
1 parent c1aefc7
commit 83d5097
Show file tree

Hide file tree

Showing 5 changed files with 201 additions and 0 deletions.
diff --git a/cloudmarker/baseconfig.py b/cloudmarker/baseconfig.py
@@ -80,6 +80,9 @@
   azpostgreslogdisconnectionsevent:
     plugin: cloudmarker.events.azpostgreslogdisconnectionsevent.AzPostgresLogDisconnectionsEvent
 
+  azpostgreslogdurationevent:
+    plugin: cloudmarker.events.azpostgreslogdurationevent.AzPostgresLogDurationEvent
+
   mockevent:
     plugin: cloudmarker.events.mockevent.MockEvent
 

diff --git a/cloudmarker/events/azpostgreslogdurationevent.py b/cloudmarker/events/azpostgreslogdurationevent.py
@@ -0,0 +1,106 @@
+"""Microsoft Azure Postgres Log Duration event.
+
+This module defines the :class:`AzPostgresLogDurationEvent` class
+that identifies Postgre SQL servers which log duration configuration
+disabled. This plugin works on the  properties found in the ``com``
+bucket of ``postgresql_server`` records.
+"""
+
+
+import logging
+
+from cloudmarker import util
+
+_log = logging.getLogger(__name__)
+
+
+class AzPostgresLogDurationEvent:
+    """Az Postgres log duration event plugin."""
+
+    def __init__(self):
+        """Create an instance of :class:`AzPostgresLogDurationEvent`."""
+
+    def eval(self, record):
+        """Evaluate Postgres for log duration.
+
+        Arguments:
+            record (dict): An RDBMS record.
+
+        Yields:
+            dict: An event record representing a Postgres where
+            log duration is disabled
+
+        """
+        com = record.get('com', {})
+        if com is None:
+            return
+
+        if com.get('cloud_type') != 'azure':
+            return
+
+        if com.get('record_type') != 'rdbms':
+            return
+
+        ext = record.get('ext', {})
+        if ext is None:
+            return
+
+        if ext.get('record_type') != 'postgresql_server':
+            return
+
+        # True, None, missing key or any other value will not
+        # genarated an event. An event will be generated only if
+        # the value of `postgresql_server` is False.
+        if ext.get('log_duration_enabled') is False:
+            yield from _get_postgres_log_duration_disabled_event(
+                com, ext)
+
+    def done(self):
+        """Perform cleanup work.
+
+        Currently, this method does nothing. This may change in future.
+        """
+
+
+def _get_postgres_log_duration_disabled_event(com, ext):
+    """Generate event for Postgres log duration disabled.
+
+    Arguments:
+        com (dict): Postgres record `com` bucket
+        ext (dict): Postgres record `ext` bucket
+    Returns:
+        dict: An event record representing Postgres server
+        with log duration disabled
+
+    """
+    friendly_cloud_type = util.friendly_string(com.get('cloud_type'))
+    friendly_rdbms_type = util.friendly_string(ext.get('record_type'))
+
+    reference = com.get('reference')
+    description = (
+        '{} {} {} has log duration disabled.'
+        .format(friendly_cloud_type, friendly_rdbms_type, reference)
+    )
+    recommendation = (
+        'Check {} {} {} and enable log duration.'
+        .format(friendly_cloud_type, friendly_rdbms_type, reference)
+    )
+
+    event_record = {
+        # Preserve the extended properties from the RDBMS
+        # record because they provide useful context to
+        # locate the RDBMS that led to the event.
+        'ext': util.merge_dicts(ext, {
+            'record_type': 'postgres_log_duration_event'
+        }),
+        'com': {
+            'cloud_type': com.get('cloud_type'),
+            'record_type': 'postgres_log_duration_event',
+            'reference': reference,
+            'description': description,
+            'recommendation': recommendation,
+        }
+    }
+
+    _log.info('Generating postgres_log_duration_event; %r', event_record)
+    yield event_record
diff --git a/cloudmarker/test/test_azpostgreslogdurationevent.py b/cloudmarker/test/test_azpostgreslogdurationevent.py
@@ -0,0 +1,79 @@
+"""Tests for AzPostgresLogDurationEvent plugin."""
+
+
+import copy
+import unittest
+
+from cloudmarker.events import azpostgreslogdurationevent
+
+base_record = {
+    'com':  {
+        'cloud_type': 'azure',
+        'record_type': 'rdbms',
+    },
+    'ext': {
+        'record_type': 'postgresql_server',
+        'log_duration_enabled': False
+    }
+}
+
+
+class AzPostgresLogCheckpointsEventTest(unittest.TestCase):
+    """Tests for AzPostgresLogDurationEvent plugin."""
+
+    def test_com_bucket_missing(self):
+        record = copy.deepcopy(base_record)
+        record['com'] = None
+        plugin = azpostgreslogdurationevent.AzPostgresLogDurationEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(events, [])
+
+    def test_cloud_non_azure(self):
+        record = copy.deepcopy(base_record)
+        record['com']['cloud_type'] = 'non_azure'
+        plugin = azpostgreslogdurationevent.AzPostgresLogDurationEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(events, [])
+
+    def test_record_type_non_rdbms(self):
+        record = copy.deepcopy(base_record)
+        record['com']['record_type'] = 'non_rdbms'
+        plugin = azpostgreslogdurationevent.AzPostgresLogDurationEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(events, [])
+
+    def test_ext_bucket_missing(self):
+        record = copy.deepcopy(base_record)
+        record['ext'] = None
+        plugin = azpostgreslogdurationevent.AzPostgresLogDurationEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(events, [])
+
+    def test_record_type_non_postgresql_server(self):
+        record = copy.deepcopy(base_record)
+        record['ext']['record_type'] = 'non_postgresql_server'
+        plugin = azpostgreslogdurationevent.AzPostgresLogDurationEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(events, [])
+
+    def test_log_duration_enabled(self):
+        record = copy.deepcopy(base_record)
+        record['ext']['log_duration_enabled'] = True
+        plugin = azpostgreslogdurationevent.AzPostgresLogDurationEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(events, [])
+
+    def test_log_duration_disabled(self):
+        record = copy.deepcopy(base_record)
+        plugin = azpostgreslogdurationevent.AzPostgresLogDurationEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(len(events), 1)
+        self.assertEqual(events[0]['ext']['record_type'],
+                         'postgres_log_duration_event')
+        self.assertEqual(events[0]['com']['cloud_type'],
+                         'azure')
+        self.assertEqual(events[0]['com']['record_type'],
+                         'postgres_log_duration_event')
+        self.assertTrue('reference' in events[0]['com'])
+        self.assertIsNotNone(events[0]['com']['description'])
+        self.assertIsNotNone(events[0]['com']['recommendation'])
diff --git a/docs/api/cloudmarker.events.rst b/docs/api/cloudmarker.events.rst
@@ -89,6 +89,14 @@ cloudmarker.events.azpostgreslogdisconnectionsevent module
    :undoc-members:
    :show-inheritance:
 
+cloudmarker.events.azpostgreslogdurationevent module
+----------------------------------------------------
+
+.. automodule:: cloudmarker.events.azpostgreslogdurationevent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 cloudmarker.events.azsqldatabasetdeevent module
 -----------------------------------------------
 

diff --git a/pylama.ini b/pylama.ini
@@ -211,3 +211,8 @@ ignore = R0201
 ignore = R0201
 
 # R0201 Method could be a function [pylint]
+
+[pylama:cloudmarker/events/azpostgreslogdurationevent.py]
+ignore = R0201
+
+# R0201 Method could be a function [pylint]