Docs

Signed-off-by: Alex Leong <[email protected]>

README.md

@@ -1 +1,25 @@
-# tapshark
+# tapshark
+
+A wireshark inspired ncurses-style command line interface for Linkerd tap.
+
+## Requirements
+
+Requires [Linkerd 2.10.0](https://github.com/linkerd/linkerd2/releases/tag/stable-2.10.0)
+with the [Viz extension](https://linkerd.io/2.10/getting-started/) installed.
+
+## Building
+
+1. Build linkerd-tapshark: `go build -o linkerd-tapshark ./main.go`
+1. Move the binary onto your PATH: `mv linkerd-tapshark ~/.linkerd2/bin/`
+
+## Usage
+
+```
+linkerd tapshark
+```
+
+Tapshark accepts the same flags as [linkerd tap](https://linkerd.io/2.10/reference/cli/viz/index.html#tap).
+
+Use the arrow keys the browse requests.  Press enter to see details for the
+selected request.  Press tab to switch focus between the top and bottom pane.
+Ctrl-c to exit.

cmd/tapshark.go

@@ -89,13 +89,13 @@ func NewCmdTapShark() *cobra.Command {
   * statefulsets
   * services (only supported as a --to resource)`,
 		Example: `  # tap the web deployment in the default namespace
-  linkerd viz tapshark deploy/web
+  linkerd tapshark deploy/web
 
   # tap the web-dlbvj pod in the default namespace
-  linkerd viz tapshark pod/web-dlbvj
+  linkerd tapshark pod/web-dlbvj
 
   # tap the test namespace, filter by request to prod namespace
-  linkerd viz tapshark ns/test --to ns/prod`,
+  linkerd tapshark ns/test --to ns/prod`,
 		Args:      cobra.RangeArgs(1, 2),
 		ValidArgs: vizpkg.ValidTargets,
 		RunE: func(cmd *cobra.Command, args []string) error {

pkg/tap.go

@@ -13,6 +13,8 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
+// Event collation logic copied from https://github.com/linkerd/linkerd2/blob/main/viz/cmd/top.go
+
 type (
 	Stream struct {
 		Event   *tapPb.TapEvent