Skip to content

deep.config.tracepoint_config

Maintain the current config of the tracepoints.

ConfigUpdateListener

Bases: ABC

Class to describe a config listener.

Source code in deep/config/tracepoint_config.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
class ConfigUpdateListener(abc.ABC):
    """Class to describe a config listener."""

    @abc.abstractmethod
    def config_change(self, ts: int, old_hash: str, current_hash: str, old_config: List['Trigger'],
                      new_config: List['Trigger']):
        """
        Process an update to the tracepoint config.

        :param ts: the ts of the new config
        :param old_hash: the old config hash
        :param current_hash: the new config hash
        :param old_config: the old config
        :param new_config: the new config
        """
        raise NotImplementedError

config_change(ts, old_hash, current_hash, old_config, new_config) abstractmethod

Process an update to the tracepoint config.

:param ts: the ts of the new config :param old_hash: the old config hash :param current_hash: the new config hash :param old_config: the old config :param new_config: the new config

Source code in deep/config/tracepoint_config.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
@abc.abstractmethod
def config_change(self, ts: int, old_hash: str, current_hash: str, old_config: List['Trigger'],
                  new_config: List['Trigger']):
    """
    Process an update to the tracepoint config.

    :param ts: the ts of the new config
    :param old_hash: the old config hash
    :param current_hash: the new config hash
    :param old_config: the old config
    :param new_config: the new config
    """
    raise NotImplementedError

TracepointConfigService

This service deals with new responses from the LongPoll.

Source code in deep/config/tracepoint_config.py 
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
class TracepointConfigService:
    """This service deals with new responses from the LongPoll."""

    def __init__(self) -> None:
        """Create new tracepoint config service."""
        self._custom: List['Trigger'] = []
        self._tracepoint_config: List['Trigger'] = []
        self._current_hash = None
        self._last_update = 0
        self._task_handler = None
        self._listeners: List[ConfigUpdateListener] = []

    def update_no_change(self, ts):
        """
        Update no change detected.

        This is called when the response says the config has not changed

        :param ts: the ts of the last poll, in ms
        """
        self._last_update = ts

    def update_new_config(self, ts: int, new_hash: str, new_config: List['Trigger']):
        """
        Update to the new config.

        This is called when there is a change in the config, this will trigger a call to all listeners

        :param ts: the ts of the last poll, in ms
        :param new_hash: the new config hash
        :param new_config: the new config values
        """
        old_hash = self._current_hash
        old_config = self._tracepoint_config
        self._last_update = ts
        self._current_hash = new_hash
        self._tracepoint_config = new_config
        self.__trigger_update(old_hash, old_config)

    def __trigger_update(self, old_hash, old_config):
        ts = self._last_update
        if self._task_handler is not None:
            future = self._task_handler.submit_task(self.update_listeners, self._last_update, old_hash,
                                                    self._current_hash, old_config, self._tracepoint_config)
            future.add_done_callback(lambda _: logging.debug("Completed processing new config %s", ts))

    def set_task_handler(self, task_handler):
        """
        Set the task handler to use.

        :param task_handler: the taskhandler
        """
        self._task_handler = task_handler

    def update_listeners(self, ts: int, old_hash: str, current_hash: str, old_config: List['Trigger'],
                         new_config: List['Trigger']):
        """
        Update the registered listeners.

        This is called to update any listeners that the config has changed

        :param ts: the ts of the update
        :param old_hash: the old hash
        :param current_hash: the new hash value
        :param old_config: the old config
        :param new_config: the new config
        """
        listeners_copy = self._listeners.copy()
        for listeners in listeners_copy:
            try:
                listeners.config_change(ts, old_hash, current_hash, old_config, new_config + self._custom)
            except Exception:
                logging.exception("Error updating listener %s", listeners)

    def add_listener(self, listener: ConfigUpdateListener):
        """
        Add a new listener to the config.

        :param listener: the listener to add
        """
        self._listeners.append(listener)

    @property
    def current_config(self) -> List['Trigger']:
        """
        The current tracepoint config.

        :return: the config
        """
        return self._tracepoint_config

    @property
    def current_hash(self) -> str:
        """
        The current hash.

        The hash is updated only when the config is changed. It is used by the server and client to
        reduce the number of updates.

        :return: the current hash.
        """
        return self._current_hash

    def add_custom(self, path: str, line: int, args: Dict[str, str], watches: List[str],
                   metrics: List[MetricDefinition]) -> str:
        """
        Crate a new tracepoint from the input.

        :param path: the source file name
        :param line: the source line number
        :param args: the tracepoint args
        :param watches: the tracepoint watches
        :param metrics: the tracepoint metrics
        :return: the new TracePointConfig
        """
        config = build_trigger(str(uuid.uuid4()), path, line, args, watches, metrics)
        self._custom.append(config)
        self.__trigger_update(None, None)
        return config.id

    def remove_custom(self, _id: str):
        """
        Remove a custom tracepoint config.

        :param _id: the id of the config to remove
        """
        for idx, cfg in enumerate(self._custom):
            if cfg.id == _id:
                del self._custom[idx]
                self.__trigger_update(None, None)
                return

