tap

Documentation

Index

• Variables
• type GrpcService
  • func (*GrpcService) Descriptor() ([]byte, []int)
  • func (x *GrpcService) GetTapServer() *core.ResourceRef
  • func (*GrpcService) ProtoMessage()
  • func (x *GrpcService) ProtoReflect() protoreflect.Message
  • func (x *GrpcService) Reset()
  • func (x *GrpcService) String() string
• type HttpService
  • func (*HttpService) Descriptor() ([]byte, []int)
  • func (x *HttpService) GetTapServer() *core.ResourceRef
  • func (x *HttpService) GetTimeout() *duration.Duration
  • func (*HttpService) ProtoMessage()
  • func (x *HttpService) ProtoReflect() protoreflect.Message
  • func (x *HttpService) Reset()
  • func (x *HttpService) String() string
• type Sink
  • func (*Sink) Descriptor() ([]byte, []int)
  • func (x *Sink) GetGrpcService() *GrpcService
  • func (x *Sink) GetHttpService() *HttpService
  • func (m *Sink) GetSinkType() isSink_SinkType
  • func (*Sink) ProtoMessage()
  • func (x *Sink) ProtoReflect() protoreflect.Message
  • func (x *Sink) Reset()
  • func (x *Sink) String() string
• type Sink_GrpcService
• type Sink_HttpService
• type Tap
  • func (*Tap) Descriptor() ([]byte, []int)
  • func (x *Tap) GetMaxBufferedRxBytes() *wrappers.UInt32Value
  • func (x *Tap) GetMaxBufferedTxBytes() *wrappers.UInt32Value
  • func (x *Tap) GetRecordDownstreamConnection() *wrappers.BoolValue
  • func (x *Tap) GetRecordHeadersReceivedTime() *wrappers.BoolValue
  • func (x *Tap) GetSinks() []*Sink
  • func (*Tap) ProtoMessage()
  • func (x *Tap) ProtoReflect() protoreflect.Message
  • func (x *Tap) Reset()
  • func (x *Tap) String() string

Variables

var File_github_com_solo_io_gloo_projects_gloo_api_v1_enterprise_options_tap_tap_proto protoreflect.FileDescriptor

Types

type GrpcService

type GrpcService struct {

	// Upstream reference to the tap server
	TapServer *core.ResourceRef `protobuf:"bytes,1,opt,name=tap_server,json=tapServer,proto3" json:"tap_server,omitempty"`
	// contains filtered or unexported fields
}

A tap sink over a GRPC service

func (*GrpcService) Descriptor

func (*GrpcService) Descriptor() ([]byte, []int)

Deprecated: Use GrpcService.ProtoReflect.Descriptor instead.

func (*GrpcService) GetTapServer

func (x *GrpcService) GetTapServer() *core.ResourceRef

func (*GrpcService) ProtoMessage

func (*GrpcService) ProtoMessage()

func (*GrpcService) ProtoReflect

func (x *GrpcService) ProtoReflect() protoreflect.Message

func (*GrpcService) Reset

func (x *GrpcService) Reset()

func (*GrpcService) String

func (x *GrpcService) String() string

type HttpService

