Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add viztracer command for testing targets #1925

Merged
merged 2 commits into from
Aug 24, 2023
Merged

docs: Add viztracer command for testing targets #1925

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3ae7ab
Add viztracer command for testing targets
mjsqu Aug 23, 2023
a585c2f
Update poetry command
edgarrmondragon Aug 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/dev_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,13 +257,14 @@ We've had success using [`viztracer`](https://github.com/gaogaotiantian/viztrace
You can start doing the same in your package. Start by installing `viztracer`.

```console
$ poetry add --dev viztracer
$ poetry add --group dev viztracer
```

Then simply run your package's CLI as normal, preceded by the `viztracer` command

```console
$ poetry run viztracer my-tap
$ poetry run viztracer -- my-target --config=config.json --input=messages.json
```

That command will produce a `result.json` file which you can explore with the `vizviewer` tool.
Expand Down