docs(trace): surface the trace span subcommand#2396
Merged
Drarig29 merged 3 commits intoJul 6, 2026
Merged
Conversation
The `trace span` subcommand (report a standalone custom span with a name and a duration or start/end time) ships and has its own README, but it was not discoverable from the top-level command index: the `trace` section only described the command-wrapping form and never mentioned or linked `span`. - List `span` under the `trace` section in the root README, linking its README. - Add a cross-reference from the `trace` README to the `trace span` subcommand. Docs only; no behavior change. Co-Authored-By: Claude Opus 4.8 <[email protected]>
`--start-time` / `--end-time` are epoch milliseconds, i.e. an absolute UTC instant (serialized via `toISOString()`), but "unix epoch" alone can read as ambiguous. Spell out UTC. Co-Authored-By: Claude Opus 4.8 <[email protected]>
Drarig29
approved these changes
Jul 6, 2026
Drarig29
left a comment
Drarig29
left a comment
Contributor
There was a problem hiding this comment.
Good point, LGTM. I just made the front README a bit less verbose
🎉 All green!🧪 All tests passed 🔗 Commit SHA: 401a102 | Docs | Datadog PR Page | Give us feedback! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
The
trace spansubcommand — report a standalone custom span with a name and a duration (or start/end time), without wrapping a command — ships today and has its own README, and it's covered on the official docs page. But it isn't discoverable from the repo's front-door README: thetracesection only describes the command-wrapping form (trace ... -- <cmd>) and never mentions or linksspan. It's easy to forget the subcommand exists.Changes
spanunder thetracesection, linking to its README.traceREADME: add a one-line cross-reference to thetrace spansubcommand.spanREADME: spell out that--start-time/--end-timeepoch milliseconds are UTC (they're serialized viatoISOString()), so there's no timezone ambiguity for readers.Docs only — no code or behavior change.
Note on parameters
I checked the full option surface (
--name,--duration,--start-time,--end-time,--tags,--measures,--dry-run) — all already documented in the span README. The only inherited-but-undocumented flags are--fips/--fips-ignore-error, but no command README in the repo documents those, so I left them out to stay consistent rather than diverge here.🤖 Generated with Claude Code
-- Claudelie