Add AzPostgresLogCheckpointsEvent event plugin

Added AzPostgresLogCheckpointsEvent event plugin. This plugin evaluates Azure Postgres instances and generates an event of type `postgres_log_checkpoints_event` if the `log_checkpoints` setting is disabled. Enabling `log_checkpoints` will generate error and query logs. These logs can be used for troubleshooting and query optimization.
cloudmarker · Feb 29, 2020 · de04682 · de04682
1 parent 0768878
commit de04682
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
@@ -71,6 +71,9 @@
   azlogprofilemissinglocationevent:
     plugin: arachnoid.events.azlogprofilemissinglocationevent.AzLogProfileMissingLocationEvent
 
+  azpostgreslogcheckpointsevent:
+    plugin: cloudmarker.events.azpostgreslogcheckpointsevent.AzPostgresLogCheckpointsEvent
+
   mockevent:
     plugin: cloudmarker.events.mockevent.MockEvent
 

diff --git a/cloudmarker/events/azpostgreslogcheckpointsevent.py b/cloudmarker/events/azpostgreslogcheckpointsevent.py
@@ -0,0 +1,106 @@
+"""Microsoft Azure Postgres Log Checkpoints event.
+
+This module defines the :class:`AzPostgresLogCheckpointsEvent` class
+that identifies Postgre SQL servers which log checkpoints 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 AzPostgresLogCheckpointsEvent:
+    """Az Postgres log checkpoints event plugin."""
+
+    def __init__(self):
+        """Create an instance of :class:`AzPostgresLogCheckpointsEvent`."""
+
+    def eval(self, record):
+        """Evaluate Postgres for log checkpoints.
+
+        Arguments:
+            record (dict): An RDBMS record.
+
+        Yields:
+            dict: An event record representing a Postgres where
+            log checkpoints 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_checkpoints_enabled') is False:
+            yield from _get_postgres_log_checkpoint_disabled_event(
+                com, ext)
+
+    def done(self):
+        """Perform cleanup work.
+
+        Currently, this method does nothing. This may change in future.
+        """
+
+
+def _get_postgres_log_checkpoint_disabled_event(com, ext):
+    """Generate event for Postgres log checkpoints disabled.
+
+    Arguments:
+        com (dict): Postgres record `com` bucket
+        ext (dict): Postgres record `ext` bucket
+    Returns:
+        dict: An event record representing Postgres server
+        with log checkpoints 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 checkpoints disabled.'
+        .format(friendly_cloud_type, friendly_rdbms_type, reference)
+    )
+    recommendation = (
+        'Check {} {} {} and enable log checkpoints.'
+        .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_checkpoints_event'
+        }),
+        'com': {
+            'cloud_type': com.get('cloud_type'),
+            'record_type': 'postgres_log_checkpoints_event',
+            'reference': reference,
+            'description': description,
+            'recommendation': recommendation,
+        }
+    }
+
+    _log.info('Generating postgres_log_checkpoints_event; %r', event_record)
+    yield event_record
diff --git a/cloudmarker/test/test_azpostgreslogcheckpointsevent.py b/cloudmarker/test/test_azpostgreslogcheckpointsevent.py
@@ -0,0 +1,79 @@
+"""Tests for AzPostgresLogCheckpointsEvent plugin."""
+
+
+import copy
+import unittest
+
+from cloudmarker.events import azpostgreslogcheckpointsevent
+
+base_record = {
+    'com':  {
+        'cloud_type': 'azure',
+        'record_type': 'rdbms',
+    },
+    'ext': {
+        'record_type': 'postgresql_server',
+        'log_checkpoints_enabled': False
+    }
+}
+
+
+class AzPostgresLogCheckpointsEventTest(unittest.TestCase):
+    """Tests for AzPostgresLogCheckpointsEvent plugin."""
+
+    def test_com_bucket_missing(self):
+        record = copy.deepcopy(base_record)
+        record['com'] = None
+        plugin = azpostgreslogcheckpointsevent.AzPostgresLogCheckpointsEvent()
+        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 = azpostgreslogcheckpointsevent.AzPostgresLogCheckpointsEvent()
+        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 = azpostgreslogcheckpointsevent.AzPostgresLogCheckpointsEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(events, [])
+
+    def test_ext_bucket_missing(self):
+        record = copy.deepcopy(base_record)
+        record['ext'] = None
+        plugin = azpostgreslogcheckpointsevent.AzPostgresLogCheckpointsEvent()
+        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 = azpostgreslogcheckpointsevent.AzPostgresLogCheckpointsEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(events, [])
+
+    def test_log_checkpoints_enabled(self):
+        record = copy.deepcopy(base_record)
+        record['ext']['log_checkpoints_enabled'] = True
+        plugin = azpostgreslogcheckpointsevent.AzPostgresLogCheckpointsEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(events, [])
+
+    def test_log_checkpoints_disabled(self):
+        record = copy.deepcopy(base_record)
+        plugin = azpostgreslogcheckpointsevent.AzPostgresLogCheckpointsEvent()
+        events = list(plugin.eval(record))
+        self.assertEqual(len(events), 1)
+        self.assertEqual(events[0]['ext']['record_type'],
+                         'postgres_log_checkpoints_event')
+        self.assertEqual(events[0]['com']['cloud_type'],
+                         'azure')
+        self.assertEqual(events[0]['com']['record_type'],
+                         'postgres_log_checkpoints_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
@@ -65,6 +65,14 @@ cloudmarker.events.azlogprofileretentionevent module
    :undoc-members:
    :show-inheritance:
 
+cloudmarker.events.azpostgreslogcheckpointsevent module
+-------------------------------------------------------
+
+.. automodule:: cloudmarker.events.azpostgreslogcheckpointsevent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 cloudmarker.events.azsqldatabasetdeevent module
 -----------------------------------------------
 

diff --git a/pylama.ini b/pylama.ini
@@ -196,3 +196,8 @@ ignore = R0913,R0201
 
 # R0913 Too many arguments (8/5) [pylint]
 # R0201 Method could be a function [pylint]
+
+[pylama:cloudmarker/events/azpostgreslogcheckpointsevent.py]
+ignore = R0201
+
+# R0201 Method could be a function [pylint]