[1.17] Expose max_buffered_{rx/tx}_bytes in the Tap filter (#9656) (#…

…10016) (#10032) Co-authored-by: soloio-bulldozer[bot] <48420018+soloio-bulldozer[bot]@users.noreply.github.com>
solo-io · Sep 13, 2024 · 7382c11 · 7382c11
1 parent ba7a549
commit 7382c11
Show file tree

Hide file tree

Showing 7 changed files with 224 additions and 51 deletions.
diff --git a/changelog/v1.17.8/new-fields-for-tap-filter.yaml b/changelog/v1.17.8/new-fields-for-tap-filter.yaml
@@ -0,0 +1,9 @@
+changelog:
+  - type: FIX
+    issueLink: https://github.com/solo-io/gloo/issues/9656
+    resolvesIssue: false
+    description: >-
+      Expose max_buffered_{rx/tx}_bytes, record_headers_received_time
+      and record_downstream_connection settings for the Tap filter config.
+      Backported from v1.18 and this feature will be backported to
+      Enterprise version v1.17.2
diff --git a/...ub.com/solo-io/gloo/projects/gloo/api/v1/enterprise/options/tap/tap.proto.sk.md b/...ub.com/solo-io/gloo/projects/gloo/api/v1/enterprise/options/tap/tap.proto.sk.md
diff --git a/install/helm/gloo/crds/gateway.solo.io_v1_Gateway.yaml b/install/helm/gloo/crds/gateway.solo.io_v1_Gateway.yaml
@@ -1295,6 +1295,22 @@ spec:
                         type: object
                       tap:
                         properties:
+                          maxBufferedRxBytes:
+                            maximum: 4294967295
+                            minimum: 0
+                            nullable: true
+                            type: integer
+                          maxBufferedTxBytes:
+                            maximum: 4294967295
+                            minimum: 0
+                            nullable: true
+                            type: integer
+                          recordDownstreamConnection:
+                            nullable: true
+                            type: boolean
+                          recordHeadersReceivedTime:
+                            nullable: true
+                            type: boolean
                           sinks:
                             items:
                               properties:
@@ -3220,6 +3236,22 @@ spec:
                                   type: object
                                 tap:
                                   properties:
+                                    maxBufferedRxBytes:
+                                      maximum: 4294967295
+                                      minimum: 0
+                                      nullable: true
+                                      type: integer
+                                    maxBufferedTxBytes:
+                                      maximum: 4294967295
+                                      minimum: 0
+                                      nullable: true
+                                      type: integer
+                                    recordDownstreamConnection:
+                                      nullable: true
+                                      type: boolean
+                                    recordHeadersReceivedTime:
+                                      nullable: true
+                                      type: boolean
                                     sinks:
                                       items:
                                         properties:

diff --git a/install/helm/gloo/crds/gateway.solo.io_v1_HttpListenerOption.yaml b/install/helm/gloo/crds/gateway.solo.io_v1_HttpListenerOption.yaml
@@ -1286,6 +1286,22 @@ spec:
                     type: object
                   tap:
                     properties:
+                      maxBufferedRxBytes:
+                        maximum: 4294967295
+                        minimum: 0
+                        nullable: true
+                        type: integer
+                      maxBufferedTxBytes:
+                        maximum: 4294967295
+                        minimum: 0
+                        nullable: true
+                        type: integer
+                      recordDownstreamConnection:
+                        nullable: true
+                        type: boolean
+                      recordHeadersReceivedTime:
+                        nullable: true
+                        type: boolean
                       sinks:
                         items:
                           properties:

diff --git a/install/helm/gloo/crds/gateway.solo.io_v1_MatchableHttpGateway.yaml b/install/helm/gloo/crds/gateway.solo.io_v1_MatchableHttpGateway.yaml
@@ -1289,6 +1289,22 @@ spec:
                         type: object
                       tap:
                         properties:
+                          maxBufferedRxBytes:
+                            maximum: 4294967295
+                            minimum: 0
+                            nullable: true
+                            type: integer
+                          maxBufferedTxBytes:
+                            maximum: 4294967295
+                            minimum: 0
+                            nullable: true
+                            type: integer
+                          recordDownstreamConnection:
+                            nullable: true
+                            type: boolean
+                          recordHeadersReceivedTime:
+                            nullable: true
+                            type: boolean
                           sinks:
                             items:
                               properties:

diff --git a/projects/gloo/api/v1/enterprise/options/tap/tap.proto b/projects/gloo/api/v1/enterprise/options/tap/tap.proto
@@ -6,6 +6,7 @@ option go_package = "github.com/solo-io/gloo/projects/gloo/pkg/api/v1/options/ta
 
 import "github.com/solo-io/solo-kit/api/v1/ref.proto";
 import "validate/validate.proto";
+import "google/protobuf/wrappers.proto";
 import "google/protobuf/duration.proto";
 
 // Tap filter: a filter that copies the contents of HTTP requests and responses
@@ -16,6 +17,24 @@ message Tap {
   // Sinks to which tap data should be output. Currently, only a single sink
   // is supported.
   repeated Sink sinks = 1 [(validate.rules).repeated = {max_items: 1, min_items: 1}];
+
+  // For buffered tapping, the maximum amount of received body that will be buffered
+  // prior to truncation. If truncation occurs, the truncated field will be set.
+  // If not specified, the default is 1KiB.
+  google.protobuf.UInt32Value max_buffered_rx_bytes = 2;
+
+  // For buffered tapping, the maximum amount of transmitted body that will be buffered
+  // prior to truncation. If truncation occurs, the truncated field will be set.
+  // If not specified, the default is 1KiB.
+  google.protobuf.UInt32Value max_buffered_tx_bytes = 3;
+
+  // Indicates whether tap filter records the time stamp for request/response headers.
+  // Request headers time stamp is stored after receiving request headers.
+  // Response headers time stamp is stored after receiving response headers.
+  google.protobuf.BoolValue record_headers_received_time = 4;
+
+  // Indicates whether report downstream connection info
+  google.protobuf.BoolValue record_downstream_connection = 5;
 }
 
 message Sink {