current_config: List[Trigger] property

The current tracepoint config.

:return: the config

current_hash: str property

The current hash.

The hash is updated only when the config is changed. It is used by the server and client to reduce the number of updates.

:return: the current hash.

__init__()

Create new tracepoint config service.

Source code in deep/config/tracepoint_config.py 
52
53
54
55
56
57
58
59
def __init__(self) -> None:
    """Create new tracepoint config service."""
    self._custom: List['Trigger'] = []
    self._tracepoint_config: List['Trigger'] = []
    self._current_hash = None
    self._last_update = 0
    self._task_handler = None
    self._listeners: List[ConfigUpdateListener] = []

add_custom(path, line, args, watches, metrics)

Crate a new tracepoint from the input.

:param path: the source file name :param line: the source line number :param args: the tracepoint args :param watches: the tracepoint watches :param metrics: the tracepoint metrics :return: the new TracePointConfig

Source code in deep/config/tracepoint_config.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
def add_custom(self, path: str, line: int, args: Dict[str, str], watches: List[str],
               metrics: List[MetricDefinition]) -> str:
    """
    Crate a new tracepoint from the input.

    :param path: the source file name
    :param line: the source line number
    :param args: the tracepoint args
    :param watches: the tracepoint watches
    :param metrics: the tracepoint metrics
    :return: the new TracePointConfig
    """
    config = build_trigger(str(uuid.uuid4()), path, line, args, watches, metrics)
    self._custom.append(config)
    self.__trigger_update(None, None)
    return config.id

add_listener(listener)

Add a new listener to the config.

:param listener: the listener to add

Source code in deep/config/tracepoint_config.py 
123
124
125
126
127
128
129
def add_listener(self, listener: ConfigUpdateListener):
    """
    Add a new listener to the config.

    :param listener: the listener to add
    """
    self._listeners.append(listener)

remove_custom(_id)

Remove a custom tracepoint config.

:param _id: the id of the config to remove

Source code in deep/config/tracepoint_config.py 
169
170
171
172
173
174
175
176
177
178
179
def remove_custom(self, _id: str):
    """
    Remove a custom tracepoint config.

    :param _id: the id of the config to remove
    """
    for idx, cfg in enumerate(self._custom):
        if cfg.id == _id:
            del self._custom[idx]
            self.__trigger_update(None, None)
            return

set_task_handler(task_handler)

Set the task handler to use.

:param task_handler: the taskhandler

Source code in deep/config/tracepoint_config.py 
 95
 96
 97
 98
 99
100
101
def set_task_handler(self, task_handler):
    """
    Set the task handler to use.

    :param task_handler: the taskhandler
    """
    self._task_handler = task_handler

update_listeners(ts, old_hash, current_hash, old_config, new_config)

Update the registered listeners.

This is called to update any listeners that the config has changed

:param ts: the ts of the update :param old_hash: the old hash :param current_hash: the new hash value :param old_config: the old config :param new_config: the new config

Source code in deep/config/tracepoint_config.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def update_listeners(self, ts: int, old_hash: str, current_hash: str, old_config: List['Trigger'],
                     new_config: List['Trigger']):
    """
    Update the registered listeners.

    This is called to update any listeners that the config has changed

    :param ts: the ts of the update
    :param old_hash: the old hash
    :param current_hash: the new hash value
    :param old_config: the old config
    :param new_config: the new config
    """
    listeners_copy = self._listeners.copy()
    for listeners in listeners_copy:
        try:
            listeners.config_change(ts, old_hash, current_hash, old_config, new_config + self._custom)
        except Exception:
            logging.exception("Error updating listener %s", listeners)

update_new_config(ts, new_hash, new_config)

Update to the new config.

This is called when there is a change in the config, this will trigger a call to all listeners

:param ts: the ts of the last poll, in ms :param new_hash: the new config hash :param new_config: the new config values

Source code in deep/config/tracepoint_config.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def update_new_config(self, ts: int, new_hash: str, new_config: List['Trigger']):
    """
    Update to the new config.

    This is called when there is a change in the config, this will trigger a call to all listeners

    :param ts: the ts of the last poll, in ms
    :param new_hash: the new config hash
    :param new_config: the new config values
    """
    old_hash = self._current_hash
    old_config = self._tracepoint_config
    self._last_update = ts
    self._current_hash = new_hash
    self._tracepoint_config = new_config
    self.__trigger_update(old_hash, old_config)

update_no_change(ts)

Update no change detected.

This is called when the response says the config has not changed

:param ts: the ts of the last poll, in ms

Source code in deep/config/tracepoint_config.py 
61
62
63
64
65
66
67
68
69
def update_no_change(self, ts):
    """
    Update no change detected.

    This is called when the response says the config has not changed

    :param ts: the ts of the last poll, in ms
    """
    self._last_update = ts