Skip to content

Commit 1c41df2

Browse files
committed
chore: fix some small typos and external links
1 parent a061ae1 commit 1c41df2

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

modules/guides/pages/debug-network-traffic.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,24 @@
33
:tcpdump: https://www.tcpdump.org/
44
:mitmproxy: https://www.mitmproxy.org/
55

6-
You likely know this problem: Some tools is behaving weird, and you need to debug (often times HTTP/HTTPS or DNS) traffic between Kubernetes Pods.
7-
If the tool would be running on a local machine, one would simply start {tcpdump}[`tcpdump`] and inspect the traffic.
8-
Maybe use {mitmproxy}[`mitmproxy`] as a HTTPS proxy to re-encrypt the HTTPS traffic, so that it is readable.
6+
You likely know this problem: Some tool is behaving weird, and you need to debug (often times HTTP/HTTPS or DNS) traffic between Kubernetes Pods.
7+
If the tool would be running on a local machine, one would simply start {tcpdump}[`tcpdump`{external-link-icon}^] and inspect the traffic.
8+
Maybe use {mitmproxy}[`mitmproxy`{external-link-icon}^] as a HTTPS proxy to re-encrypt the HTTPS traffic, so that `mitmproxy` can inspect the decrypted traffic.
99

1010
However, as we are running in a containerized environment, things are a bit more complicated.
1111
This guide explains you how you can capture and inspect traffic anyway.
1212

1313
There are a few things needed:
1414

15-
1. A sidecar running {tcpdump}[`tcpdump`], capturing the traffic into a file.
15+
1. A sidecar running {tcpdump}[`tcpdump`{external-link-icon}^], capturing the traffic into a file.
1616
2. If TLS (e.g. HTTPS) traffic is involved, the product needs to be configured in such a way, that it writes the TLS session keys into a file.
1717
The key log can be used afterwards to decrypt the TLS traffic.
1818
3. Wireshark to make it easier to inspect the captured traffic.
1919
You can give it the TLS key log and it will automatically decrypt the TLS traffic.
2020
2121
== Simple usage
2222

23-
If you only care about unencrypted communications, you can use this snippet to dump all traffic using {tcpdump}[`tcpdump`].
23+
If you only care about unencrypted communications, you can use this snippet to dump all traffic using {tcpdump}[`tcpdump`{external-link-icon}^].
2424

2525
[source,yaml]
2626
----
@@ -53,7 +53,7 @@ Let's make things a bit more interesting using a real-world example.
5353
Let's assume Superset is behaving weird and we want to debug the network traffic from Superset to Trino, which is using HTTPS.
5454

5555
As of Java 21 the JVM does not respect the `SSLKEYLOGFILE` env var and does not seem to have support to write the TLS key log.
56-
So we need to use a third-party Java agent called https://github.com/neykov/extract-tls-secrets[extract-tls-secrets] for that.
56+
So we need to use a third-party Java agent called https://github.com/neykov/extract-tls-secrets[extract-tls-secrets{external-link-icon}^] for that.
5757

5858
[source,yaml]
5959
----
@@ -149,6 +149,6 @@ image::debug-network-traffic/4.png[]
149149

150150
== Follow-up tips
151151

152-
1. You can filter the packets in the {tcpdump}[`tcpdump`] call to reduce the capture file size.
152+
1. You can filter the packets in the {tcpdump}[`tcpdump`{external-link-icon}^] call to reduce the capture file size.
153153
2. If you do this on a production setup, keep in mind that the dump might contain sensitive data and the TLS keys can be used to decrypt all TLS traffic of this Pod!
154154
3. In case the product uses HTTP 2 (or newer), you need to use a Wireshark filter such as `http2.headers.path == "/nifi-api/flow/current-user"`

0 commit comments

Comments
 (0)