viztracer 1.1.0__cp314-cp314-win32.whl

viztracer/cellmagic.py

@@ -0,0 +1,70 @@
+# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
+# For details: https://github.com/gaogaotiantian/viztracer/blob/master/NOTICE.txt
+
+
+def load_ipython_extension(ipython) -> None:
+    """
+    Use `%load_ext viztracer`
+    Lazy execute the following code because importing IPython is slow
+    """
+    from IPython.core.magic import (Magics, cell_magic,  # type: ignore
+                                    magics_class, needs_local_scope)
+    from IPython.core.magic_arguments import (argument, magic_arguments, parse_argstring)  # type: ignore
+
+    @magics_class
+    class VizTracerMagics(Magics):
+        @magic_arguments()
+        @argument("--port", "-p", default=9001, type=int,
+                  help="specify the port vizviewer will use")
+        @argument("--output_file", default="./viztracer_report.json",
+                  help="output file path. End with .json or .html or .gz")
+        @argument("--max_stack_depth", type=int, default=-1,
+                  help="maximum stack depth you want to trace.")
+        @argument("--ignore_c_function", action="store_true", default=False,
+                  help="ignore all c functions including most builtin functions and libraries")
+        @argument("--ignore_frozen", action="store_true", default=False,
+                  help="ignore all functions that are frozen(like import)")
+        @argument("--log_func_args", action="store_true", default=False,
+                  help="log all function arguments, this will introduce large overhead")
+        @argument("--log_print", action="store_true", default=False,
+                  help="replace all print() function to adding an event to the result")
+        @argument("--log_sparse", action="store_true", default=False,
+                  help="log only selected functions with @log_sparse")
+        @needs_local_scope
+        @cell_magic
+        def viztracer(self, line, cell, local_ns) -> None:
+            from IPython.display import display  # type: ignore
+            from ipywidgets import Button  # type: ignore
+
+            from .viewer import ServerThread
+            from .viztracer import VizTracer
+            options = parse_argstring(self.viztracer, line)
+            assert self.shell is not None
+            code = self.shell.transform_cell(cell)
+            file_path = options.output_file
+            tracer_kwargs = {
+                "output_file": file_path,
+                "verbose": 0,
+                "max_stack_depth": options.max_stack_depth,
+                "ignore_c_function": options.ignore_c_function,
+                "ignore_frozen": options.ignore_frozen,
+                "log_func_args": options.log_func_args,
+                "log_print": options.log_print,
+                "log_sparse": options.log_sparse
+            }
+            with VizTracer(**tracer_kwargs):
+                exec(code, local_ns, local_ns)
+
+            def view():  # pragma: no cover
+                server = ServerThread(file_path, port=options.port, once=True)
+                server.start()
+                server.ready.wait()
+                import webbrowser
+                webbrowser.open_new_tab(f'http://127.0.0.1:{server.port}')
+
+            button = Button(description="VizTracer Report")
+            button.on_click(lambda b: view())
+
+            display(button)
+
+    ipython.register_magics(VizTracerMagics)

viztracer/code_monkey.py

