# # __main__.py # # This module is the entrypoint of the `logparse` shell command and also # contains single-use functions which don't fit elsewhere. # import logging, logging.handlers import argparse import os import glob import sys from subprocess import check_output from datetime import datetime import logparse from .config import * from logparse import formatting, mail, config from .parsers import load_parsers def rotate(): # Rotate logs using systemd logrotate try: if not os.geteuid() == 0: if sys.stdin.isatty(): logger.warning("Not running as root, using sudo (may require password to be entered)") rotate_shell = check_output("sudo logrotate /etc/logrotate.conf", shell=True) else: raise PermissionError("Root priviliges are required to run logrotate but are not provided") else: rotate_shell = check_output("/usr/sbin/logrotate /etc/logrotate.conf", shell=True) logger.info("Rotated logfiles") logger.debug("logrotate output: " + rotate_shell) except Exception as e: logger.warning("Failed to rotate log files: " + str(e)) def rotate_sim(): # Simulate log rotation try: if not os.geteuid() == 0: logger.warning("Cannot run logrotate as root - you will see permission errors in the output below") sim_cmd = "logrotate -d /etc/logrotate.conf" logger.debug("Here is the output of `{0}` (simulated):".format(sim_cmd) sim = check_output(sim_cmd, shell=True) logger.debug(sim) except Exception as e: logger.warning("Failed to get logrotate simulation: " + str(e)) def main(): # Get arguments argparser = argparse.ArgumentParser(description='grab logs of some common services and send them by email') argparser.add_argument('-t','--to', help='mail recipient (\"to\" address)', required=False) argparser.add_argument('-c', '--config', help='path to config file', required=False) argparser.add_argument('-p', '--print', help='print HTML to stdout', required=False, dest='printout', action='store_true', default=False) argparser.add_argument('-d', '--destination', help='file to output HTML', required=False) argparser.add_argument('-f', '--overwrite', help='force overwrite an existing output file', required=False, action='store_true', default=False) argparser.add_argument('-v', '--verbose', help='verbose console/syslog output (for debugging)', required=False, default=False, action='store_true') argparser.add_argument('-r', '--rotate', help='force rotate log files using systemd logrotate (overrides --rotate and "rotate" in logparse.conf)', required=False, default=False, action='store_true') argparser.add_argument('-nr', '--no-rotate', help='do not rotate logfiles (overrides --rotate and logparse.conf)', required=False, default=False, action='store_true') argparser.add_argument('-s', '--simulate', help="test run logrotate (do not actually change files)", required=False, default=False, action="store_true") argparser.add_argument('-l', '--logs', help='services to analyse', required=False) argparser.add_argument('-nl', '--ignore-logs', help='skip these services (takes precedence over -l)', required=False) argparser.add_argument('-es', '--embed-styles', help='make CSS rules inline rather than linking the file', required=False, default=False, action='store_true') argparser.add_argument('-nh', '--plain', help='write/send plain text rather than HTML', required=False, default=False, action='store_true') argparser.add_argument('-q', '--quiet', help='no output to stdout', required=False, default=False, action='store_true') # Load config if argparser.parse_args().config: config.prefs = config.loadconf(argparser.parse_args().config, argparser) else: config.prefs = config.loadconf(argparser=argparser) prefs = config.prefs # Set up logging logger = logging.getLogger(__name__) loghandler = logging.handlers.SysLogHandler(address = '/dev/log') loghandler.setFormatter(logging.Formatter(fmt='logparse[' + str(os.getpid()) + ']: %(message)s')) loghandler.setLevel(logging.INFO) # don't spam syslog with debug messages if argparser.parse_args().quiet or config.prefs['quiet']: logging.basicConfig(level=logging.CRITICAL) elif argparser.parse_args().verbose or config.prefs['verbose']: logging.basicConfig(level=logging.DEBUG) logger.debug("Verbose mode turned on") else: logging.basicConfig(level=logging.INFO) logger.addHandler(loghandler) logger.debug("Finished loading config") # Time analysis global start start = datetime.now() logger.info("Beginning log analysis at {0} {1}".format(start.strftime(formatting.DATEFMT), start.strftime(formatting.TIMEFMT))) logger.debug("This is {0} version {1}, running on Python {2}".format(logparse.__name__, logparse.__version__, sys.version.replace('\n', ''))) # Write header global output if argparser.parse_args().plain: output = formatting.PlaintextOutput(linewidth=prefs['linewidth']) else: output = formatting.HtmlOutput() output.append_header(prefs['header']) # Find parsers parser_providers = [] if argparser.parse_args().logs: log_src = argparser.parse_args().logs.split() elif len(prefs['parsers']) > 0: log_src = prefs['parsers'] else: log_src = load_parsers.default_parsers for parser_name in log_src: parser = load_parsers.search(parser_name) if parser == None: logger.warning("Can't find parser {0}".format(parser_name)) continue else: parser_providers.append(load_parsers.load(parser)) if argparser.parse_args().ignore_logs or len(prefs['ignore-parsers']) > 0: if argparser.parse_args().ignore_logs: ignore_src = argparser.parse_args().ignore_logs.split() else: ignore_src = prefs['ignore-parsers'] for parser_name in ignore_src: if parser_name in [x.__name__.rpartition('.')[2] for x in parser_providers]: logger.info("Ignoring default parser {0}".format(parser_name)) parser_providers_new = [] for p in parser_providers: if p.__name__.rpartition('.')[2] != parser_name: parser_providers_new.append(p) parser_providers = parser_providers_new continue # Execute parsers logger.debug(str(parser_providers)) for parser in parser_providers: output.append_section(parser.parse_log()) # Write HTML footer output.append_footer() if argparser.parse_args().printout: print(output) if argparser.parse_args().destination or prefs['output']: if argparser.parse_args().destination: dest_path = argparser.parse_args().destination else: dest_path = prefs['output'] logger.debug("Outputting to {0}".format(dest_path)) if (argparser.parse_args().embed_styles or prefs['embed-styles']) and not (argparser.parse_args().plain or prefs['plain']): output.embed_css(prefs['css']) if (not os.path.isfile(dest_path)) and not (argparser.parse_args().overwrite or config['overwrite']): output.write(dest_path) elif logging.root.level == logging.CRITICAL: pass else: logger.warning("Destination file already exists") if input("Would you like to overwrite {0}? (y/n) [n] ".format(dest_path)) == 'y': output.write(dest_path) else: logger.warning("No output written") if argparser.parse_args().to or prefs['mail']['to']: if argparser.parse_args().to: to = argparser.parse_args().to else: to = prefs['mail']['to'] mail.sendmail(mailbin=prefs['mail']['mailbin'], body=(output.embed_css(prefs['css']) if isinstance(output, formatting.HtmlOutput) else output.content), recipient=to, subject=formatting.fsubject(config.prefs['mail']['subject']), html=isinstance(output, formatting.HtmlOutput), sender=prefs['mail']['from']) if not argparser.parse_args().no_rotate: if argparser.parse_args().simulate or prefs['rotate'] == 's': rotate_sim() elif prefs['rotate'] or argparser.parse_args().rotate: rotate() else: logger.debug("User doesn't want to rotate logs") else: logger.debug("User doesn't want to rotate logs") # Print end message finish = datetime.now() logger.info("Finished parsing logs at {0} {1} (total time: {2})".format(finish.strftime(formatting.DATEFMT), finish.strftime(formatting.TIMEFMT), finish - start)) return