> This page is for version 0.4.0.
> For other versions, use one of these documentation indexes:
> - Main (default): https://docs.nvidia.com/nemo/gym/main/llms.txt
> - 0.7.0: https://docs.nvidia.com/nemo/gym/v0.7.0/llms.txt
> - 0.6.0: https://docs.nvidia.com/nemo/gym/v0.6.0/llms.txt
> - 0.5.1: https://docs.nvidia.com/nemo/gym/v0.5.1/llms.txt
> - 0.5.0: https://docs.nvidia.com/nemo/gym/v0.5.0/llms.txt
> - 0.4.0: https://docs.nvidia.com/nemo/gym/v0.4.0/llms.txt
> - 0.3.0: https://docs.nvidia.com/nemo/gym/v0.3.0/llms.txt
> - 0.2.1: https://docs.nvidia.com/nemo/gym/v0.2.1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/gym/llms.txt.

# nemo_gym.rollouts.tool_telemetry

Tool spans and metrics derived from a finished rollout's v2 trajectory record.

Nothing is measured again: each tool execution the harness recorded becomes a `gym.tool` span under the rollout's
dispatch span, and a count and duration in the tool metrics. A span needs both recorded endpoints and a duration
needs a recorded duration; a missing one is left out, never written as zero.

## Module Contents

### Functions

| Name                                                                               | Description                                                                                  |
| ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| [`_emit_tool_spans`](#nemo_gym-rollouts-tool_telemetry-_emit_tool_spans)           | -                                                                                            |
| [`_span_timing`](#nemo_gym-rollouts-tool_telemetry-_span_timing)                   | -                                                                                            |
| [`_tool_calls`](#nemo_gym-rollouts-tool_telemetry-_tool_calls)                     | -                                                                                            |
| [`record_tool_telemetry`](#nemo_gym-rollouts-tool_telemetry-record_tool_telemetry) | Count a finished rollout's tool executions and, under its dispatch span, emit one span each. |

### Data

[`TOOL_SPAN_NAME`](#nemo_gym-rollouts-tool_telemetry-TOOL_SPAN_NAME)

[`_SPAN_BOUNDARY_ORDER`](#nemo_gym-rollouts-tool_telemetry-_SPAN_BOUNDARY_ORDER)

[`logger`](#nemo_gym-rollouts-tool_telemetry-logger)

### API

```python
nemo_gym.rollouts.tool_telemetry._emit_tool_spans(
    tools: list[nemo_gym.trajectory.trajectory_record.TrajectoryToolCall],
    dispatch_span_context: opentelemetry.trace.SpanContext
) -> None
```

```python
nemo_gym.rollouts.tool_telemetry._span_timing(
    tool: nemo_gym.trajectory.trajectory_record.TrajectoryToolCall
) -> typing.Optional[nemo_gym.core.operation_timing.OperationTiming]
```

```python
nemo_gym.rollouts.tool_telemetry._tool_calls(
    result: typing.Mapping[str, typing.Any]
) -> list[nemo_gym.trajectory.trajectory_record.TrajectoryToolCall]
```

```python
nemo_gym.rollouts.tool_telemetry.record_tool_telemetry(
    result: typing.Mapping[str, typing.Any],
    dispatch_span_context: typing.Optional[opentelemetry.trace.SpanContext]
) -> None
```

Count a finished rollout's tool executions and, under its dispatch span, emit one span each.

A tool whose recorded parent is another tool goes under that tool's span; parents are emitted first, and the
record guarantees there are no cycles. Never raises: telemetry must not fail a rollout.

```python
nemo_gym.rollouts.tool_telemetry.TOOL_SPAN_NAME = 'gym.tool'
```

```python
nemo_gym.rollouts.tool_telemetry._SPAN_BOUNDARY_ORDER = ('executor', 'lifecycle', 'transcript', 'event_receipt')
```

```python
nemo_gym.rollouts.tool_telemetry.logger = logging.getLogger(__name__)
```