@@ -0,0 +1,353 @@
+# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
+# For details: https://github.com/gaogaotiantian/viztracer/blob/master/NOTICE.txt
+
+import ast
+import copy
+import re
+from functools import reduce
+from typing import Any, Callable
+
+from .util import color_print
+
+
+class AstTransformer(ast.NodeTransformer):
+    def __init__(self, inst_type: str, inst_args: dict[str, dict]) -> None:
+        super().__init__()
+        self.inst_type: str = inst_type
+        self.inst_args: dict[str, dict] = inst_args
+        self.curr_lineno: int = 0
+        self.log_func_exec_enable: bool = False
+
+    def visit_Assign(self, node: ast.Assign) -> ast.stmt | list[ast.stmt]:
+        return self._visit_generic_assign(node)
+
+    def visit_AugAssign(self, node: ast.AugAssign) -> ast.stmt | list[ast.stmt]:
+        return self._visit_generic_assign(node)
+
+    def visit_AnnAssign(self, node: ast.AnnAssign) -> ast.stmt | list[ast.stmt]:
+        return self._visit_generic_assign(node)
+
+    def visit_FunctionDef(self, node: ast.FunctionDef) -> ast.FunctionDef:
+        if self.inst_type == "log_func_exec":
+            for funcname in self.inst_args["funcnames"]:
+                if re.fullmatch(funcname, node.name):
+                    self.log_func_exec_enable = True
+        elif self.inst_type == "log_func_entry":
+            for funcname in self.inst_args["funcnames"]:
+                if re.fullmatch(funcname, node.name):
+                    node.body.insert(0, self.get_instrument_node("Function Entry", node.name))
+        elif self.inst_type in ("log_var", "log_number"):
+            instrumented_nodes: list[ast.stmt] = []
+            args = node.args
+            func_args_name = [a.arg for a in args.posonlyargs + args.args + args.kwonlyargs]
+            if "vararg" in args._fields and args.vararg:
+                func_args_name.append(args.vararg.arg)
+            if "kwarg" in args._fields and args.kwarg:
+                func_args_name.append(args.kwarg.arg)
+            for name in func_args_name:
+                for pattern in self.inst_args["varnames"]:
+                    if re.fullmatch(pattern, name):
+                        instrumented_nodes.append(self.get_instrument_node("Variable Assign", name))
+                        break
+
+        self.generic_visit(node)
+
+        if self.inst_type == "log_func_exec":
+            self.log_func_exec_enable = False
+        elif self.inst_type in ("log_var", "log_number") and instrumented_nodes:
+            node.body = instrumented_nodes + node.body
+        return node
+
+    def visit_For(self, node: ast.For) -> ast.For:
+        if self.inst_type in ("log_var", "log_number"):
+            instrumented_nodes = self.get_assign_log_nodes(node.target)
+
+        self.generic_visit(node)
+
+        if self.inst_type in ("log_var", "log_number"):
+            if instrumented_nodes:
+                node.body = instrumented_nodes + node.body
+        return node
+
+    def visit_Raise(self, node: ast.Raise) -> ast.AST | list[ast.AST]:
+        if self.inst_type == "log_exception":
+            instrument_node = self.get_instrument_node_by_node("Exception", node.exc)
+            return [instrument_node, node]
+        return node
+
+    def _visit_generic_assign(self, node: ast.Assign | ast.AugAssign | ast.AnnAssign) -> list[ast.stmt]:
+        self.generic_visit(node)
+        ret: list[ast.stmt] = [node]
+        self.curr_lineno = node.lineno
+        if self.inst_type in ("log_var", "log_number", "log_attr", "log_func_exec"):
+            if isinstance(node, (ast.AugAssign, ast.AnnAssign)):
+                instrumented_nodes = self.get_assign_log_nodes(node.target)
+                if instrumented_nodes:
+                    ret.extend(instrumented_nodes)
+            elif isinstance(node, ast.Assign):
+                for target in node.targets:
+                    instrumented_nodes = self.get_assign_log_nodes(target)
+                    if instrumented_nodes:
+                        ret.extend(instrumented_nodes)
+        return ret
+
+    def get_assign_targets(self, node: ast.expr) -> list[str]:
+        """
+        :param ast.Node node:
+        """
+        if isinstance(node, ast.Name):
+            return [node.id]
+        elif isinstance(node, (ast.Attribute, ast.Subscript, ast.Starred)):
+            return self.get_assign_targets(node.value)
+        elif isinstance(node, ast.Tuple) or isinstance(node, ast.List):
+            return reduce(lambda a, b: a + b, [self.get_assign_targets(elt) for elt in node.elts])
+        color_print("WARNING", "Unexpected node type {} for ast.Assign. \
+            Please report to the author github.com/gaogaotiantian/viztracer".format(type(node)))
+        return []
+
+    def get_assign_targets_with_attr(self, node: ast.AST) -> list[ast.Attribute]:
+        """
+        :param ast.Node node:
+        """
+        if isinstance(node, ast.Attribute):
+            return [node]
+        elif isinstance(node, (ast.Name, ast.Subscript, ast.Starred)):
+            return []
+        elif isinstance(node, (ast.Tuple, ast.List)):
+            return reduce(lambda a, b: a + b, [self.get_assign_targets_with_attr(elt) for elt in node.elts])
+        color_print("WARNING", "Unexpected node type {} for ast.Assign. \
+            Please report to the author github.com/gaogaotiantian/viztracer".format(type(node)))
+        return []
+
+    def get_assign_log_nodes(self, target: ast.expr) -> list[ast.stmt]:
+        """
+        given a target of any type of Assign, return the instrumented node
+        that log this variable
+        if this target is not supposed to be logged, return []
+        """
+        ret: list[ast.stmt] = []
+        if self.inst_type in ("log_var", "log_number"):
+            target_ids = self.get_assign_targets(target)
+            for target_id in target_ids:
+                for varname in self.inst_args["varnames"]:
+                    if re.fullmatch(varname, target_id):
+                        ret.append(self.get_instrument_node("Variable Assign", target_id))
+                        break
+        elif self.inst_type == "log_attr":
+            target_nodes = self.get_assign_targets_with_attr(target)
+            for target_node in target_nodes:
+                for varname in self.inst_args["varnames"]:
+                    if re.fullmatch(varname, target_node.attr):
+                        ret.append(self.get_instrument_node_by_node("Attribute Assign", target_node))
+                        break
+        elif self.inst_type == "log_func_exec":
+            if self.log_func_exec_enable:
+                target_ids = self.get_assign_targets(target)
+                for target_id in target_ids:
+                    ret.append(self.get_instrument_node("Variable Assign", target_id))
+
+        return ret
+
+    def get_instrument_node(self, trigger: str, name: str) -> ast.Expr:
+        if self.inst_type in ("log_var", "log_number"):
+            if self.inst_type == "log_var":
+                event = "instant"
+            elif self.inst_type == "log_number":
+                event = "counter"
+            return self.get_add_variable_node(
+                name=f"{trigger} - {name}",
+                var_node=ast.Name(id=name, ctx=ast.Load()),
+                event=event,
+            )
+        elif self.inst_type == "log_func_exec":
+            return self.get_add_func_exec_node(
+                name=f"{name}",
+                val=ast.Name(id=name, ctx=ast.Load()),
+                lineno=self.curr_lineno,
+            )
+        elif self.inst_type == "log_func_entry":
+            return self.get_add_variable_node(
+                name=f"{trigger} - {name}",
+                var_node=ast.Constant(value=f"{name} is called"),
+                event="instant",
+            )
+        else:
+            raise ValueError(f"{name} is not supported")
+
+    def get_instrument_node_by_node(self, trigger: str, node: ast.expr | None) -> ast.Expr:
+        var_node: ast.expr
+        if node is None:
+            name = f"{trigger}"
+            var_node = ast.Constant(value=None)
+        else:
+            name = f"{trigger} - {self.get_string_of_expr(node)}"
+            var_node = self.copy_node_with_load(node)
+        return self.get_add_variable_node(
+            name=name,
+            var_node=var_node,
+            event="instant",
+        )
+
+    def get_add_variable_node(self, name: str, var_node: ast.expr, event: str) -> ast.Expr:
+        node_instrument = ast.Expr(
+            value=ast.Call(
+                func=ast.Attribute(
+                    value=ast.Name(id="__viz_tracer__", ctx=ast.Load()),
+                    attr="add_variable",
+                    ctx=ast.Load(),
+                ),
+                args=[
+                    ast.Constant(value=name),
+                    var_node,
+                    ast.Constant(value=event),
+                ],
+                keywords=[],
+            ),
+        )
+        return node_instrument
+
+    def get_add_func_exec_node(self, name: str, val: ast.AST, lineno: int) -> ast.Expr:
+        node_instrument = ast.Expr(
+            value=ast.Call(
+                func=ast.Attribute(
+                    value=ast.Name(id="__viz_tracer__", ctx=ast.Load()),
+                    attr="add_func_exec",
+                    ctx=ast.Load(),
+                ),
+                args=[
+                    ast.Constant(value=name),
+                    ast.Name(id=name, ctx=ast.Load()),
+                    ast.Constant(value=lineno),
+                ],
+                keywords=[],
+            ),
+        )
+        return node_instrument
+
+    def copy_node_with_load(self, node: ast.expr) -> ast.expr:
+        """
+        copy the whole node tree but change all Store to Load
+        """
+        new_node = copy.deepcopy(node)
+        for n in ast.walk(new_node):
+            # Fix Store to Load
+            if "ctx" in n._fields and isinstance(n.ctx, ast.Store):  # type: ignore
+                n.ctx = ast.Load()  # type: ignore
+        return new_node
+
+    def get_string_of_expr(self, node: ast.expr | ast.slice) -> str:
+        """
+        Try to do "unparse" of the node
+        """
+        if isinstance(node, ast.Name):
+            return node.id
+        elif isinstance(node, ast.Constant):
+            return repr(node.value)
+        elif isinstance(node, ast.Attribute):
+            return f"{self.get_string_of_expr(node.value)}.{node.attr}"
+        elif isinstance(node, ast.Subscript):
+            return f"{self.get_string_of_expr(node.value)}[{self.get_string_of_expr(node.slice)}]"
+        elif isinstance(node, ast.Call):
+            return f"{self.get_string_of_expr(node.func)}()"
+        elif isinstance(node, ast.Starred):
+            return f"*{self.get_string_of_expr(node.value)}"
+        elif isinstance(node, ast.Tuple):
+            return f"({','.join([self.get_string_of_expr(elt) for elt in node.elts])})"
+        elif isinstance(node, ast.List):
+            return f"[{','.join([self.get_string_of_expr(elt) for elt in node.elts])}]"
+        elif isinstance(node, ast.Slice):
+            lower = self.get_string_of_expr(node.lower) if "lower" in node._fields and node.lower else ""
+            upper = self.get_string_of_expr(node.upper) if "upper" in node._fields and node.upper else ""
+            step = self.get_string_of_expr(node.step) if "step" in node._fields and node.step else ""
+            if step:
+                return f"{lower}:{upper}:{step}"
+            elif upper:
+                return f"{lower}:{upper}"
+            else:
+                return f"{lower}:"
+        color_print("WARNING", "Unexpected node type {} for ast.Assign. \
+            Please report to the author github.com/gaogaotiantian/viztracer".format(type(node)))
+        return ""
+
+
+class SourceProcessor:
+    """
+    Pre-process comments like #!viztracer: log_instant("event")
+    """
+
+    def process(self, source: Any):
+        if isinstance(source, bytes):
+            source = source.decode("utf-8")
+        elif not isinstance(source, str):
+            return source
+
+        new_lines = []
+
+        for line in source.splitlines():
+            for pattern, transform in self.re_patterns:
+                m = pattern.match(line)
+                if m:
+                    new_lines.append(transform(self, m))
+                    break
+            else:
+                new_lines.append(line)
+
+        return "\n".join(new_lines)
+
+    def line_transform(self, re_match: re.Match) -> str:
+        return f"{re_match.group(1)}__viz_tracer__.{re_match.group(2)}"
+
+    def line_transform_condition(self, re_match: re.Match) -> str:
+        return f"{re_match.group(1)}if {re_match.group(3)}: __viz_tracer__.{re_match.group(2)};"
+
+    def inline_transform(self, re_match: re.Match) -> str:
+        stmt = re_match.group(1)
+        if "=" in stmt:
+            val_assigned = stmt[:stmt.index("=")].strip()
+            return f"{stmt}; __viz_tracer__.log_var('{val_assigned}', ({val_assigned}))"
+        return f"{stmt}; __viz_tracer__.log_instant('{stmt.strip()}')"
+
+    def inline_transform_condition(self, re_match: re.Match) -> str:
+        stmt = re_match.group(1)
+        if "=" in stmt:
+            val_assigned = stmt[:stmt.index("=")].strip()
+            return f"{stmt}; __viz_tracer__.log_var('{val_assigned}', ({val_assigned}), cond={re_match.group(2)})"
+        return f"{stmt}; __viz_tracer__.log_instant('{stmt.strip()}', cond={re_match.group(2)});"
+
+    re_patterns = [
+        # !viztracer: log_var("var", var)
+        (re.compile(r"(\s*)#\s*!viztracer:\s*(log_.*?\(.*\))\s*$"), line_transform),
+        # a = 3  # !viztracer: log
+        (re.compile(r"(.*\S.*)#\s*!viztracer:\s*log\s*$"), inline_transform),
+        # !viztracer: log_var("var", var) if var > 3
+        (re.compile(r"(\s*)#\s*!viztracer:\s*(log_.*?\(.*\))\s*if\s+(.*?)\s*$"), line_transform_condition),
+        # a = 3  # !viztracer: log if a != 3
+        (re.compile(r"(.*\S.*)#\s*!viztracer:\s*log\s*if\s+(.*?)\s*$"), inline_transform_condition),
+    ]
+
+
+class CodeMonkey:
+    def __init__(self, file_name: str) -> None:
+        self.file_name: str = file_name
+        self._compile: Callable = compile
+        self.source_processor: SourceProcessor | None = None
+        self.ast_transformers: list[AstTransformer] = []
+
+    def add_instrument(self, inst_type: str, inst_args: dict[str, dict]) -> None:
+        self.ast_transformers.append(AstTransformer(inst_type, inst_args))
+
+    def add_source_processor(self) -> None:
+        self.source_processor = SourceProcessor()
+
+    def compile(self, source, filename, mode, flags=0, dont_inherit=False, optimize=-1, *, _feature_version=-1):
+        if self.source_processor is not None:
+            source = self.source_processor.process(source)
+        if self.ast_transformers:
+            tree = self._compile(source, filename, mode, flags | ast.PyCF_ONLY_AST,
+                                 dont_inherit, optimize, _feature_version=_feature_version)
+            for trans in self.ast_transformers:
+                trans.visit(tree)
+                ast.fix_missing_locations(tree)
+            return self._compile(tree, filename, mode, flags, dont_inherit, optimize, _feature_version=_feature_version)
+
+        return self._compile(source, filename, mode, flags, dont_inherit, optimize, _feature_version=_feature_version)

