ros2caret.verb.caret_record_init module

ros2caret.verb.caret_record_init.init(*, session_name: str, base_path: str | None, ros_events: List[str], kernel_events: List[str], context_fields: List[str], subbuffer_size_ust: int, subbuffer_size_kernel: int, display_list: bool = False, append_trace: bool = True, immediate: bool = False) → bool

Init and start tracing.

Raises RuntimeError on failure, in which case the tracing session might still exist.

Parameters:

• session_name – the name of the session

• base_path – the path to the directory in which to create the tracing session directory, or None for default

• append_trace – whether to append to the trace directory if it already exists, otherwise an error is reported

• ros_events – list of ROS events to enable

• kernel_events – list of kernel events to enable

• context_fields – list of context fields to enable

• display_list – whether to display list(s) of enabled events and context names

• subbuffer_size_ust – the size of the subbuffers for userspace events

• subbuffer_size_kernel – the size of the subbuffers for kernel events

Returns:

True if successful, False otherwise