You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: linkerd.io/content/2.19/reference/cli/tap.md
+36-17Lines changed: 36 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,43 +3,62 @@ title: "tap"
3
3
description: "CLI reference for the `linkerd tap` command, including usage and flags."
4
4
---
5
5
6
-
## `linkerd tap` Command
6
+
The `linkerd tap` command allows you to observe live traffic to a
7
+
Kubernetes resource in your cluster. It streams real-time request logs
8
+
and helps diagnose network behavior for services managed by Linkerd.
7
9
8
-
The `linkerd tap` command allows you to observe live traffic to a Kubernetes resource in your cluster. It streams real-time request logs and helps diagnose network behavior for services managed by Linkerd.
9
-
10
-
### Usage
10
+
## Usage
11
11
12
12
```bash
13
-
linkerd tap [flags] RESOURCE
13
+
linkerd viz tap [flags] RESOURCE
14
14
```
15
-
-**RESOURCE**: The Kubernetes resource you want to observe. This can be a pod, deployment, or service.
15
+
-**RESOURCE**: The Kubernetes resource you want to observe. This can be
16
+
a pod, deployment, or service.
16
17
17
-
###Important Note on Skipped Ports
18
+
## Important Note on Skipped Ports
18
19
19
20
If a pod is configured with the annotations:
20
21
21
22
-`config.linkerd.io/skip-inbound-ports`
22
23
-`config.linkerd.io/skip-outbound-ports`
23
24
24
-
traffic on those ports bypasses the Linkerd proxy. Because `linkerd tap` observes traffic through the proxy, **traffic on skipped ports cannot be tapped**.
25
+
Traffic on those ports bypasses the Linkerd proxy. Because
26
+
`linkerd tap` observes traffic through the proxy, **traffic on skipped
27
+
ports cannot be tapped**.
28
+
29
+
## Flags
25
30
26
-
### Flags
27
31
| Flag | Description | Default |
28
32
|------|-------------|---------|
29
-
|`-n, --namespace string`| Namespace of the resource |`default`|
30
-
|`--output string`| Output format: `table`, `json`, or `wide`|`table`|
31
-
|`--help`| Show help for tap command | n/a |
33
+
|`--authority`| Display requests with this :authority| n/a |
34
+
|`--max-rps`| Maximum requests per second to tap | n/a |
35
+
|`--method`| Display requests with this HTTP method | n/a |
36
+
|`-n, --namespace string`| Namespace of the specified resource |`default`|
37
+
|`-o, --output string`| Output format. One of: `wide`, `json`, `jsonpath`|`table`|
38
+
|`--path`| Display requests with paths that start with this prefix | n/a |
39
+
|`--scheme`| Display requests with this scheme | n/a |
40
+
|`-l, --selector string`| Selector (label query) to filter on, supports `=`, `==`, `!=`| n/a |
41
+
|`--to`| Display requests to this resource | n/a |
42
+
|`--to-namespace`| Sets the namespace used to lookup the `--to` resource | n/a |
43
+
44
+
## Examples
32
45
33
-
### Examples
34
46
1. Tap traffic for a deployment:
47
+
35
48
```bash
36
-
linkerd tap deploy/web -n emojivoto
49
+
linkerd viz tap deploy/web -n emojivoto
37
50
```
51
+
38
52
2. Tap traffic for a service:
53
+
39
54
```bash
40
-
linkerd tap svc/web -n emojivoto
55
+
linkerd viz tap svc/web -n emojivoto
41
56
```
42
-
### Description
43
-
The `tap` command provides a live feed of proxied requests to a Kubernetes resource. It is commonly used for debugging and observing service-to-service communication within a Linkerd service mesh.
57
+
58
+
## Description
59
+
60
+
The `tap` command provides a live feed of proxied requests to a
61
+
Kubernetes resource. It is commonly used for debugging and observing
62
+
service-to-service communication within a Linkerd service mesh.
0 commit comments