add more docstrings
[logparse.git] / logparse / parsers / cron.py
index 83cb1cfd734469cdc9c6cb535ace27f44826b4bb..731732d3b9f70a85f11516d0187461557ba734de 100644 (file)
@@ -13,33 +13,40 @@ import re
 from logparse.formatting import *
 from logparse.util import readlog
 from logparse import config
-
-import logging
-logger = logging.getLogger(__name__)
-
-def parse_log():
-
-    logger.warning("NOTE: This cron parser is now deprecated. Please use cron-journald if possible.")
-
-    logger.debug("Starting cron section")
-    section = Section("cron")
-
-    matches = re.findall('.*CMD\s*\(\s*(?!.*cd)(.*)\)', readlog(config.prefs.get("logs", "cron")))
-    num = len(matches)
-    commands = []
-    for match in matches:
-        commands.append(str(match))
-    logger.info("Found " + str(num) + " cron jobs")
-    jobs_data = Data(str(num) + " cron jobs run")
-    section.append_data(jobs_data)
-
-    if (num > 0):
-        logger.debug("Analysing cron commands")
-        cmd_data = Data("Top cron commands")
-        cmd_data.items = ("`{0}`".format(x) for x in commands)
-        cmd_data.orderbyfreq()
-        cmd_data.truncl(config.prefs.getint("logparse", "maxcmd"))
-        section.append_data(cmd_data)
-
-    logger.info("Finished cron section")
-    return section 
+from logparse.load_parsers import Parser
+from logparse.load_parsers import Parser
+
+class Cron(Parser):
+
+    def __init__(self):
+        super().__init__()
+        self.name = "cron"
+        self.info = "List the logged (executed) cron jobs and their commands (uses static syslog file)"
+        self.deprecated = True
+
+    def parse_log(self):
+
+        logger.warning("NOTE: This cron parser is now deprecated. Please use cron-journald if possible.")
+
+        logger.debug("Starting cron section")
+        section = Section("cron")
+
+        matches = re.findall('.*CMD\s*\(\s*(?!.*cd)(.*)\)', readlog(config.prefs.get("logs", "cron")))
+        num = len(matches)
+        commands = []
+        for match in matches:
+            commands.append(str(match))
+        logger.info("Found " + str(num) + " cron jobs")
+        jobs_data = Data(str(num) + " cron jobs run")
+        section.append_data(jobs_data)
+
+        if (num > 0):
+            logger.debug("Analysing cron commands")
+            cmd_data = Data("Top cron commands")
+            cmd_data.items = ("`{0}`".format(x) for x in commands)
+            cmd_data.orderbyfreq()
+            cmd_data.truncl(config.prefs.getint("logparse", "maxcmd"))
+            section.append_data(cmd_data)
+
+        logger.info("Finished cron section")
+        return section