tap.proto

Package: tap.options.gloo.solo.io

Types:

Source File: github.com/solo-io/gloo/projects/gloo/api/v1/enterprise/options/tap/tap.proto

Tap

Tap filter: a filter that copies the contents of HTTP requests and responses to an external tap server. The full HTTP headers and bodies are reported in full to the configured address, and data can be reported using either over HTTP or GRPC.

"sinks": []tap.options.gloo.solo.io.Sink
"maxBufferedRxBytes": .google.protobuf.UInt32Value
"maxBufferedTxBytes": .google.protobuf.UInt32Value
"recordHeadersReceivedTime": .google.protobuf.BoolValue
"recordDownstreamConnection": .google.protobuf.BoolValue

Field Type Description
sinks []tap.options.gloo.solo.io.Sink Sinks to which tap data should be output. Currently, only a single sink is supported.
maxBufferedRxBytes .google.protobuf.UInt32Value 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.
maxBufferedTxBytes .google.protobuf.UInt32Value 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.
recordHeadersReceivedTime .google.protobuf.BoolValue 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.
recordDownstreamConnection .google.protobuf.BoolValue Indicates whether report downstream connection info.

Sink

"grpcService": .tap.options.gloo.solo.io.GrpcService
"httpService": .tap.options.gloo.solo.io.HttpService

Field Type Description
grpcService .tap.options.gloo.solo.io.GrpcService Write tap data out to a GRPC service. Only one of grpcService or httpService can be set.
httpService .tap.options.gloo.solo.io.HttpService Write tap data out to a HTTP service. Only one of httpService or grpcService can be set.

GrpcService

A tap sink over a GRPC service

"tapServer": .core.solo.io.ResourceRef

Field Type Description
tapServer .core.solo.io.ResourceRef Upstream reference to the tap server.

HttpService

A tap sink over a HTTP service

"tapServer": .core.solo.io.ResourceRef
"timeout": .google.protobuf.Duration

Field Type Description
tapServer .core.solo.io.ResourceRef Upstream reference to the tap server.
timeout .google.protobuf.Duration Connection timeout.