Skip to content

CodeCaptureConfiguration

Source code in docs_src/capo_application_signals/types/code_capture_configuration.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class CodeCaptureConfiguration(TypedDict, closed=True):
    capture_arguments: NotRequired[
        "capo_application_signals.types.string_list.StringList"
    ]
    """<p>The function arguments to capture. Omit to capture defaults, use an empty list to capture none, use <code>["*"]</code> to capture all arguments, or specify argument names to capture selectively (up to 10 entries).</p>"""
    capture_return: NotRequired["bool"]
    """<p>Whether to capture the return value. Defaults to false.</p>"""
    capture_stack_trace: NotRequired["bool"]
    """<p>Whether to capture a stack trace when the instrumentation point is hit. Defaults to true.</p>"""
    capture_locals: NotRequired["capo_application_signals.types.string_list.StringList"]
    """<p>The local variables to capture by name. Omit or pass an empty list to capture none. You can specify up to 20 names.</p>"""
    capture_limits: (
        "capo_application_signals.types.capture_limits_config.CaptureLimitsConfig"
    )
    """<p>Safety limits that bound what is captured, including hit counts, string length, collection depth, and stack trace size.</p>"""

capture_arguments instance-attribute 

capture_arguments: NotRequired[StringList]

The function arguments to capture. Omit to capture defaults, use an empty list to capture none, use ["*"] to capture all arguments, or specify argument names to capture selectively (up to 10 entries).

capture_limits instance-attribute 

capture_limits: CaptureLimitsConfig

Safety limits that bound what is captured, including hit counts, string length, collection depth, and stack trace size.

capture_locals instance-attribute 

capture_locals: NotRequired[StringList]

The local variables to capture by name. Omit or pass an empty list to capture none. You can specify up to 20 names.

capture_return instance-attribute 

capture_return: NotRequired[bool]

Whether to capture the return value. Defaults to false.

capture_stack_trace instance-attribute 

capture_stack_trace: NotRequired[bool]

Whether to capture a stack trace when the instrumentation point is hit. Defaults to true.