Skip to content

Example telemetry README names spans that are not the ones emitted #20

Description

@adityak74

Found in the telemetry UAT (docs/uat/UAT-telemetry.md, finding I1).

examples/telemetry/README.md documents the span hierarchy as:

agent_run
└── agent_step
    ├── model completion
    └── tool_span

The names actually emitted, confirmed against a live Jaeger instance, are agent_run, agent_step, model_complete, and tool_execute. Someone searching Jaeger for tool_span finds nothing and reasonably concludes the instrumentation is broken.

What to do: correct the four names in examples/telemetry/README.md to match what the code emits. The emitting sites are in zorp-agent/src/agent.rs and zorp-agent/src/model.rs. Worth grepping for the old names in case they appear elsewhere.

Why it is a good first issue: documentation only, the correct values are stated above, and you can verify your change by reading the tracing::info_span! calls in those two files.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions