isomer.debugger

Complexity

Total Complexity

61

Size/Duplication

Total Lines	647
Duplicated Lines	0 %

Importance

Changes

0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	MemoryLogger.cli_mem_summary()	0	7	1
A	IsomerDebugger._on_exception()	0	43	4
A	IsomerDebugger.debug_store_json()	0	10	1
A	MemoryLogger.cli_mem_hogs()	0	6	1
B	MemoryLogger.cli_mem_chart()	0	43	5
B	CLI.stdin_read()	0	50	8
B	MemoryLogger.__init__()	0	45	6
A	CLI.__init__()	0	8	1
B	IsomerDebugger.__init__()	0	28	5
A	CLI.register_event()	0	8	1
A	cli_register_event.__init__()	0	4	1
A	MemoryLogger.memlog_timer()	0	19	4
A	IsomerDebugger.cli_locations()	0	9	2
A	clicommand.__init__()	0	4	1
A	IsomerDebugger._drawgraph()	0	9	3
A	MemoryLogger.cli_mem_heap()	0	5	1
A	IsomerDebugger.logtailrequest()	0	3	1
A	MemoryLogger.cli_mem_growth()	0	6	1
B	CLI.cli_help()	0	30	7
A	MemoryLogger.cli_mem_diff()	0	5	1
A	IsomerDebugger.cli_compgraph()	0	9	1
A	IsomerDebugger.cli_log_level()	0	10	1
A	IsomerDebugger.cli_errors()	0	10	3
A	IsomerDebugger.cli_exception_test()	0	5	1

#!/usr/bin/env python
# -*- coding: UTF-8 -*-

# Isomer - The distributed application framework
# ==============================================
# Copyright (C) 2011-2020 Heiko 'riot' Weinen <riot@c-base.org> and others.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""


Module: Debugger
================

Debugger overlord


