rust_tracy_client icon indicating copy to clipboard operation
rust_tracy_client copied to clipboard

Docs do not explain what a tracy span is

Open ctsrc opened this issue 1 year ago • 1 comments

https://docs.rs/tracy-client/latest/tracy_client/macro.span.html

It is not clear from the rust tracy client docs what a "Tracy span" is.

If we take a look in Tracy itself, they only mention the word "span" four times in their own documentation pdf.

Things that are not clear:

  • Is a Tracy span related to tokio tracing (crate tracing) span?

  • Are Tracy spans used together with Tracy frames? Or are Tracy spans and Tracy frames orthogonal to one-another?

  • When running Tracy connected to rust tracy client, where in Tracy can you see the beginnings, ends and durations of the spans you define using the rust tracy client?

ctsrc avatar Sep 30 '23 17:09 ctsrc

A fair observation. Tracy itself refers to a concept of span (as tracing calls it) as zones. And yeah, this name ended up being imported from the tracing ecosystem more so than from the Tracy one, although now that you point it out it would have been more sensible to call these zones instead.

Does that help (in combination with the Tracy manual) to figure out the answer to the remaining questions?

(Also, sorry for the late answer T_T)

nagisa avatar Nov 21 '23 23:11 nagisa