Add documentation for Grafana Loki hook (#743).

tests/integration/hooks/test_loki.py

@@ -6,9 +6,9 @@ from flexmock import flexmock
 from borgmatic.hooks import loki as module
 
 
-def test_log_handler_label_replacment():
+def test_initialize_monitor_replaces_labels():
     '''
-    Assert that label placeholders get replaced
+    Assert that label placeholders get replaced.
     '''
     hook_config = {
         'url': 'http://localhost:3100/loki/api/v1/push',
@@ -17,18 +17,20 @@ def test_log_handler_label_replacment():
     config_filename = '/mock/path/test.yaml'
     dry_run = True
     module.initialize_monitor(hook_config, flexmock(), config_filename, flexmock(), dry_run)
+
     for handler in tuple(logging.getLogger().handlers):
         if isinstance(handler, module.Loki_log_handler):
             assert handler.buffer.root['streams'][0]['stream']['hostname'] == platform.node()
             assert handler.buffer.root['streams'][0]['stream']['config'] == 'test.yaml'
             assert handler.buffer.root['streams'][0]['stream']['config_full'] == config_filename
             return
+
     assert False
 
 
-def test_initalize_adds_log_handler():
+def test_initialize_monitor_adds_log_handler():
     '''
-    Assert that calling initialize_monitor adds our logger to the root logger
+    Assert that calling initialize_monitor adds our logger to the root logger.
     '''
     hook_config = {'url': 'http://localhost:3100/loki/api/v1/push', 'labels': {'app': 'borgmatic'}}
     module.initialize_monitor(
@@ -38,15 +40,17 @@ def test_initalize_adds_log_handler():
         monitoring_log_level=flexmock(),
         dry_run=True,
     )
+
     for handler in tuple(logging.getLogger().handlers):
         if isinstance(handler, module.Loki_log_handler):
             return
+
     assert False
 
 
-def test_ping_adds_log_message():
+def test_ping_monitor_adds_log_message():
     '''
-    Assert that calling ping_monitor adds a message to our logger
+    Assert that calling ping_monitor adds a message to our logger.
     '''
     hook_config = {'url': 'http://localhost:3100/loki/api/v1/push', 'labels': {'app': 'borgmatic'}}
     config_filename = 'test.yaml'
@@ -55,6 +59,7 @@ def test_ping_adds_log_message():
     module.ping_monitor(
         hook_config, flexmock(), config_filename, module.monitor.State.FINISH, flexmock(), dry_run
     )
+
     for handler in tuple(logging.getLogger().handlers):
         if isinstance(handler, module.Loki_log_handler):
             assert any(
@@ -65,18 +70,20 @@ def test_ping_adds_log_message():
                 )
             )
             return
+
     assert False
 
 
-def test_log_handler_gets_removed():
+def test_destroy_monitor_removes_log_handler():
     '''
-    Assert that destroy_monitor removes the logger from the root logger
+    Assert that destroy_monitor removes the logger from the root logger.
     '''
     hook_config = {'url': 'http://localhost:3100/loki/api/v1/push', 'labels': {'app': 'borgmatic'}}
     config_filename = 'test.yaml'
     dry_run = True
     module.initialize_monitor(hook_config, flexmock(), config_filename, flexmock(), dry_run)
     module.destroy_monitor(hook_config, flexmock(), config_filename, flexmock(), dry_run)
+
     for handler in tuple(logging.getLogger().handlers):
         if isinstance(handler, module.Loki_log_handler):
             assert False