superguard 0.0.3__py2.py3-none-any.whl

superguard/__init__.py

@@ -0,0 +1 @@
+# superguard package

superguard/compat.py

@@ -0,0 +1,26 @@
+try:
+    import http.client as httplib
+except ImportError:
+    import httplib
+
+try:
+    from StringIO import StringIO
+except ImportError:
+    from io import StringIO
+
+try:
+    from sys import maxsize as maxint
+except ImportError:
+    from sys import maxint
+
+try:
+    import urllib.parse as urlparse
+    import urllib.parse as urllib
+except ImportError:
+    import urlparse
+    import urllib
+
+try:
+    import xmlrpc.client as xmlrpclib
+except ImportError:
+    import xmlrpclib

superguard/crashmail.py

@@ -0,0 +1,193 @@
+#!/usr/bin/env python -u
+##############################################################################
+#
+# Copyright (c) 2007 Agendaless Consulting and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the BSD-like license at
+# http://www.repoze.org/LICENSE.txt.  A copy of the license should accompany
+# this distribution.  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL
+# EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND
+# FITNESS FOR A PARTICULAR PURPOSE
+#
+##############################################################################
+
+# A event listener meant to be subscribed to PROCESS_STATE_CHANGE
+# events.  It will send mail when processes that are children of
+# supervisord transition unexpectedly to the EXITED state.
+
+# A supervisor config snippet that tells supervisor to use this script
+# as a listener is below.
+#
+# [eventlistener:crashmail]
+# command =
+#     /usr/bin/crashmail
+#         -o hostname -a -m notify-on-crash@domain.com
+#         -s '/usr/sbin/sendmail -t -i -f crash-notifier@domain.com'
+# events=PROCESS_STATE
+#
+# Sendmail is used explicitly here so that we can specify the 'from' address.
+
+from __future__ import print_function
+
+import os
+import sys
+from argparse import ArgumentParser
+
+from supervisor import childutils
+
+
+class CrashMail:
+
+    def __init__(self, programs, any, email, sendmail, optionalheader):
+
+        self.programs = programs
+        self.any = any
+        self.email = email
+        self.sendmail = sendmail
+        self.optionalheader = optionalheader
+        self.stdin = sys.stdin
+        self.stdout = sys.stdout
+        self.stderr = sys.stderr
+
+    def runforever(self, test=False):
+        while 1:
+            # we explicitly use self.stdin, self.stdout, and self.stderr
+            # instead of sys.* so we can unit test this code
+            headers, payload = childutils.listener.wait(self.stdin, self.stdout)
+
+            if not headers["eventname"] == "PROCESS_STATE_EXITED":
+                # do nothing with non-TICK events
+                childutils.listener.ok(self.stdout)
+                if test:
+                    self.stderr.write("non-exited event\n")
+                    self.stderr.flush()
+                    break
+                continue
+
+            pheaders, pdata = childutils.eventdata(payload + "\n")
+
+            if int(pheaders["expected"]):
+                childutils.listener.ok(self.stdout)
+                if test:
+                    self.stderr.write("expected exit\n")
+                    self.stderr.flush()
+                    break
+                continue
+
+            msg = (
+                "Process %(processname)s in group %(groupname)s exited "
+                "unexpectedly (pid %(pid)s) from state %(from_state)s" % pheaders
+            )
+
+            subject = " %s crashed at %s" % (
+                pheaders["processname"],
+                childutils.get_asctime(),
+            )
+            if self.optionalheader:
+                subject = self.optionalheader + ":" + subject
+
+            self.stderr.write("unexpected exit, mailing\n")
+            self.stderr.flush()
+
+            self.mail(self.email, subject, msg)
+
+            childutils.listener.ok(self.stdout)
+            if test:
+                break
+
+    def mail(self, email, subject, msg):
+        body = "To: %s\n" % self.email
+        body += "Subject: %s\n" % subject
+        body += "\n"
+        body += msg
+        with os.popen(self.sendmail, "w") as m:
+            m.write(body)
+        self.stderr.write("Mailed:\n\n%s" % body)
+        self.mailed = body
+
+
+def main(argv=sys.argv):
+    parser = ArgumentParser(
+        description=(
+            "Send email when processes that are children of supervisord "
+            "transition unexpectedly to the EXITED state."
+        ),
+        epilog=(
+            "The -p option may be specified more than once, allowing for "
+            "specification of multiple processes.  Specifying -a overrides "
+            "any selection of -p.\n\n"
+            "A sample invocation:\n\n"
+            "  crashmail -p program1 -p group1:program2 -m dev@example.com"
+        ),
+    )
+    parser.add_argument(
+        "-p",
+        "--program",
+        action="append",
+        default=[],
+        dest="programs",
+        help=(
+            "specify a supervisor process_name. Send mail when this process "
+            "transitions to the EXITED state unexpectedly. If this process is "
+            "part of a group, it can be specified using the "
+            "'group_name:process_name' syntax."
+        ),
+    )
+    parser.add_argument(
+        "-a",
+        "--any",
+        action="store_true",
+        default=False,
+        dest="any",
+        help=(
+            "Send mail when any child of the supervisord transitions "
+            "unexpectedly to the EXITED state. Overrides any -p parameters "
+            "passed in the same crashmail process invocation."
+        ),
+    )
+    parser.add_argument(
+        "-o",
+        "--optionalheader",
+        default=None,
+        help="Specify a parameter used as a prefix in the mail subject header.",
+    )
+    parser.add_argument(
+        "-s",
+        "--sendmail_program",
+        default="/usr/sbin/sendmail -t -i",
+        dest="sendmail",
+        help=(
+            "the sendmail command to use to send email "
+            '(e.g. "/usr/sbin/sendmail -t -i"). Must be a command which '
+            "accepts header and message data on stdin and sends mail. "
+            'Default is "/usr/sbin/sendmail -t -i".'
+        ),
+    )
+    parser.add_argument(
+        "-m",
+        "--email",
+        default=None,
+        help=(
+            "specify an email address. The script will send mail to this "
+            "address when crashmail detects a process crash. If no email "
+            "address is specified, email will not be sent."
+        ),
+    )
+
+    args = parser.parse_args(argv[1:])
+
+    if "SUPERVISOR_SERVER_URL" not in os.environ:
+        sys.stderr.write("crashmail must be run as a supervisor event " "listener\n")
+        sys.stderr.flush()
+        return
+
+    prog = CrashMail(
+        args.programs, args.any, args.email, args.sendmail, args.optionalheader
+    )
+    prog.runforever()
+
+
+if __name__ == "__main__":
+    main()

