Skip to content

Commit f9c2dad

Browse files
docs: Add viztracer command for testing targets (#1925)
* Add viztracer command for testing targets When it comes to testing targets it took me a long while to work out I could use the `--input` switch to pass a file of records to the target rather than trying to work out how to run `viztracer` on a command containing a pipe 🤯. If the added line can be proven to work by a reviewer and it's OK to be added to the documentation then it would have saved me heaps of time yesterday 😄 * Update poetry command --------- Co-authored-by: Edgar Ramírez Mondragón <edgar@meltano.com>
1 parent 910163a commit f9c2dad

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/dev_guide.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -257,13 +257,14 @@ We've had success using [`viztracer`](https://github.com/gaogaotiantian/viztrace
257257
You can start doing the same in your package. Start by installing `viztracer`.
258258

259259
```console
260-
$ poetry add --dev viztracer
260+
$ poetry add --group dev viztracer
261261
```
262262

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

265265
```console
266266
$ poetry run viztracer my-tap
267+
$ poetry run viztracer -- my-target --config=config.json --input=messages.json
267268
```
268269

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

0 commit comments

Comments
 (0)