Skip to content

Commit 8e6fafd

Browse files
committed
docs(readme): update Tracing section with tool usage and example command
- add bash snippet showing how to run tracing example and save trace.json - align Tracing section structure with Profiling section
1 parent c32fa8f commit 8e6fafd

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ The `Profile` method generates raw strings in flamegraph format. Use the `flameg
225225

226226
## Tracing Taskflows
227227

228-
To capture Chrome Trace events, enable the tracer with `WithTracer()`, then call `Trace`:
228+
To trace a taskflow, first enable the tracer with `WithTracer()`, then call `Trace`:
229229

230230
```go
231231
executor := gtf.NewExecutor(1000, gtf.WithTracer())
@@ -236,7 +236,7 @@ if err := executor.Trace(os.Stdout); err != nil {
236236
}
237237
```
238238

239-
The output is in [Chrome Trace Event format](https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU). Open it in `chrome://tracing` or [Perfetto UI](https://ui.perfetto.dev/) for visualization.
239+
The `Trace` method outputs JSON in [Chrome Trace Event format](https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU). Open it in `chrome://tracing` or [Perfetto UI](https://ui.perfetto.dev/) for visualization.
240240

241241
## Stargazer
242242

0 commit comments

Comments
 (0)