superguard/crashmailbatch.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python -u
+##############################################################################
+#
+# Copyright (c) 2007 Agendaless Consulting and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the BSD-like license at
+# http://www.repoze.org/LICENSE.txt.  A copy of the license should accompany
+# this distribution.  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL
+# EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND
+# FITNESS FOR A PARTICULAR PURPOSE
+#
+##############################################################################
+
+# A event listener meant to be subscribed to PROCESS_STATE_CHANGE
+# events.  It will send mail when processes that are children of
+# supervisord transition unexpectedly to the EXITED state.
+
+# A supervisor config snippet that tells supervisor to use this script
+# as a listener is below.
+#
+# [eventlistener:crashmailbatch]
+# command=python crashmailbatch --toEmail=you@bar.com --fromEmail=me@bar.com
+# events=PROCESS_STATE,TICK_60
+
+from __future__ import print_function
+
+from supervisor import childutils
+from superguard.process_state_email_monitor import ProcessStateEmailMonitor
+
+
+class CrashMailBatch(ProcessStateEmailMonitor):
+
+    process_state_events = ["PROCESS_STATE_EXITED"]
+
+    def __init__(self, **kwargs):
+        if kwargs.get("subject") is None:
+            kwargs["subject"] = "Crash alert from supervisord"
+        ProcessStateEmailMonitor.__init__(self, **kwargs)
+        self.now = kwargs.get("now", None)
+
+    def get_process_state_change_msg(self, headers, payload):
+        pheaders, pdata = childutils.eventdata(payload + "\n")
+
+        if int(pheaders["expected"]):
+            return None
+
+        txt = "Process %(groupname)s:%(processname)s (pid %(pid)s) died \
+unexpectedly" % pheaders
+        return "%s -- %s" % (childutils.get_asctime(self.now), txt)
+
+
+def main():
+    crash = CrashMailBatch.create_from_cmd_line()
+    crash.run()
+
+
+if __name__ == "__main__":
+    main()

