module pixeltable.telemetry

Dependency-free instrumentation hooks. Core pixeltable reports spans (timed, nested units of work) and discrete events through this module; subscribers (e.g. the bridge in opentelemetry-instrumentation-pixeltable) translate them into a telemetry backend. With no subscribers registered every call is a near-free no-op, but hot loops should still guard with if telemetry.active(): before building attribute dicts (or pass attrs as a callable). Spans should cover contiguous units of real computation (a UDF call, a DB insert batch, model loading) or serve as structural containers (operation and exec-node spans). A CPU work span must not contain a yield/await, which would let it cover unrelated interleaved work; awaiting an external call inside a span is fine (the request really is in flight).

func emit()

Signature

emit(name: str, attrs: HookAttrs = None) -> None

Report a discrete event (e.g. a counter increment) to all subscribers.

func span()

Signature

span(
    name: str,
    *,
    level: int = 20,
    parent: SpanHandle | None = None,
    set_current: bool = False,
    **attrs: Any
) -> Iterator[SpanHandle | None]

Context-manager sugar for a lexical-block span. Keyword attrs get a ‘pxt.’ prefix; None values are skipped.

func span_end()

Signature

span_end(
    handle: SpanHandle | None,
    *,
    exc: BaseException | None = None,
    attrs: HookAttrs = None
) -> None

End a span started with span_start(); a no-op for None handles.

func span_start()

Signature

span_start(
    name: str,
    *,
    level: int = 20,
    parent: SpanHandle | None = None,
    set_current: bool = False,
    attrs: HookAttrs = None
) -> SpanHandle | None

Start a span and return its handle; None if no subscribers are registered or the span is suppressed. Spans below the level threshold are suppressed, as are non-set_current spans with no ambient ancestor; descendants of a suppressed span parent to the ambient span. set_current=True makes the span the ambient parent (a ContextVar, so it propagates into asyncio tasks) and requires that span_end() runs on the same thread/context; use capture_context()/restore_context()/exit_context() for explicit thread handoffs.

​module pixeltable.telemetry

​func emit()

​func span()

​func span_end()

​func span_start()

module pixeltable.telemetry

func emit()

func span()

func span_end()

func span_start()