update recorder

go-gost · Sep 20, 2024 · 96feee4 · 96feee4
1 parent 251a7c5
commit 96feee4
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/docs/concepts/recorder.md b/docs/concepts/recorder.md
@@ -195,7 +195,7 @@ services:
 }
 ```
 
-对于能够处理HTTP流量的处理器会在`http`字段中额外记录HTTP请求和响应信息
+对于能够处理HTTP流量的处理器，会在`http`字段中额外记录HTTP请求和响应信息
 
 ```json
 {"service":"service-0","network":"tcp",
@@ -210,6 +210,19 @@ services:
 }
 ```
 
+对于能够处理TLS流量的处理器，会在`tls`字段中额外记录TLS握手信息
+
+```json
+{"service":"service-0","network":"tcp",
+"remote":"127.0.0.1:50144","local":"127.0.0.1:443",
+"host":"www.google.com:443","clientIP":"127.0.0.1",
+"tls":{"serverName":"www.google.com","cipherSuite":"TLS_AES_256_GCM_SHA384","compressionMethod":0,"proto":"h2","version":"tls.1.3"},
+"duration":2091323186,
+"time":"2024-09-16T16:53:19.235320555+08:00",
+"sid":"crmjfvqohhhgqqu0f0h0"
+}
+```
+
 对于DNS处理器会在`dns`字段中记录DNS请求和响应信息
 
 ```json

diff --git a/en/docs/concepts/recorder.md b/en/docs/concepts/recorder.md
@@ -206,6 +206,19 @@ For handlers that can handle HTTP traffic, HTTP request and response will be add
 }
 ```
 
+For handlers that can handle TLS traffic, TLS handshake will be additionally recorded in the `tls` field
+
+```json
+{"service":"service-0","network":"tcp",
+"remote":"127.0.0.1:50144","local":"127.0.0.1:443",
+"host":"www.google.com:443","clientIP":"127.0.0.1",
+"tls":{"serverName":"www.google.com","cipherSuite":"TLS_AES_256_GCM_SHA384","compressionMethod":0,"proto":"h2","version":"tls.1.3"},
+"duration":2091323186,
+"time":"2024-09-16T16:53:19.235320555+08:00",
+"sid":"crmjfvqohhhgqqu0f0h0"
+}
+```
+
 The DNS handler will record DNS request and response information in the `dns` field
 
 ```json