superguard/crashsms.py

@@ -0,0 +1,65 @@
+#!/usr/bin/env python -u
+##############################################################################
+#
+# Copyright (c) 2007 Agendaless Consulting and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the BSD-like license at
+# http://www.repoze.org/LICENSE.txt.  A copy of the license should accompany
+# this distribution.  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL
+# EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND
+# FITNESS FOR A PARTICULAR PURPOSE
+#
+##############################################################################
+
+##############################################################################
+# crashsms
+# author: Juan Batiz-Benet (http://github.com/jbenet)
+# based on crashmailbatch.py
+##############################################################################
+
+
+# A event listener meant to be subscribed to PROCESS_STATE_CHANGE
+# events.  It will send mail when processes that are children of
+# supervisord transition unexpectedly to the EXITED state.
+
+# A supervisor config snippet that tells supervisor to use this script
+# as a listener is below.
+#
+# [eventlistener:crashsms]
+# command =
+#     python crashsms
+#         -t <mobile phone>@<mobile provider> -f me@bar.com -e TICK_5
+# events=PROCESS_STATE,TICK_5
+
+from __future__ import print_function
+
+from supervisor import childutils
+from superguard.process_state_email_monitor import ProcessStateEmailMonitor
+
+
+class CrashSMS(ProcessStateEmailMonitor):
+    process_state_events = ["PROCESS_STATE_EXITED"]
+
+    def __init__(self, **kwargs):
+        ProcessStateEmailMonitor.__init__(self, **kwargs)
+        self.now = kwargs.get("now", None)
+
+    def get_process_state_change_msg(self, headers, payload):
+        pheaders, pdata = childutils.eventdata(payload + "\n")
+
+        if int(pheaders["expected"]):
+            return None
+
+        txt = "[%(groupname)s:%(processname)s](%(pid)s) exited unexpectedly" % pheaders
+        return "%s %s" % (txt, childutils.get_asctime(self.now))
+
+
+def main():
+    crash = CrashSMS.create_from_cmd_line()
+    crash.run()
+
+
+if __name__ == "__main__":
+    main()

superguard/fatalmailbatch.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python -u
+##############################################################################
+#
+# Copyright (c) 2007 Agendaless Consulting and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the BSD-like license at
+# http://www.repoze.org/LICENSE.txt.  A copy of the license should accompany
+# this distribution.  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL
+# EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND
+# FITNESS FOR A PARTICULAR PURPOSE
+#
+##############################################################################
+
+# A event listener meant to be subscribed to PROCESS_STATE_CHANGE
+# events.  It will send mail when processes that are children of
+# supervisord transition unexpectedly to the EXITED state.
+
+# A supervisor config snippet that tells supervisor to use this script
+# as a listener is below.
+#
+# [eventlistener:fatalmailbatch]
+# command=python fatalmailbatch
+# events=PROCESS_STATE,TICK_60
+
+from __future__ import print_function
+
+from supervisor import childutils
+from superguard.process_state_email_monitor import ProcessStateEmailMonitor
+
+
+class FatalMailBatch(ProcessStateEmailMonitor):
+
+    process_state_events = ["PROCESS_STATE_FATAL"]
+
+    def __init__(self, **kwargs):
+        if kwargs.get("subject") is None:
+            kwargs["subject"] = "Fatal start alert from supervisord"
+        ProcessStateEmailMonitor.__init__(self, **kwargs)
+        self.now = kwargs.get("now", None)
+
+    def get_process_state_change_msg(self, headers, payload):
+        pheaders, pdata = childutils.eventdata(payload + "\n")
+
+        txt = "Process %(groupname)s:%(processname)s failed to start too many \
+times" % pheaders
+        return "%s -- %s" % (childutils.get_asctime(self.now), txt)
+
+
+def main():
+    fatal = FatalMailBatch.create_from_cmd_line()
+    fatal.run()
+
+
+if __name__ == "__main__":
+    main()