observability_utils

一组函数，用于减少将基于OpenTelemetry的可观察性添加到您的Python服务或模块所需的模板代码。

目前提供的实用函数不多，但随着更多可观察性代码添加到我们的服务和模块中，希望这将成为常用代码片段的标准存放位置。

初始版本提供以下实用函数

• setup_tracing(name) - 使用标准化的命名约定设置基本跟踪，以便在可视化工具中轻松识别应用程序。
• instrument_fastapi_app(app, name) - 如上设置基本跟踪，然后开启FastAPI调用的自动跟踪。
• set_console_exporter() - 将捕获的跟踪输出到本地控制台/终端，无需观察后端（如Jaeger或Prometheus）即可查看。用于调试和测试很有用。
• get_tracer(name) - 获取当前活动Tracer对象，并使用标准命名约定标记，以便产生的跟踪在应用程序中保持一致。
• get_trace_context() - 获取当前跟踪上下文（这是对库函数的一个更清晰的命名版本）。
• propagate_context_in_stomp_headers(headers, context) - 简化了在支持通过消息总线进行STOMP通信的服务之间传播跟踪上下文。
• retrieve_context_from_stomp_headers(frame) - 简化了支持通过消息总线进行STOMP通信的服务接收跟踪上下文。

用法示例

from fastapi import FastAPI
from observability_utils import instrument_fastapi_app, get_tracer

app = FastAPI(
    docs_url="/docs",
    on_shutdown=[teardown_handler],
    title="My Rest App",
    lifespan=lifespan,
    version=REST_API_VERSION,
)

instrument_fastapi_app(app, "my_rest_app")

TRACER = get_tracer("my_rest_app")

@TRACER.start_as_current_span("my_func",  kind=SpanKind.CLIENT)
def my_func():
    #function body