"""

import json
from collections import deque
from itertools import islice
from uuid import uuid4

import asciichartpy
from circuits.core import Timer
from circuits.core.events import Event
from circuits.core.handlers import reprhandler
from circuits.io import stdin
from isomer.logger import isolog, critical, error, warn, debug, verbose, verbosity
from isomer.component import ConfigurableComponent, handler
from isomer.events.client import send
from isomer.events.system import (
    frontendbuildrequest,
    componentupdaterequest,
    logtailrequest,
)

try:
    # noinspection PyPackageRequirements
    import objgraph
except ImportError:
    objgraph = None

try:
    # noinspection PyPackageRequirements
    from guppy import hpy
except ImportError:
    hpy = None

try:
    # noinspection PyPackageRequirements
    from pympler import tracker, muppy, summary
except ImportError:
    tracker = None
    muppy = None
    summary = None


class clicommand(Event):
    """Event to execute previously registered CLI event hooks"""

    def __init__(self, cmd, cmdargs, *args, **kwargs):
        super(clicommand, self).__init__(*args, **kwargs)
        self.cmd = cmd
        self.args = cmdargs


class cli_register_event(Event):
    """Event to register new command line interface event hooks"""

    def __init__(self, cmd, thing, *args, **kwargs):
        super(cli_register_event, self).__init__(*args, **kwargs)
        self.cmd = cmd
        self.thing = thing


class cli_help(Event):
    """Display this command reference

    Additional arguments:
        -v      Add detailed information about hook events in list

        command Show complete documentation of a hook command
    """

    pass


class cli_errors(Event):
    """Display errors in the live log"""

    pass


class cli_locations(Event):
    """Display all locations of running instance"""

    pass


class cli_log_level(Event):
    """Adjust log level

    Argument:
        [int]   New logging level (0-100)
    """

    pass


class cli_comp_graph(Event):
    """Draw current component graph"""

    pass


class cli_mem_summary(Event):
    """Output memory usage summary"""

    pass


class cli_mem_diff(Event):
    """Output difference in memory usage since last call"""

    pass


class cli_mem_hogs(Event):
    """Output most memory intense objects"""

    pass


class cli_mem_growth(Event):
    """Output data about memory growth"""

    pass


class cli_mem_heap(Event):
    """Output memory heap data"""

    pass


class cli_mem_chart(Event):
    """Output memory consumption chart

    Arguments:
        count   Integer specifying the number of last measurements to chart

    Additional options:
        -o      Omit first value
    """

    pass


class cli_exception_test(Event):
    """Raise test-exception to check exception handling"""

    pass


class TestException(BaseException):
    """Generic exception to test exception monitoring"""

    pass


class IsomerDebugger(ConfigurableComponent):
    """
    Handles various debug requests.
    """

    configprops = {
        "notificationusers": {
            "type": "array",
            "title": "Notification receivers",
            "description": "Users that should be notified about exceptions.",
            "default": [],
            "items": {"type": "string"},
        }
    }
    channel = "isomer-web"

    def __init__(self, root=None, *args):
        super(IsomerDebugger, self).__init__("DBG", *args)

        if not root:
            from isomer.logger import root

            self.root = root
        else:
            self.root = root

        if objgraph is None:
            self.log("Cannot use objgraph.", lvl=warn)

        try:
            self.fireEvent(cli_register_event("errors", cli_errors))
            self.fireEvent(cli_register_event("log_level", cli_log_level))
            self.fireEvent(cli_register_event("comp_graph", cli_comp_graph))
            self.fireEvent(cli_register_event("locations", cli_locations))
            self.fireEvent(cli_register_event("test_exception", cli_exception_test))
        except AttributeError:
            pass  # We're running in a test environment and root is not yet running

        try:
            self.tracker = tracker.SummaryTracker()
        except AttributeError:
            self.log("No pympler library for memory analysis installed.", lvl=warn)

        self.log("Started. Notification users: ", self.config.notificationusers)

    def _drawgraph(self):
        objgraph.show_backrefs(
            [self.root],
            max_depth=5,
            filter=lambda x: type(x) not in [list, tuple, set],
            highlight=lambda x: type(x) in [ConfigurableComponent],
            filename="backref-graph.png",
        )
        self.log("Backref graph written.", lvl=critical)

    @handler("cli_errors")
    def cli_errors(self, *args):
        """Display errors in the live log"""

        self.log("All errors since startup:")
        from isomer.logger import LiveLog

        for logline in LiveLog:
            if logline[1] >= error:
                self.log(logline, pretty=True)

    @handler("cli_log_level")
    def cli_log_level(self, *args):
        """Adjust log level"""

        new_level = int(args[0])
        self.log("Adjusting logging level to", new_level)

        verbosity["global"] = new_level
        verbosity["console"] = new_level
        verbosity["file"] = new_level

    @handler("cli_compgraph")
    def cli_compgraph(self, event):
        """Draw current component graph"""

        self.log("Drawing component graph")
        from circuits.tools import graph

        graph(self)
        self._drawgraph()

    @handler("cli_locations")
    def cli_locations(self, *args):
        """Display all locations of running instance"""

        self.log("All locations for this instance:")
        from isomer.misc.path import locations, get_path

        for path in locations:
            self.log(get_path(path, ""), pretty=True)

    @handler("cli_exception_test")
    def cli_exception_test(self, *args):
        """Raise test-exception to check exception handling"""

        raise TestException

    @handler("debug_store_json")
    def debug_store_json(self, event):
        """A debug-endpoint to store an event as json dump"""

        self.log("Storing received object to /tmp", lvl=critical)
        fp = open(
            "/tmp/isomer_debugger_" + str(event.user.useruuid) + "_" + str(uuid4()), "w"
        )
        json.dump(event.data, fp, indent=True)
        fp.close()

    @handler(logtailrequest)
    def logtailrequest(self, event):
        self.log("Log requested")

    @handler("exception", channel="*", priority=1.0)
    def _on_exception(self, error_type, value, traceback, handler=None, fevent=None):
        # TODO: Generate hashes and thus unique urls with exceptions and fill
        #  them out with this data:
        #  self.log('EXCEPTIONHANDLER:', error_type, value, traceback, lvl=critical)
        #  The idea is to have error pages in the documentation/public Isomer instance
        #  so people can discuss and get help on runtime errors, like with the
        #  exitcodes system in the documentation

        try:
            s = []

            if handler is None:
                handler = ""
            else:
                handler = reprhandler(handler)

            msg = "ERROR"
            msg += "{0:s} ({1:s}) ({2:s}): {3:s}\n".format(
                handler, repr(fevent), repr(error_type), repr(value)
            )

            s.append(msg)
            s.append("\n")

            isolog("\n".join(s), "\n".join(traceback),
                   lvl=critical, frame_ref=3, emitter="DEBUG")

            alert = {
                "component": "isomer.alert.manager",
                "action": "notify",
                "data": {
                    "type": "danger",
                    "message": "\n".join(s),
                    "title": "Exception Monitor",
                },
            }
            for user in self.config.notificationusers:
                self.fireEvent(send(None, alert, username=user, sendtype="user"))

        except Exception as e:
            self.log("Exception during exception handling: ", e, type(e), lvl=critical,
                     exc=True)


class CLI(ConfigurableComponent):
    """
    Command Line Interface support

    This is disabled by default.
    To enable the command line interface, use either the Configuration frontend,
    or the iso tool:

    .. code-block:: sh

        iso config enable CLI

    """

    configprops = {}

    def __init__(self, *args):
        super(CLI, self).__init__("CLI", *args)

        self.hooks = {}

        self.log("Started")
        stdin.register(self)
        self.fire(cli_register_event("help", cli_help))

    @handler("read", channel="stdin")
    def stdin_read(self, data):
        """read Event (on channel ``stdin``)
        This is the event handler for ``read`` events specifically from the
        ``stdin`` channel. This is triggered each time stdin has data that
        it has read.
        """

        data = data.strip().decode("utf-8")
        self.log("Incoming:", data, lvl=verbose)

        def show_error():
            self.log(
                "Unknown Command: '%s'. Use /help to get a list of enabled "
                "cli hooks" % data,
                lvl=warn,
            )

        if len(data) == 0:
            self.log("Use /help to get a list of enabled cli hooks")
            return

        if data[0] == "/":
            cmd = data[1:]
            args = []
            if " " in cmd:
                cmd, args = cmd.split(" ", maxsplit=1)
                args = args.split(" ")
            if cmd in self.hooks:
                self.log("Firing hooked event:", cmd, args, lvl=debug)
                self.fireEvent(self.hooks[cmd](*args))
            # TODO: Move these out, so we get a simple logic here
            elif cmd == "frontend":
                self.log(
                    "Sending %s frontend rebuild event"
                    % ("(forced)" if "force" in args else "")
                )
                self.fireEvent(
                    frontendbuildrequest(
                        force="force" in args, install="install" in args
                    ),
                    "setup",
                )
            elif cmd == "backend":
                self.log("Sending backend reload event")
                self.fireEvent(componentupdaterequest(force=False), "setup")
            else:
                show_error()
        else:
            show_error()

    @handler("cli_help")
    def cli_help(self, *args):
        """Print a list, and a short documentation of all CLI commands"""

        if len(args) == 0 or args[0].startswith("-"):
            self.log("Registered CLI hooks:")
            # TODO: Use std_table for a pretty table
            command_length = 5
            object_length = 5
            for hook in self.hooks:
                command_length = max(len(hook), command_length)
                object_length = max(len(str(self.hooks[hook])), object_length)

            if "-v" not in args:
                object_length = 0

            for hook in sorted(self.hooks):
                self.log(
                    "/%s %s: %s"
                    % (
                        hook.ljust(command_length),
                        (
                            " - " + str(self.hooks[hook]) if object_length != 0 else ""
                        ).ljust(object_length),
                        str(self.hooks[hook].__doc__).split("\n", 1)[0],
                    )
                )
        else:
            self.log("Help for command", args[0], ":")
            self.log(self.hooks[args[0]].__doc__)

    @handler("cli_register_event")
    def register_event(self, event):
        """Registers a new command line interface event hook as command"""

        self.log(
            "Registering event hook:", event.cmd, event.thing, pretty=True, lvl=verbose
        )
        self.hooks[event.cmd] = event.thing


class MemoryLogger(ConfigurableComponent):
    """
    Periodically logs memory consumption statistics
    """

    configprops = {
        "notificationusers": {
            "type": "array",
            "title": "Notification receivers",
            "description": "Users that should be notified about exceptions.",
            "default": [],
            "items": {
                "oneOf": [
                    {"type": "string"},
                    {"type": "null"}
                ]
            },
        },
        "interval": {
            "type": "integer",
            "title": "Interval",
            "description": "Memory growth snapshot interval",
            "default": 600,
        },
        "snapshot_diffs": {
            "type": "integer",
            "title": "History length (snapshots)",
            "description": "Number of memory snapshots diffs to keep",
            "default": 30
        },
        "size_diffs": {
            "type": "integer",
            "title": "History length (size)",
            "description": "Number of memory size diffs to keep",
            "default": 1000
        }
    }
    channel = "isomer-web"

    def __init__(self, *args):
        super(MemoryLogger, self).__init__("MEM", *args)

        if self.args['debug'] is True:
            self.log('Debug flag set, decreasing memory logger measurement '
                     'interval to 20 seconds')
            interval = 20
        else:
            interval = self.config.interval

        self.size = 0
        self.snapshot_diffs = deque(maxlen=self.config.snapshot_diffs)
        self.size_diffs = deque(maxlen=self.config.size_diffs)

        if hpy is not None:
            # noinspection PyCallingNonCallable
            self.heapy = hpy()
        else:
            self.log("Cannot use heapy. guppy package missing?", lvl=warn)

        if objgraph is None:
            self.log("Cannot use objgraph.", lvl=warn)

        try:
            self.fireEvent(cli_register_event("mem_growth", cli_mem_growth))
            self.fireEvent(cli_register_event("mem_hogs", cli_mem_hogs))
            self.fireEvent(cli_register_event("mem_heap", cli_mem_heap))
            self.fireEvent(cli_register_event("mem_summary", cli_mem_summary))
            self.fireEvent(cli_register_event("mem_diff", cli_mem_diff))
            self.fireEvent(cli_register_event("mem_chart", cli_mem_chart))

        except AttributeError:
            pass  # We're running in a test environment and root is not yet running

        try:
            self.tracker = tracker.SummaryTracker()
            self.tracking_timer = Timer(
                interval, Event.create("memlog-timer"), persist=True
            ).register(self)

        except AttributeError:
            self.tracking_timer = None
            self.log("No pympler library for memory analysis installed.", lvl=warn)

        self.log("Started. Notification users: ", self.config.notificationusers)

    @handler("memlog-timer")
    def memlog_timer(self):

        growth = 0
        diff = self.tracker.diff()

        for element in diff:
            growth += element[2]

        self.size += growth
        self.snapshot_diffs.append(diff)
        self.size_diffs.append(growth)

        log_level = debug
        if growth > (self.size * 0.1) and len(self.size_diffs) > 1:
            self.log('Memory growth exceeded 10%!', lvl=warn)
            log_level = warn
        self.log("Memory: total %i growth %i (in %i seconds)" % (
            self.size, growth, self.config.interval), lvl=log_level)

    @handler("cli_mem_summary")
    def cli_mem_summary(self, event):
        """Output memory usage summary"""

        all_objects = muppy.get_objects()
        state = summary.summarize(all_objects)
        summary.print_(state)

    @handler("cli_mem_diff")
    def cli_mem_diff(self, event):
        """Output difference in memory usage since last call"""

        self.tracker.print_diff()

    @handler("cli_mem_hogs")
    def cli_mem_hogs(self, *args):
        """Output most memory intense objects"""

        self.log("Memory hogs:", lvl=critical)
        objgraph.show_most_common_types(limit=20)

    @handler("cli_mem_growth")
    def cli_mem_growth(self, *args):
        """Output data about memory growth"""

        self.log("Memory growth since last call:", lvl=critical)
        objgraph.show_growth()

    @handler("cli_mem_heap")
    def cli_mem_heap(self, *args):
        """Output memory heap data"""

        self.log("Heap log:", self.heapy.heap(), lvl=critical)

    @handler("cli_mem_chart")
    def cli_mem_chart(self, *args):
        """Output memory consumption chart"""

        config = {
            'colors': [
                asciichartpy.blue,
                asciichartpy.red
            ],
            'height': 10,
            'format': '{:6.0f}kB'
        }

        total_length = len(self.size_diffs)

        try:
            count = int(args[-1])
        except (TypeError, ValueError, IndexError):
            count = total_length

        if count > total_length:
            self.log('Only %i measurements available!' % total_length, lvl=warn)
            return

        size_k = [x / 1024.0 for x in islice(
            self.size_diffs, len(self.size_diffs) - count, len(self.size_diffs)
        )]

        if len(args) > 0:
            if "-o" in args:
                size_k.pop(0)

        length = len(size_k)

        self.log(
            "Memory consumption (%i measurements, "
            "%i seconds interval, %3.0f minutes total)" % (
                length,
                self.config.interval,
                (length * self.config.interval / 60.0)
            )
        )
        self.log("\n%s" % asciichartpy.plot(size_k, config), nc=True)