Skip to content

deep.api.plugin.python

Simple plugin for deep, decorating some python information.

PythonPlugin

Bases: ResourceProvider, SnapshotDecorator, TracepointLogger

Deep python plugin.

This plugin provides the python version to the resource, and the thread name to the attributes.

Source code in deep/api/plugin/python.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
class PythonPlugin(ResourceProvider, SnapshotDecorator, TracepointLogger):
    """
    Deep python plugin.

    This plugin provides the python version to the resource, and the thread name to the attributes.
    """

    def decorate(self, snapshot_id: str, context: ActionContext) -> Optional[BoundedAttributes]:
        """
        Decorate a snapshot with additional data.

        :param snapshot_id: the id of the collected snapshot
        :param context: the action context for this action

        :return: the additional attributes to attach
        """
        thread = threading.current_thread()

        return BoundedAttributes(attributes={
            'thread_name': thread.name
        })

    def resource(self) -> Optional[Resource]:
        """
        Provide resource.

        :return: the provided resource
        """
        return Resource({
            "python_version": platform.python_version(),
        })

    def log_tracepoint(self, log_msg: str, tp_id: str, ctx_id: str):
        """
        Log the dynamic log message.

        :param (str) log_msg: the log message to log
        :param (str) tp_id:  the id of the tracepoint that generated this log
        :param (str) ctx_id: the id of the context that was created by this tracepoint
        """
        logging.info(log_msg + " ctx=%s tracepoint=%s" % (ctx_id, tp_id))

decorate(snapshot_id, context)

Decorate a snapshot with additional data.

:param snapshot_id: the id of the collected snapshot :param context: the action context for this action

:return: the additional attributes to attach

Source code in deep/api/plugin/python.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def decorate(self, snapshot_id: str, context: ActionContext) -> Optional[BoundedAttributes]:
    """
    Decorate a snapshot with additional data.

    :param snapshot_id: the id of the collected snapshot
    :param context: the action context for this action

    :return: the additional attributes to attach
    """
    thread = threading.current_thread()

    return BoundedAttributes(attributes={
        'thread_name': thread.name
    })

log_tracepoint(log_msg, tp_id, ctx_id)

Log the dynamic log message.

:param (str) log_msg: the log message to log :param (str) tp_id: the id of the tracepoint that generated this log :param (str) ctx_id: the id of the context that was created by this tracepoint

Source code in deep/api/plugin/python.py 
63
64
65
66
67
68
69
70
71
def log_tracepoint(self, log_msg: str, tp_id: str, ctx_id: str):
    """
    Log the dynamic log message.

    :param (str) log_msg: the log message to log
    :param (str) tp_id:  the id of the tracepoint that generated this log
    :param (str) ctx_id: the id of the context that was created by this tracepoint
    """
    logging.info(log_msg + " ctx=%s tracepoint=%s" % (ctx_id, tp_id))

resource()

Provide resource.

:return: the provided resource

Source code in deep/api/plugin/python.py 
53
54
55
56
57
58
59
60
61
def resource(self) -> Optional[Resource]:
    """
    Provide resource.

    :return: the provided resource
    """
    return Resource({
        "python_version": platform.python_version(),
    })