viztracer/decorator.py

@@ -0,0 +1,164 @@
+# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
+# For details: https://github.com/gaogaotiantian/viztracer/blob/master/NOTICE.txt
+
+import functools
+import multiprocessing
+import os
+import time
+from typing import Any, Callable, TypeVar, overload
+
+from .viztracer import VizTracer, get_tracer
+
+
+R = TypeVar("R")
+
+
+@overload
+def ignore_function(method: None,
+                    tracer: VizTracer | None = None) -> Callable[[Callable[..., R]], Callable[..., R]]:
+    pass  # pragma: no cover
+
+
+@overload
+def ignore_function(method: Callable[..., R],
+                    tracer: VizTracer | None = None) -> Callable[..., R]:
+    pass  # pragma: no cover
+
+
+def ignore_function(method: Callable[..., R] | None = None,
+                    tracer: VizTracer | None = None) -> Callable[..., R] | Callable[[Callable[..., R]], Callable[..., R]]:
+
+    def inner(func: Callable[..., R]) -> Callable[..., R]:
+
+        @functools.wraps(func)
+        def ignore_wrapper(*args, **kwargs) -> Any:
+            # We need this to keep trace a local variable
+            t = tracer
+            if not t:
+                t = get_tracer()
+                if not t:
+                    raise NameError("ignore_function only works with global tracer")
+            t.pause()
+            ret = func(*args, **kwargs)
+            t.resume()
+            return ret
+
+        return ignore_wrapper
+
+    if method:
+        return inner(method)
+    return inner
+
+
+@overload
+def trace_and_save(method: None,
+                   output_dir: str = "./",
+                   **viztracer_kwargs) -> Callable[[Callable[..., R]], Callable[..., R]]:
+    pass  # pragma: no cover
+
+
+@overload
+def trace_and_save(method: Callable[..., R],
+                   output_dir: str = "./",
+                   **viztracer_kwargs) -> Callable[..., R]:
+    pass  # pragma: no cover
+
+
+def trace_and_save(method: Callable[..., R] | None = None,
+                   output_dir: str = "./",
+                   **viztracer_kwargs) -> Callable[..., R] | Callable[[Callable[..., R]], Callable[..., R]]:
+
+    def inner(func: Callable[..., R]) -> Callable[..., R]:
+
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs) -> Any:
+            tracer = VizTracer(**viztracer_kwargs)
+            tracer.start()
+            ret = func(*args, **kwargs)
+            tracer.stop()
+            if not os.path.exists(output_dir):
+                os.mkdir(output_dir)
+            file_name = os.path.join(output_dir, f"result_{func.__name__}_{int(100000 * time.time())}.json")
+            if multiprocessing.get_start_method() == "fork" and not multiprocessing.current_process().daemon:
+                tracer.fork_save(file_name)
+            else:
+                tracer.save(file_name)
+            tracer.clear()
+            return ret
+
+        return wrapper
+
+    if method:
+        return inner(method)
+    return inner
+
+
+def _log_sparse_wrapper(func: Callable, stack_depth: int = 0,
+                        dynamic_tracer_check: bool = False) -> Callable:
+    if not dynamic_tracer_check:
+        tracer = get_tracer()
+        if tracer is None or not tracer.log_sparse:
+            return func
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs) -> Any:
+        local_tracer = get_tracer() if dynamic_tracer_check else tracer
+
+        if local_tracer is None:
+            return func(*args, **kwargs)
+        assert isinstance(local_tracer, VizTracer)
+
+        if local_tracer.log_sparse and not local_tracer.enable:
+            if stack_depth > 0:
+                orig_max_stack_depth = local_tracer.max_stack_depth
+                local_tracer.max_stack_depth = stack_depth
+                local_tracer.start()
+                ret = func(*args, **kwargs)
+                local_tracer.stop()
+                local_tracer.max_stack_depth = orig_max_stack_depth
+                return ret
+            else:
+                start = local_tracer.getts()
+                ret = func(*args, **kwargs)
+                dur = local_tracer.getts() - start
+                code = func.__code__
+                raw_data = {
+                    "ph": "X",
+                    "name": f"{code.co_name} ({code.co_filename}:{code.co_firstlineno})",
+                    "ts": start,
+                    "dur": dur,
+                    "cat": "FEE",
+                }
+                local_tracer.add_raw(raw_data)
+                return ret
+        elif local_tracer.enable and not local_tracer.log_sparse:
+            # The call is made from the module inside, so if `trace_self=False` it will be ignored.
+            # To avoid this behavior, we need to reset the counter `ignore_stack_depth`` and then
+            # recover it
+            return local_tracer.shield_ignore(func, *args, **kwargs)
+        else:
+            return func(*args, **kwargs)
+
+    return wrapper
+
+
+@overload
+def log_sparse(func: None,
+               stack_depth: int = 0,
+               dynamic_tracer_check: bool = False) -> Callable[[Callable[..., R]], Callable[..., R]]:
+    pass  # pragma: no cover
+
+
+@overload
+def log_sparse(func: Callable[..., R],
+               stack_depth: int = 0,
+               dynamic_tracer_check: bool = False) -> Callable[..., R]:
+    pass  # pragma: no cover
+
+
+def log_sparse(func: Callable[..., R] | None = None,
+               stack_depth: int = 0,
+               dynamic_tracer_check: bool = False) -> Callable[..., R] | Callable[[Callable[..., R]], Callable[..., R]]:
+    if func is None:
+        return functools.partial(_log_sparse_wrapper, stack_depth=stack_depth, dynamic_tracer_check=dynamic_tracer_check)
+    return _log_sparse_wrapper(func=func, stack_depth=stack_depth, dynamic_tracer_check=dynamic_tracer_check)