type HttpService struct {

	// Upstream reference to the tap server
	TapServer *core.ResourceRef `protobuf:"bytes,1,opt,name=tap_server,json=tapServer,proto3" json:"tap_server,omitempty"`
	// Connection timeout
	Timeout *duration.Duration `protobuf:"bytes,2,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// contains filtered or unexported fields
}

A tap sink over a HTTP service

func (*HttpService) Descriptor

func (*HttpService) Descriptor() ([]byte, []int)

Deprecated: Use HttpService.ProtoReflect.Descriptor instead.

func (*HttpService) GetTapServer

func (x *HttpService) GetTapServer() *core.ResourceRef

func (*HttpService) GetTimeout

func (x *HttpService) GetTimeout() *duration.Duration

func (*HttpService) ProtoMessage

func (*HttpService) ProtoMessage()

func (*HttpService) ProtoReflect

func (x *HttpService) ProtoReflect() protoreflect.Message

func (*HttpService) Reset

func (x *HttpService) Reset()

func (*HttpService) String

func (x *HttpService) String() string

type Sink

type Sink struct {

	// The type of the output sink to which tap data should be written
	//
	// Types that are assignable to SinkType:
	//
	//	*Sink_GrpcService
	//	*Sink_HttpService
	SinkType isSink_SinkType `protobuf_oneof:"SinkType"`
	// contains filtered or unexported fields
}

func (*Sink) Descriptor

func (*Sink) Descriptor() ([]byte, []int)

Deprecated: Use Sink.ProtoReflect.Descriptor instead.

func (*Sink) GetGrpcService

func (x *Sink) GetGrpcService() *GrpcService

func (*Sink) GetHttpService

func (x *Sink) GetHttpService() *HttpService

func (*Sink) GetSinkType

func (m *Sink) GetSinkType() isSink_SinkType

func (*Sink) ProtoMessage

func (*Sink) ProtoMessage()

func (*Sink) ProtoReflect

func (x *Sink) ProtoReflect() protoreflect.Message

func (*Sink) Reset

func (x *Sink) Reset()

func (*Sink) String

func (x *Sink) String() string

type Sink_GrpcService

type Sink_GrpcService struct {
	// Write tap data out to a GRPC service
	GrpcService *GrpcService `protobuf:"bytes,1,opt,name=grpc_service,json=grpcService,proto3,oneof"`
}

type Sink_HttpService

type Sink_HttpService struct {
	// Write tap data out to a HTTP service
	HttpService *HttpService `protobuf:"bytes,2,opt,name=http_service,json=httpService,proto3,oneof"`
}

type Tap

type Tap struct {

	// Sinks to which tap data should be output. Currently, only a single sink
	// is supported.
	Sinks []*Sink `protobuf:"bytes,1,rep,name=sinks,proto3" json:"sinks,omitempty"`
	// 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.
	MaxBufferedRxBytes *wrappers.UInt32Value `protobuf:"bytes,2,opt,name=max_buffered_rx_bytes,json=maxBufferedRxBytes,proto3" json:"max_buffered_rx_bytes,omitempty"`
	// 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.
	MaxBufferedTxBytes *wrappers.UInt32Value `protobuf:"bytes,3,opt,name=max_buffered_tx_bytes,json=maxBufferedTxBytes,proto3" json:"max_buffered_tx_bytes,omitempty"`
	// 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.
	RecordHeadersReceivedTime *wrappers.BoolValue `` /* 140-byte string literal not displayed */
	// Indicates whether report downstream connection info
	RecordDownstreamConnection *wrappers.BoolValue `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*Tap) Descriptor

func (*Tap) Descriptor() ([]byte, []int)

Deprecated: Use Tap.ProtoReflect.Descriptor instead.

func (*Tap) GetMaxBufferedRxBytes

func (x *Tap) GetMaxBufferedRxBytes() *wrappers.UInt32Value

func (*Tap) GetMaxBufferedTxBytes

func (x *Tap) GetMaxBufferedTxBytes() *wrappers.UInt32Value

func (*Tap) GetRecordDownstreamConnection

func (x *Tap) GetRecordDownstreamConnection() *wrappers.BoolValue

func (*Tap) GetRecordHeadersReceivedTime

func (x *Tap) GetRecordHeadersReceivedTime() *wrappers.BoolValue

func (*Tap) GetSinks

func (x *Tap) GetSinks() []*Sink

func (*Tap) ProtoMessage

func (*Tap) ProtoMessage()

func (*Tap) ProtoReflect

func (x *Tap) ProtoReflect() protoreflect.Message

func (*Tap) Reset

func (x *Tap) Reset()

func (*Tap) String

func (x *Tap) String() string