harnest.tracing

All Python modules · Import and compatibility guidance

Exports

Name	Kind
`Tracer`	Class
`current_trace_ids`	Function
`get_tracer`	Function
`span`	Function
`traced`	Function

Tracer

Dynamic tracer that remains valid before runtime configuration.

Tracer(name: str, version: str | None = None) -> None

Parameters and example

Parameter	Type	Default
`name`	`str`	Required
`version`	`str \| None`	`None`

from harnest.tracing import Tracer

tracer = Tracer(name=...)

Tracer.start_as_current_span

Tracer.start_as_current_span(name: str, **kwargs: Any) -> Any

Start and activate a span using the current telemetry provider.

Parameters and example

Parameter	Type	Default
`name`	`str`	Required
`**kwargs`	`Any`	Optional

from harnest.tracing import Tracer

tracer: Tracer
result = tracer.start_as_current_span(name=...)

Tracer.start_span

Tracer.start_span(name: str, **kwargs: Any) -> Any

Start a span without making it current in this execution context.

Parameters and example

Parameter	Type	Default
`name`	`str`	Required
`**kwargs`	`Any`	Optional

from harnest.tracing import Tracer

tracer: Tracer
result = tracer.start_span(name=...)

current_trace_ids

Return zero-padded W3C trace and span identifiers when recording.

current_trace_ids() -> tuple[str | None, str | None]

Example

from harnest.tracing import current_trace_ids

result = current_trace_ids()

get_tracer

Return a dynamic tracer safe to create at module import time.

get_tracer(name: str = 'agent', version: str | None = None) -> Tracer

Parameters and example

Parameter	Type	Default
`name`	`str`	`'agent'`
`version`	`str \| None`	`None`

from harnest.tracing import get_tracer

tracer = get_tracer()

span

Start a current agent span carrying structured attributes.

span(
    name: str,
    *,
    attributes: Mapping[str, Any] | None = None,
    kind: Any | None = None,
    **attribute_values: Any,
) -> Iterator[Any]

Parameters and example

Parameter	Type	Default
`name`	`str`	Required
`attributes`	`Mapping[str, Any] \| None`	`None`
`kind`	`Any \| None`	`None`
`**attribute_values`	`Any`	Optional

from harnest.tracing import span

with span(name=...):
    ...

traced

Trace a synchronous or asynchronous authored function.

traced(
    name: str | None = None,
    *,
    attributes: Mapping[str, Any] | None = None,
    kind: Any | None = None,
    **attribute_values: Any,
) -> Callable[[_T], _T]

Parameters and example

Parameter	Type	Default
`name`	`str \| None`	`None`
`attributes`	`Mapping[str, Any] \| None`	`None`
`kind`	`Any \| None`	`None`
`**attribute_values`	`Any`	Optional

from harnest.tracing import traced

@traced()
def my_function():
    ...

Overview

Get started

Harnest Studio

Guides

API reference

harnest.tracing

Exports

Tracer

Tracer.start_as_current_span

Tracer.start_span

current_trace_ids

get_tracer

span

traced

​Exports

​Tracer

​Tracer.start_as_current_span

​Tracer.start_span

​current_trace_ids

​get_tracer

​span

​traced

Exports

Tracer

Tracer.start_as_current_span

Tracer.start_span

current_trace_ids

get_tracer

span

traced