viztracer/event_base.py

@@ -0,0 +1,81 @@
+# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
+# For details: https://github.com/gaogaotiantian/viztracer/blob/master/NOTICE.txt
+
+import functools
+from typing import Any, Callable, Literal
+
+from .viztracer import VizTracer
+
+
+class _EventBase:
+    def __init__(self, tracer: VizTracer, name: str = "", **kwargs) -> None:
+        self._viztracer_tracer: VizTracer = tracer
+        self._viztracer_name: str = name
+        self._viztracer_enable: bool = False
+        self._viztracer_config: dict = {
+            "trigger_on_change": True,
+            "include_attributes": [],
+            "exclude_attributes": [],
+        }
+
+        for key in kwargs:
+            if key in self._viztracer_config:
+                self._viztracer_config[key] = kwargs[key]
+
+        self._viztracer_enable = True
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        self.__dict__[name] = value
+        if not name.startswith("_"):
+            if self._viztracer_enable and self._viztracer_config["trigger_on_change"]:
+                if self._viztracer_config["include_attributes"]:
+                    if name in self._viztracer_config["include_attributes"]:
+                        self._viztracer_log()
+                elif self._viztracer_config["exclude_attributes"]:
+                    if name not in self._viztracer_config["exclude_attributes"]:
+                        self._viztracer_log()
+                else:
+                    self._viztracer_log()
+
+    def _viztracer_get_attr_list(self) -> list[str]:
+        if self._viztracer_config["include_attributes"]:
+            return self._viztracer_config["include_attributes"]
+        else:
+            return [attr for attr in self.__dir__()
+                    if not attr.startswith("_") and attr not in self._viztracer_config["exclude_attributes"]]
+
+    def _viztracer_set_config(self, key: str, value: Any) -> None:
+        if key not in self._viztracer_config:
+            raise ValueError(f"No config named {key}")
+        self._viztracer_config[key] = value
+
+    def config(self, key: str, value: Any) -> None:
+        self._viztracer_set_config(key, value)
+
+    def _viztracer_log(self) -> None:
+        raise NotImplementedError("You should not use _EventBase class directly")
+
+    def log(self) -> None:
+        self._viztracer_log()
+
+    @staticmethod
+    def triggerlog(method: Callable | None = None,
+                   when: Literal["after", "before", "both"] = "after") -> Callable:
+        if when not in ["after", "before", "both"]:
+            raise ValueError(f"when has to be one of 'after', 'before' or 'both', not {when}")
+
+        def inner(func: Callable) -> Callable:
+
+            @functools.wraps(func)
+            def wrapper(self, *args, **kwargs) -> Any:
+                if when in ("before", "both"):
+                    self._viztracer_log()
+                ret = func(self, *args, **kwargs)
+                if when in ("after", "both"):
+                    self._viztracer_log()
+                return ret
+            return wrapper
+
+        if method:
+            return inner(method)
+        return inner