跳转至

Processor interface

TracingProcessor

Bases: ABC

处理 span 的接口。

Source code in agents/tracing/processor_interface.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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
class TracingProcessor(abc.ABC):
    """处理 span 的接口。"""

    @abc.abstractmethod
    def on_trace_start(self, trace: "Trace") -> None:
        """当 trace 开始时调用。

        参数:
            trace: 已开始的 trace。
        """
        pass

    @abc.abstractmethod
    def on_trace_end(self, trace: "Trace") -> None:
        """当 trace 结束时调用。

        参数:
            trace: 已结束的 trace。
        """
        pass

    @abc.abstractmethod
    def on_span_start(self, span: "Span[Any]") -> None:
        """当 span 开始时调用。

        参数:
            span: 已开始的 span。
        """
        pass

    @abc.abstractmethod
    def on_span_end(self, span: "Span[Any]") -> None:
        """当 span 结束时调用。此方法不应阻塞或抛出异常。

        参数:
            span: 已结束的 span。
        """
        pass

    @abc.abstractmethod
    def shutdown(self) -> None:
        """当应用程序停止时调用。"""
        pass

    @abc.abstractmethod
    def force_flush(self) -> None:
        """强制立即刷新所有排队的 span/trace。"""
        pass

on_trace_start abstractmethod 

on_trace_start(trace: Trace) -> None

当 trace 开始时调用。

参数

trace: 已开始的 trace。

Source code in agents/tracing/processor_interface.py 
11
12
13
14
15
16
17
18
@abc.abstractmethod
def on_trace_start(self, trace: "Trace") -> None:
    """当 trace 开始时调用。

    参数:
        trace: 已开始的 trace。
    """
    pass

on_trace_end abstractmethod 

on_trace_end(trace: Trace) -> None

当 trace 结束时调用。

参数

trace: 已结束的 trace。

Source code in agents/tracing/processor_interface.py 
20
21
22
23
24
25
26
27
@abc.abstractmethod
def on_trace_end(self, trace: "Trace") -> None:
    """当 trace 结束时调用。

    参数:
        trace: 已结束的 trace。
    """
    pass

on_span_start abstractmethod 

on_span_start(span: Span[Any]) -> None

当 span 开始时调用。

参数

span: 已开始的 span。

Source code in agents/tracing/processor_interface.py 
29
30
31
32
33
34
35
36
@abc.abstractmethod
def on_span_start(self, span: "Span[Any]") -> None:
    """当 span 开始时调用。

    参数:
        span: 已开始的 span。
    """
    pass

on_span_end abstractmethod 

on_span_end(span: Span[Any]) -> None

当 span 结束时调用。此方法不应阻塞或抛出异常。

参数

span: 已结束的 span。

Source code in agents/tracing/processor_interface.py 
38
39
40
41
42
43
44
45
@abc.abstractmethod
def on_span_end(self, span: "Span[Any]") -> None:
    """当 span 结束时调用。此方法不应阻塞或抛出异常。

    参数:
        span: 已结束的 span。
    """
    pass

shutdown abstractmethod 

shutdown() -> None

当应用程序停止时调用。

Source code in agents/tracing/processor_interface.py 
47
48
49
50
@abc.abstractmethod
def shutdown(self) -> None:
    """当应用程序停止时调用。"""
    pass

force_flush abstractmethod 

force_flush() -> None

强制立即刷新所有排队的 span/trace。

Source code in agents/tracing/processor_interface.py 
52
53
54
55
@abc.abstractmethod
def force_flush(self) -> None:
    """强制立即刷新所有排队的 span/trace。"""
    pass

TracingExporter

Bases: ABC

导出 trace 和 span。例如，可以将它们记录或发送到后端。

Source code in agents/tracing/processor_interface.py 
58
59
60
61
62
63
64
65
66
67
68
class TracingExporter(abc.ABC):
    """导出 trace 和 span。例如，可以将它们记录或发送到后端。"""

    @abc.abstractmethod
    def export(self, items: list["Trace | Span[Any]"]) -> None:
        """导出 trace 和 span 的列表。

        参数:
            items: 要导出的条目。
        """
        pass

export abstractmethod 

export(items: list[Trace | Span[Any]]) -> None

导出 trace 和 span 的列表。

参数

items: 要导出的条目。

Source code in agents/tracing/processor_interface.py 
61
62
63
64
65
66
67
68
@abc.abstractmethod
def export(self, items: list["Trace | Span[Any]"]) -> None:
    """导出 trace 和 span 的列表。

    参数:
        items: 要导出的条目。
    """
    pass