tapv2alpha

package
v1.36.4-20230209150248... Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: unknown License: Apache-2.0 Imports: 10 Imported by: 3

Documentation

Index

Constants

View Source 
const MatchPredicate_AndMatch_case case_MatchPredicate_Rule = 2
View Source 
const MatchPredicate_AnyMatch_case case_MatchPredicate_Rule = 4
View Source 
const MatchPredicate_HttpRequestHeadersMatch_case case_MatchPredicate_Rule = 5
View Source 
const MatchPredicate_HttpRequestTrailersMatch_case case_MatchPredicate_Rule = 6
View Source 
const MatchPredicate_HttpResponseHeadersMatch_case case_MatchPredicate_Rule = 7
View Source 
const MatchPredicate_HttpResponseTrailersMatch_case case_MatchPredicate_Rule = 8
View Source 
const MatchPredicate_NotMatch_case case_MatchPredicate_Rule = 3
View Source 
const MatchPredicate_OrMatch_case case_MatchPredicate_Rule = 1
View Source 
const MatchPredicate_Rule_not_set_case case_MatchPredicate_Rule = 0
View Source 
const OutputSink_FilePerTap_case case_OutputSink_OutputSinkType = 3
View Source 
const OutputSink_OutputSinkType_not_set_case case_OutputSink_OutputSinkType = 0
View Source 
const OutputSink_StreamingAdmin_case case_OutputSink_OutputSinkType = 2
View Source 
const OutputSink_StreamingGrpc_case case_OutputSink_OutputSinkType = 4

Variables

View Source 
var (
	OutputSink_Format_name = map[int32]string{
		0: "JSON_BODY_AS_BYTES",
		1: "JSON_BODY_AS_STRING",
		2: "PROTO_BINARY",
		3: "PROTO_BINARY_LENGTH_DELIMITED",
		4: "PROTO_TEXT",
	}
	OutputSink_Format_value = map[string]int32{
		"JSON_BODY_AS_BYTES":            0,
		"JSON_BODY_AS_STRING":           1,
		"PROTO_BINARY":                  2,
		"PROTO_BINARY_LENGTH_DELIMITED": 3,
		"PROTO_TEXT":                    4,
	}
)

Enum value maps for OutputSink_Format.

View Source 
var File_envoy_service_tap_v2alpha_common_proto protoreflect.FileDescriptor
View Source 
var File_envoy_service_tap_v2alpha_tap_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type FilePerTapSink 

type FilePerTapSink struct {

	// Path prefix. The output file will be of the form <path_prefix>_<id>.pb, where <id> is an
	// identifier distinguishing the recorded trace for stream instances (the Envoy
	// connection ID, HTTP stream ID, etc.).
	PathPrefix string `protobuf:"bytes,1,opt,name=path_prefix,json=pathPrefix,proto3" json:"path_prefix,omitempty"`
	// contains filtered or unexported fields
}

The file per tap sink outputs a discrete file for every tapped stream.

func (*FilePerTapSink) GetPathPrefix 

func (x *FilePerTapSink) GetPathPrefix() string

func (*FilePerTapSink) ProtoMessage 

func (*FilePerTapSink) ProtoMessage()

func (*FilePerTapSink) ProtoReflect 

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

func (*FilePerTapSink) Reset 

func (x *FilePerTapSink) Reset()

func (*FilePerTapSink) SetPathPrefix 

func (x *FilePerTapSink) SetPathPrefix(v string)

func (*FilePerTapSink) String 

func (x *FilePerTapSink) String() string

type FilePerTapSink_builder 

type FilePerTapSink_builder struct {

	// Path prefix. The output file will be of the form <path_prefix>_<id>.pb, where <id> is an
	// identifier distinguishing the recorded trace for stream instances (the Envoy
	// connection ID, HTTP stream ID, etc.).
	PathPrefix string
	// contains filtered or unexported fields
}

func (FilePerTapSink_builder) Build 

func (b0 FilePerTapSink_builder) Build() *FilePerTapSink

type HttpHeadersMatch 

type HttpHeadersMatch struct {

	// HTTP headers to match.
	Headers []*route.HeaderMatcher `protobuf:"bytes,1,rep,name=headers,proto3" json:"headers,omitempty"`
	// contains filtered or unexported fields
}

HTTP headers match configuration.

func (*HttpHeadersMatch) GetHeaders 

func (x *HttpHeadersMatch) GetHeaders() []*route.HeaderMatcher

func (*HttpHeadersMatch) ProtoMessage 

func (*HttpHeadersMatch) ProtoMessage()

func (*HttpHeadersMatch) ProtoReflect 

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

func (*HttpHeadersMatch) Reset 

func (x *HttpHeadersMatch) Reset()

func (*HttpHeadersMatch) SetHeaders 

func (x *HttpHeadersMatch) SetHeaders(v []*route.HeaderMatcher)

func (*HttpHeadersMatch) String 

func (x *HttpHeadersMatch) String() string

type HttpHeadersMatch_builder 

type HttpHeadersMatch_builder struct {

	// HTTP headers to match.
	Headers []*route.HeaderMatcher
	// contains filtered or unexported fields
}

func (HttpHeadersMatch_builder) Build 

func (b0 HttpHeadersMatch_builder) Build() *HttpHeadersMatch

type MatchPredicate 

type MatchPredicate struct {

	// Types that are valid to be assigned to Rule:
	//
	//	*MatchPredicate_OrMatch
	//	*MatchPredicate_AndMatch
	//	*MatchPredicate_NotMatch
	//	*MatchPredicate_AnyMatch
	//	*MatchPredicate_HttpRequestHeadersMatch
	//	*MatchPredicate_HttpRequestTrailersMatch
	//	*MatchPredicate_HttpResponseHeadersMatch
	//	*MatchPredicate_HttpResponseTrailersMatch
	Rule isMatchPredicate_Rule `protobuf_oneof:"rule"`
	// contains filtered or unexported fields
}

Tap match configuration. This is a recursive structure which allows complex nested match configurations to be built using various logical operators. [#next-free-field: 9]

func (*MatchPredicate) ClearAndMatch 

func (x *MatchPredicate) ClearAndMatch()

func (*MatchPredicate) ClearAnyMatch 

func (x *MatchPredicate) ClearAnyMatch()

func (*MatchPredicate) ClearHttpRequestHeadersMatch 

func (x *MatchPredicate) ClearHttpRequestHeadersMatch()

func (*MatchPredicate) ClearHttpRequestTrailersMatch 

func (x *MatchPredicate) ClearHttpRequestTrailersMatch()

func (*MatchPredicate) ClearHttpResponseHeadersMatch 

func (x *MatchPredicate) ClearHttpResponseHeadersMatch()

func (*MatchPredicate) ClearHttpResponseTrailersMatch 

func (x *MatchPredicate) ClearHttpResponseTrailersMatch()

func (*MatchPredicate) ClearNotMatch 

func (x *MatchPredicate) ClearNotMatch()

func (*MatchPredicate) ClearOrMatch 

func (x *MatchPredicate) ClearOrMatch()

func (*MatchPredicate) ClearRule 

func (x *MatchPredicate) ClearRule()

func (*MatchPredicate) GetAndMatch 

func (x *MatchPredicate) GetAndMatch() *MatchPredicate_MatchSet

func (*MatchPredicate) GetAnyMatch 

func (x *MatchPredicate) GetAnyMatch() bool

func (*MatchPredicate) GetHttpRequestHeadersMatch 

func (x *MatchPredicate) GetHttpRequestHeadersMatch() *HttpHeadersMatch

func (*MatchPredicate) GetHttpRequestTrailersMatch 

func (x *MatchPredicate) GetHttpRequestTrailersMatch() *HttpHeadersMatch

func (*MatchPredicate) GetHttpResponseHeadersMatch 

func (x *MatchPredicate) GetHttpResponseHeadersMatch() *HttpHeadersMatch

func (*MatchPredicate) GetHttpResponseTrailersMatch 

func (x *MatchPredicate) GetHttpResponseTrailersMatch() *HttpHeadersMatch

func (*MatchPredicate) GetNotMatch 

func (x *MatchPredicate) GetNotMatch() *MatchPredicate

func (*MatchPredicate) GetOrMatch 

func (x *MatchPredicate) GetOrMatch() *MatchPredicate_MatchSet

func (*MatchPredicate) GetRule 

func (x *MatchPredicate) GetRule() isMatchPredicate_Rule

func (*MatchPredicate) HasAndMatch 

func (x *MatchPredicate) HasAndMatch() bool

func (*MatchPredicate) HasAnyMatch 

func (x *MatchPredicate) HasAnyMatch() bool

func (*MatchPredicate) HasHttpRequestHeadersMatch 

func (x *MatchPredicate) HasHttpRequestHeadersMatch() bool

func (*MatchPredicate) HasHttpRequestTrailersMatch 

func (x *MatchPredicate) HasHttpRequestTrailersMatch() bool

func (*MatchPredicate) HasHttpResponseHeadersMatch 

func (x *MatchPredicate) HasHttpResponseHeadersMatch() bool

func (*MatchPredicate) HasHttpResponseTrailersMatch 

func (x *MatchPredicate) HasHttpResponseTrailersMatch() bool

func (*MatchPredicate) HasNotMatch 

func (x *MatchPredicate) HasNotMatch() bool

func (*MatchPredicate) HasOrMatch 

func (x *MatchPredicate) HasOrMatch() bool

func (*MatchPredicate) HasRule 

func (x *MatchPredicate) HasRule() bool

func (*MatchPredicate) ProtoMessage 

func (*MatchPredicate) ProtoMessage()

func (*MatchPredicate) ProtoReflect 

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

func (*MatchPredicate) Reset 

func (x *MatchPredicate) Reset()

func (*MatchPredicate) SetAndMatch 

func (x *MatchPredicate) SetAndMatch(v *MatchPredicate_MatchSet)

func (*MatchPredicate) SetAnyMatch 

func (x *MatchPredicate) SetAnyMatch(v bool)

func (*MatchPredicate) SetHttpRequestHeadersMatch 

func (x *MatchPredicate) SetHttpRequestHeadersMatch(v *HttpHeadersMatch)

func (*MatchPredicate) SetHttpRequestTrailersMatch 

func (x *MatchPredicate) SetHttpRequestTrailersMatch(v *HttpHeadersMatch)

func (*MatchPredicate) SetHttpResponseHeadersMatch 

func (x *MatchPredicate) SetHttpResponseHeadersMatch(v *HttpHeadersMatch)

func (*MatchPredicate) SetHttpResponseTrailersMatch 

func (x *MatchPredicate) SetHttpResponseTrailersMatch(v *HttpHeadersMatch)

func (*MatchPredicate) SetNotMatch 

func (x *MatchPredicate) SetNotMatch(v *MatchPredicate)

func (*MatchPredicate) SetOrMatch 

func (x *MatchPredicate) SetOrMatch(v *MatchPredicate_MatchSet)

func (*MatchPredicate) String 

func (x *MatchPredicate) String() string

func (*MatchPredicate) WhichRule 

func (x *MatchPredicate) WhichRule() case_MatchPredicate_Rule

type MatchPredicate_AndMatch 

type MatchPredicate_AndMatch struct {
	// A set that describes a logical AND. If all members of the set match, the match configuration
	// matches.
	AndMatch *MatchPredicate_MatchSet `protobuf:"bytes,2,opt,name=and_match,json=andMatch,proto3,oneof"`
}

type MatchPredicate_AnyMatch 

type MatchPredicate_AnyMatch struct {
	// The match configuration will always match.
	AnyMatch bool `protobuf:"varint,4,opt,name=any_match,json=anyMatch,proto3,oneof"`
}

type MatchPredicate_HttpRequestHeadersMatch 

type MatchPredicate_HttpRequestHeadersMatch struct {
	// HTTP request headers match configuration.
	HttpRequestHeadersMatch *HttpHeadersMatch `protobuf:"bytes,5,opt,name=http_request_headers_match,json=httpRequestHeadersMatch,proto3,oneof"`
}

type MatchPredicate_HttpRequestTrailersMatch 

type MatchPredicate_HttpRequestTrailersMatch struct {
	// HTTP request trailers match configuration.
	HttpRequestTrailersMatch *HttpHeadersMatch `protobuf:"bytes,6,opt,name=http_request_trailers_match,json=httpRequestTrailersMatch,proto3,oneof"`
}

type MatchPredicate_HttpResponseHeadersMatch 

type MatchPredicate_HttpResponseHeadersMatch struct {
	// HTTP response headers match configuration.
	HttpResponseHeadersMatch *HttpHeadersMatch `protobuf:"bytes,7,opt,name=http_response_headers_match,json=httpResponseHeadersMatch,proto3,oneof"`
}

type MatchPredicate_HttpResponseTrailersMatch 

type MatchPredicate_HttpResponseTrailersMatch struct {
	// HTTP response trailers match configuration.
	HttpResponseTrailersMatch *HttpHeadersMatch `protobuf:"bytes,8,opt,name=http_response_trailers_match,json=httpResponseTrailersMatch,proto3,oneof"`
}

type MatchPredicate_MatchSet 

type MatchPredicate_MatchSet struct {

	// The list of rules that make up the set.
	Rules []*MatchPredicate `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
	// contains filtered or unexported fields
}

A set of match configurations used for logical operations.

func (*MatchPredicate_MatchSet) GetRules 

func (x *MatchPredicate_MatchSet) GetRules() []*MatchPredicate

func (*MatchPredicate_MatchSet) ProtoMessage 

func (*MatchPredicate_MatchSet) ProtoMessage()

func (*MatchPredicate_MatchSet) ProtoReflect 

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

func (*MatchPredicate_MatchSet) Reset 

func (x *MatchPredicate_MatchSet) Reset()

func (*MatchPredicate_MatchSet) SetRules 

func (x *MatchPredicate_MatchSet) SetRules(v []*MatchPredicate)

func (*MatchPredicate_MatchSet) String 

func (x *MatchPredicate_MatchSet) String() string

type MatchPredicate_MatchSet_builder 

type MatchPredicate_MatchSet_builder struct {

	// The list of rules that make up the set.
	Rules []*MatchPredicate
	// contains filtered or unexported fields
}

func (MatchPredicate_MatchSet_builder) Build 

func (b0 MatchPredicate_MatchSet_builder) Build() *MatchPredicate_MatchSet

type MatchPredicate_NotMatch 

type MatchPredicate_NotMatch struct {
	// A negation match. The match configuration will match if the negated match condition matches.
	NotMatch *MatchPredicate `protobuf:"bytes,3,opt,name=not_match,json=notMatch,proto3,oneof"`
}

type MatchPredicate_OrMatch 

type MatchPredicate_OrMatch struct {
	// A set that describes a logical OR. If any member of the set matches, the match configuration
	// matches.
	OrMatch *MatchPredicate_MatchSet `protobuf:"bytes,1,opt,name=or_match,json=orMatch,proto3,oneof"`
}

type MatchPredicate_builder 

type MatchPredicate_builder struct {

	// Fields of oneof Rule:
	// A set that describes a logical OR. If any member of the set matches, the match configuration
	// matches.
	OrMatch *MatchPredicate_MatchSet
	// A set that describes a logical AND. If all members of the set match, the match configuration
	// matches.
	AndMatch *MatchPredicate_MatchSet
	// A negation match. The match configuration will match if the negated match condition matches.
	NotMatch *MatchPredicate
	// The match configuration will always match.
	AnyMatch *bool
	// HTTP request headers match configuration.
	HttpRequestHeadersMatch *HttpHeadersMatch
	// HTTP request trailers match configuration.
	HttpRequestTrailersMatch *HttpHeadersMatch
	// HTTP response headers match configuration.
	HttpResponseHeadersMatch *HttpHeadersMatch
	// HTTP response trailers match configuration.
	HttpResponseTrailersMatch *HttpHeadersMatch
	// contains filtered or unexported fields
}

func (MatchPredicate_builder) Build 

func (b0 MatchPredicate_builder) Build() *MatchPredicate

type OutputConfig 

type OutputConfig struct {

	// Output sinks for tap data. Currently a single sink is allowed in the list. Once multiple
	// sink types are supported this constraint will be relaxed.
	Sinks []*OutputSink `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 :ref:`truncated
	// <envoy_api_field_data.tap.v2alpha.Body.truncated>` field will be set. If not specified, the
	// default is 1KiB.
	MaxBufferedRxBytes *wrapperspb.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 :ref:`truncated
	// <envoy_api_field_data.tap.v2alpha.Body.truncated>` field will be set. If not specified, the
	// default is 1KiB.
	MaxBufferedTxBytes *wrapperspb.UInt32Value `protobuf:"bytes,3,opt,name=max_buffered_tx_bytes,json=maxBufferedTxBytes,proto3" json:"max_buffered_tx_bytes,omitempty"`
	// Indicates whether taps produce a single buffered message per tap, or multiple streamed
	// messages per tap in the emitted :ref:`TraceWrapper
	// <envoy_api_msg_data.tap.v2alpha.TraceWrapper>` messages. Note that streamed tapping does not
	// mean that no buffering takes place. Buffering may be required if data is processed before a
	// match can be determined. See the HTTP tap filter :ref:`streaming
	// <config_http_filters_tap_streaming>` documentation for more information.
	Streaming bool `protobuf:"varint,4,opt,name=streaming,proto3" json:"streaming,omitempty"`
	// contains filtered or unexported fields
}

Tap output configuration.

func (*OutputConfig) ClearMaxBufferedRxBytes 

func (x *OutputConfig) ClearMaxBufferedRxBytes()

func (*OutputConfig) ClearMaxBufferedTxBytes 

func (x *OutputConfig) ClearMaxBufferedTxBytes()

func (*OutputConfig) GetMaxBufferedRxBytes 

func (x *OutputConfig) GetMaxBufferedRxBytes() *wrapperspb.UInt32Value

func (*OutputConfig) GetMaxBufferedTxBytes 

func (x *OutputConfig) GetMaxBufferedTxBytes() *wrapperspb.UInt32Value

func (*OutputConfig) GetSinks 

func (x *OutputConfig) GetSinks() []*OutputSink

func (*OutputConfig) GetStreaming 

func (x *OutputConfig) GetStreaming() bool

func (*OutputConfig) HasMaxBufferedRxBytes 

func (x *OutputConfig) HasMaxBufferedRxBytes() bool

func (*OutputConfig) HasMaxBufferedTxBytes 

func (x *OutputConfig) HasMaxBufferedTxBytes() bool

func (*OutputConfig) ProtoMessage 

func (*OutputConfig) ProtoMessage()

func (*OutputConfig) ProtoReflect 

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

func (*OutputConfig) Reset 

func (x *OutputConfig) Reset()

func (*OutputConfig) SetMaxBufferedRxBytes 

func (x *OutputConfig) SetMaxBufferedRxBytes(v *wrapperspb.UInt32Value)

func (*OutputConfig) SetMaxBufferedTxBytes 

func (x *OutputConfig) SetMaxBufferedTxBytes(v *wrapperspb.UInt32Value)

func (*OutputConfig) SetSinks 

func (x *OutputConfig) SetSinks(v []*OutputSink)

func (*OutputConfig) SetStreaming 

func (x *OutputConfig) SetStreaming(v bool)

func (*OutputConfig) String 

func (x *OutputConfig) String() string

type OutputConfig_builder 

type OutputConfig_builder struct {

	// Output sinks for tap data. Currently a single sink is allowed in the list. Once multiple
	// sink types are supported this constraint will be relaxed.
	Sinks []*OutputSink
	// For buffered tapping, the maximum amount of received body that will be buffered prior to
	// truncation. If truncation occurs, the :ref:`truncated
	// <envoy_api_field_data.tap.v2alpha.Body.truncated>` field will be set. If not specified, the
	// default is 1KiB.
	MaxBufferedRxBytes *wrapperspb.UInt32Value
	// For buffered tapping, the maximum amount of transmitted body that will be buffered prior to
	// truncation. If truncation occurs, the :ref:`truncated
	// <envoy_api_field_data.tap.v2alpha.Body.truncated>` field will be set. If not specified, the
	// default is 1KiB.
	MaxBufferedTxBytes *wrapperspb.UInt32Value
	// Indicates whether taps produce a single buffered message per tap, or multiple streamed
	// messages per tap in the emitted :ref:`TraceWrapper
	// <envoy_api_msg_data.tap.v2alpha.TraceWrapper>` messages. Note that streamed tapping does not
	// mean that no buffering takes place. Buffering may be required if data is processed before a
	// match can be determined. See the HTTP tap filter :ref:`streaming
	// <config_http_filters_tap_streaming>` documentation for more information.
	Streaming bool
	// contains filtered or unexported fields
}

func (OutputConfig_builder) Build 

func (b0 OutputConfig_builder) Build() *OutputConfig

type OutputSink 

type OutputSink struct {

	// Sink output format.
	Format OutputSink_Format `protobuf:"varint,1,opt,name=format,proto3,enum=envoy.service.tap.v2alpha.OutputSink_Format" json:"format,omitempty"`
	// Types that are valid to be assigned to OutputSinkType:
	//
	//	*OutputSink_StreamingAdmin
	//	*OutputSink_FilePerTap
	//	*OutputSink_StreamingGrpc
	OutputSinkType isOutputSink_OutputSinkType `protobuf_oneof:"output_sink_type"`
	// contains filtered or unexported fields
}

Tap output sink configuration.

func (*OutputSink) ClearFilePerTap 

func (x *OutputSink) ClearFilePerTap()

func (*OutputSink) ClearOutputSinkType 

func (x *OutputSink) ClearOutputSinkType()

func (*OutputSink) ClearStreamingAdmin 

func (x *OutputSink) ClearStreamingAdmin()

func (*OutputSink) ClearStreamingGrpc 

func (x *OutputSink) ClearStreamingGrpc()

func (*OutputSink) GetFilePerTap 

func (x *OutputSink) GetFilePerTap() *FilePerTapSink

func (*OutputSink) GetFormat 

func (x *OutputSink) GetFormat() OutputSink_Format

func (*OutputSink) GetOutputSinkType 

func (x *OutputSink) GetOutputSinkType() isOutputSink_OutputSinkType

func (*OutputSink) GetStreamingAdmin 

func (x *OutputSink) GetStreamingAdmin() *StreamingAdminSink

func (*OutputSink) GetStreamingGrpc 

func (x *OutputSink) GetStreamingGrpc() *StreamingGrpcSink

func (*OutputSink) HasFilePerTap 

func (x *OutputSink) HasFilePerTap() bool

func (*OutputSink) HasOutputSinkType 

func (x *OutputSink) HasOutputSinkType() bool

func (*OutputSink) HasStreamingAdmin 

func (x *OutputSink) HasStreamingAdmin() bool

func (*OutputSink) HasStreamingGrpc 

func (x *OutputSink) HasStreamingGrpc() bool

func (*OutputSink) ProtoMessage 

func (*OutputSink) ProtoMessage()

func (*OutputSink) ProtoReflect 

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

func (*OutputSink) Reset 

func (x *OutputSink) Reset()

func (*OutputSink) SetFilePerTap 

func (x *OutputSink) SetFilePerTap(v *FilePerTapSink)

func (*OutputSink) SetFormat 

func (x *OutputSink) SetFormat(v OutputSink_Format)

func (*OutputSink) SetStreamingAdmin 

func (x *OutputSink) SetStreamingAdmin(v *StreamingAdminSink)

func (*OutputSink) SetStreamingGrpc 

func (x *OutputSink) SetStreamingGrpc(v *StreamingGrpcSink)

func (*OutputSink) String 

func (x *OutputSink) String() string

func (*OutputSink) WhichOutputSinkType 

func (x *OutputSink) WhichOutputSinkType() case_OutputSink_OutputSinkType

type OutputSink_FilePerTap 

type OutputSink_FilePerTap struct {
	// Tap output will be written to a file per tap sink.
	FilePerTap *FilePerTapSink `protobuf:"bytes,3,opt,name=file_per_tap,json=filePerTap,proto3,oneof"`
}

type OutputSink_Format 

type OutputSink_Format int32

Output format. All output is in the form of one or more :ref:`TraceWrapper <envoy_api_msg_data.tap.v2alpha.TraceWrapper>` messages. This enumeration indicates how those messages are written. Note that not all sinks support all output formats. See individual sink documentation for more information. 

const (
	// Each message will be written as JSON. Any :ref:`body <envoy_api_msg_data.tap.v2alpha.Body>`
	// data will be present in the :ref:`as_bytes
	// <envoy_api_field_data.tap.v2alpha.Body.as_bytes>` field. This means that body data will be
	// base64 encoded as per the `proto3 JSON mappings
	// <https://developers.google.com/protocol-buffers/docs/proto3#json>`_.
	OutputSink_JSON_BODY_AS_BYTES OutputSink_Format = 0
	// Each message will be written as JSON. Any :ref:`body <envoy_api_msg_data.tap.v2alpha.Body>`
	// data will be present in the :ref:`as_string
	// <envoy_api_field_data.tap.v2alpha.Body.as_string>` field. This means that body data will be
	// string encoded as per the `proto3 JSON mappings
	// <https://developers.google.com/protocol-buffers/docs/proto3#json>`_. This format type is
	// useful when it is known that that body is human readable (e.g., JSON over HTTP) and the
	// user wishes to view it directly without being forced to base64 decode the body.
	OutputSink_JSON_BODY_AS_STRING OutputSink_Format = 1
	// Binary proto format. Note that binary proto is not self-delimiting. If a sink writes
	// multiple binary messages without any length information the data stream will not be
	// useful. However, for certain sinks that are self-delimiting (e.g., one message per file)
	// this output format makes consumption simpler.
	OutputSink_PROTO_BINARY OutputSink_Format = 2
	// Messages are written as a sequence tuples, where each tuple is the message length encoded
	// as a `protobuf 32-bit varint
	// <https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.io.coded_stream>`_
	// followed by the binary message. The messages can be read back using the language specific
	// protobuf coded stream implementation to obtain the message length and the message.
	OutputSink_PROTO_BINARY_LENGTH_DELIMITED OutputSink_Format = 3
	// Text proto format.
	OutputSink_PROTO_TEXT OutputSink_Format = 4
)

func (OutputSink_Format) Descriptor 

func (OutputSink_Format) Descriptor() protoreflect.EnumDescriptor

func (OutputSink_Format) Enum 

func (x OutputSink_Format) Enum() *OutputSink_Format

func (OutputSink_Format) Number 

func (x OutputSink_Format) Number() protoreflect.EnumNumber

func (OutputSink_Format) String 

func (x OutputSink_Format) String() string

func (OutputSink_Format) Type 

func (OutputSink_Format) Type() protoreflect.EnumType

type OutputSink_StreamingAdmin 

type OutputSink_StreamingAdmin struct {
	// Tap output will be streamed out the :http:post:`/tap` admin endpoint.
	//
	// .. attention::
	//
	//	It is only allowed to specify the streaming admin output sink if the tap is being
	//	configured from the :http:post:`/tap` admin endpoint. Thus, if an extension has
	//	been configured to receive tap configuration from some other source (e.g., static
	//	file, XDS, etc.) configuring the streaming admin output type will fail.
	StreamingAdmin *StreamingAdminSink `protobuf:"bytes,2,opt,name=streaming_admin,json=streamingAdmin,proto3,oneof"`
}

type OutputSink_StreamingGrpc 

type OutputSink_StreamingGrpc struct {
	// [#not-implemented-hide:]
	// GrpcService to stream data to. The format argument must be PROTO_BINARY.
	StreamingGrpc *StreamingGrpcSink `protobuf:"bytes,4,opt,name=streaming_grpc,json=streamingGrpc,proto3,oneof"`
}

type OutputSink_builder 

type OutputSink_builder struct {

	// Sink output format.
	Format OutputSink_Format
	// Fields of oneof OutputSinkType:
	// Tap output will be streamed out the :http:post:`/tap` admin endpoint.
	//
	// .. attention::
	//
	//	It is only allowed to specify the streaming admin output sink if the tap is being
	//	configured from the :http:post:`/tap` admin endpoint. Thus, if an extension has
	//	been configured to receive tap configuration from some other source (e.g., static
	//	file, XDS, etc.) configuring the streaming admin output type will fail.
	StreamingAdmin *StreamingAdminSink
	// Tap output will be written to a file per tap sink.
	FilePerTap *FilePerTapSink
	// [#not-implemented-hide:]
	// GrpcService to stream data to. The format argument must be PROTO_BINARY.
	StreamingGrpc *StreamingGrpcSink
	// contains filtered or unexported fields
}

func (OutputSink_builder) Build 

func (b0 OutputSink_builder) Build() *OutputSink

type StreamTapsRequest 

type StreamTapsRequest struct {

	// Identifier data effectively is a structured metadata. As a performance optimization this will
	// only be sent in the first message on the stream.
	Identifier *StreamTapsRequest_Identifier `protobuf:"bytes,1,opt,name=identifier,proto3" json:"identifier,omitempty"`
	// The trace id. this can be used to merge together a streaming trace. Note that the trace_id
	// is not guaranteed to be spatially or temporally unique.
	TraceId uint64 `protobuf:"varint,2,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
	// The trace data.
	Trace *v2alpha.TraceWrapper `protobuf:"bytes,3,opt,name=trace,proto3" json:"trace,omitempty"`
	// contains filtered or unexported fields
}

[#not-implemented-hide:] Stream message for the Tap API. Envoy will open a stream to the server and stream taps without ever expecting a response.

func (*StreamTapsRequest) ClearIdentifier 

func (x *StreamTapsRequest) ClearIdentifier()

func (*StreamTapsRequest) ClearTrace 

func (x *StreamTapsRequest) ClearTrace()

func (*StreamTapsRequest) GetIdentifier 

func (x *StreamTapsRequest) GetIdentifier() *StreamTapsRequest_Identifier

func (*StreamTapsRequest) GetTrace 

func (x *StreamTapsRequest) GetTrace() *v2alpha.TraceWrapper

func (*StreamTapsRequest) GetTraceId 

func (x *StreamTapsRequest) GetTraceId() uint64

func (*StreamTapsRequest) HasIdentifier 

func (x *StreamTapsRequest) HasIdentifier() bool

func (*StreamTapsRequest) HasTrace 

func (x *StreamTapsRequest) HasTrace() bool

func (*StreamTapsRequest) ProtoMessage 

func (*StreamTapsRequest) ProtoMessage()

func (*StreamTapsRequest) ProtoReflect 

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

func (*StreamTapsRequest) Reset 

func (x *StreamTapsRequest) Reset()

func (*StreamTapsRequest) SetIdentifier 

func (x *StreamTapsRequest) SetIdentifier(v *StreamTapsRequest_Identifier)

func (*StreamTapsRequest) SetTrace 

func (x *StreamTapsRequest) SetTrace(v *v2alpha.TraceWrapper)

func (*StreamTapsRequest) SetTraceId 

func (x *StreamTapsRequest) SetTraceId(v uint64)

func (*StreamTapsRequest) String 

func (x *StreamTapsRequest) String() string

type StreamTapsRequest_Identifier 

type StreamTapsRequest_Identifier struct {

	// The node sending taps over the stream.
	Node *core.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	// The opaque identifier that was set in the :ref:`output config
	// <envoy_api_field_service.tap.v2alpha.StreamingGrpcSink.tap_id>`.
	TapId string `protobuf:"bytes,2,opt,name=tap_id,json=tapId,proto3" json:"tap_id,omitempty"`
	// contains filtered or unexported fields
}

func (*StreamTapsRequest_Identifier) ClearNode 

func (x *StreamTapsRequest_Identifier) ClearNode()

func (*StreamTapsRequest_Identifier) GetNode 

func (x *StreamTapsRequest_Identifier) GetNode() *core.Node

func (*StreamTapsRequest_Identifier) GetTapId 

func (x *StreamTapsRequest_Identifier) GetTapId() string

func (*StreamTapsRequest_Identifier) HasNode 

func (x *StreamTapsRequest_Identifier) HasNode() bool

func (*StreamTapsRequest_Identifier) ProtoMessage 

func (*StreamTapsRequest_Identifier) ProtoMessage()

func (*StreamTapsRequest_Identifier) ProtoReflect 

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

func (*StreamTapsRequest_Identifier) Reset 

func (x *StreamTapsRequest_Identifier) Reset()

func (*StreamTapsRequest_Identifier) SetNode 

func (x *StreamTapsRequest_Identifier) SetNode(v *core.Node)

func (*StreamTapsRequest_Identifier) SetTapId 

func (x *StreamTapsRequest_Identifier) SetTapId(v string)

func (*StreamTapsRequest_Identifier) String 

func (x *StreamTapsRequest_Identifier) String() string

type StreamTapsRequest_Identifier_builder 

type StreamTapsRequest_Identifier_builder struct {

	// The node sending taps over the stream.
	Node *core.Node
	// The opaque identifier that was set in the :ref:`output config
	// <envoy_api_field_service.tap.v2alpha.StreamingGrpcSink.tap_id>`.
	TapId string
	// contains filtered or unexported fields
}

func (StreamTapsRequest_Identifier_builder) Build 

func (b0 StreamTapsRequest_Identifier_builder) Build() *StreamTapsRequest_Identifier

type StreamTapsRequest_builder 

type StreamTapsRequest_builder struct {

	// Identifier data effectively is a structured metadata. As a performance optimization this will
	// only be sent in the first message on the stream.
	Identifier *StreamTapsRequest_Identifier
	// The trace id. this can be used to merge together a streaming trace. Note that the trace_id
	// is not guaranteed to be spatially or temporally unique.
	TraceId uint64
	// The trace data.
	Trace *v2alpha.TraceWrapper
	// contains filtered or unexported fields
}

func (StreamTapsRequest_builder) Build 

func (b0 StreamTapsRequest_builder) Build() *StreamTapsRequest

type StreamTapsResponse 

type StreamTapsResponse struct {
	// contains filtered or unexported fields
}

[#not-implemented-hide:]

func (*StreamTapsResponse) ProtoMessage 

func (*StreamTapsResponse) ProtoMessage()

func (*StreamTapsResponse) ProtoReflect 

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

func (*StreamTapsResponse) Reset 

func (x *StreamTapsResponse) Reset()

func (*StreamTapsResponse) String 

func (x *StreamTapsResponse) String() string

type StreamTapsResponse_builder 

type StreamTapsResponse_builder struct {
	// contains filtered or unexported fields
}

func (StreamTapsResponse_builder) Build 

func (b0 StreamTapsResponse_builder) Build() *StreamTapsResponse

type StreamingAdminSink 

type StreamingAdminSink struct {
	// contains filtered or unexported fields
}

Streaming admin sink configuration.

func (*StreamingAdminSink) ProtoMessage 

func (*StreamingAdminSink) ProtoMessage()

func (*StreamingAdminSink) ProtoReflect 

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

func (*StreamingAdminSink) Reset 

func (x *StreamingAdminSink) Reset()

func (*StreamingAdminSink) String 

func (x *StreamingAdminSink) String() string

type StreamingAdminSink_builder 

type StreamingAdminSink_builder struct {
	// contains filtered or unexported fields
}

func (StreamingAdminSink_builder) Build 

func (b0 StreamingAdminSink_builder) Build() *StreamingAdminSink

type StreamingGrpcSink 

type StreamingGrpcSink struct {

	// Opaque identifier, that will be sent back to the streaming grpc server.
	TapId string `protobuf:"bytes,1,opt,name=tap_id,json=tapId,proto3" json:"tap_id,omitempty"`
	// The gRPC server that hosts the Tap Sink Service.
	GrpcService *core.GrpcService `protobuf:"bytes,2,opt,name=grpc_service,json=grpcService,proto3" json:"grpc_service,omitempty"`
	// contains filtered or unexported fields
}

[#not-implemented-hide:] Streaming gRPC sink configuration sends the taps to an external gRPC server.

func (*StreamingGrpcSink) ClearGrpcService 

func (x *StreamingGrpcSink) ClearGrpcService()

func (*StreamingGrpcSink) GetGrpcService 

func (x *StreamingGrpcSink) GetGrpcService() *core.GrpcService

func (*StreamingGrpcSink) GetTapId 

func (x *StreamingGrpcSink) GetTapId() string

func (*StreamingGrpcSink) HasGrpcService 

func (x *StreamingGrpcSink) HasGrpcService() bool

func (*StreamingGrpcSink) ProtoMessage 

func (*StreamingGrpcSink) ProtoMessage()

func (*StreamingGrpcSink) ProtoReflect 

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

func (*StreamingGrpcSink) Reset 

func (x *StreamingGrpcSink) Reset()

func (*StreamingGrpcSink) SetGrpcService 

func (x *StreamingGrpcSink) SetGrpcService(v *core.GrpcService)

func (*StreamingGrpcSink) SetTapId 

func (x *StreamingGrpcSink) SetTapId(v string)

func (*StreamingGrpcSink) String 

func (x *StreamingGrpcSink) String() string

type StreamingGrpcSink_builder 

type StreamingGrpcSink_builder struct {

	// Opaque identifier, that will be sent back to the streaming grpc server.
	TapId string
	// The gRPC server that hosts the Tap Sink Service.
	GrpcService *core.GrpcService
	// contains filtered or unexported fields
}

func (StreamingGrpcSink_builder) Build 

func (b0 StreamingGrpcSink_builder) Build() *StreamingGrpcSink

type TapConfig 

type TapConfig struct {

	// The match configuration. If the configuration matches the data source being tapped, a tap will
	// occur, with the result written to the configured output.
	MatchConfig *MatchPredicate `protobuf:"bytes,1,opt,name=match_config,json=matchConfig,proto3" json:"match_config,omitempty"`
	// The tap output configuration. If a match configuration matches a data source being tapped,
	// a tap will occur and the data will be written to the configured output.
	OutputConfig *OutputConfig `protobuf:"bytes,2,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
	// [#not-implemented-hide:] Specify if Tap matching is enabled. The % of requests\connections for
	// which the tap matching is enabled. When not enabled, the request\connection will not be
	// recorded.
	//
	// .. note::
	//
	//	This field defaults to 100/:ref:`HUNDRED
	//	<envoy_api_enum_type.FractionalPercent.DenominatorType>`.
	TapEnabled *core.RuntimeFractionalPercent `protobuf:"bytes,3,opt,name=tap_enabled,json=tapEnabled,proto3" json:"tap_enabled,omitempty"`
	// contains filtered or unexported fields
}

Tap configuration.

func (*TapConfig) ClearMatchConfig 

func (x *TapConfig) ClearMatchConfig()

func (*TapConfig) ClearOutputConfig 

func (x *TapConfig) ClearOutputConfig()

func (*TapConfig) ClearTapEnabled 

func (x *TapConfig) ClearTapEnabled()

func (*TapConfig) GetMatchConfig 

func (x *TapConfig) GetMatchConfig() *MatchPredicate

func (*TapConfig) GetOutputConfig 

func (x *TapConfig) GetOutputConfig() *OutputConfig

func (*TapConfig) GetTapEnabled 

func (x *TapConfig) GetTapEnabled() *core.RuntimeFractionalPercent

func (*TapConfig) HasMatchConfig 

func (x *TapConfig) HasMatchConfig() bool

func (*TapConfig) HasOutputConfig 

func (x *TapConfig) HasOutputConfig() bool

func (*TapConfig) HasTapEnabled 

func (x *TapConfig) HasTapEnabled() bool

func (*TapConfig) ProtoMessage 

func (*TapConfig) ProtoMessage()

func (*TapConfig) ProtoReflect 

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

func (*TapConfig) Reset 

func (x *TapConfig) Reset()

func (*TapConfig) SetMatchConfig 

func (x *TapConfig) SetMatchConfig(v *MatchPredicate)

func (*TapConfig) SetOutputConfig 

func (x *TapConfig) SetOutputConfig(v *OutputConfig)

func (*TapConfig) SetTapEnabled 

func (x *TapConfig) SetTapEnabled(v *core.RuntimeFractionalPercent)

func (*TapConfig) String 

func (x *TapConfig) String() string

type TapConfig_builder 

type TapConfig_builder struct {

	// The match configuration. If the configuration matches the data source being tapped, a tap will
	// occur, with the result written to the configured output.
	MatchConfig *MatchPredicate
	// The tap output configuration. If a match configuration matches a data source being tapped,
	// a tap will occur and the data will be written to the configured output.
	OutputConfig *OutputConfig
	// [#not-implemented-hide:] Specify if Tap matching is enabled. The % of requests\connections for
	// which the tap matching is enabled. When not enabled, the request\connection will not be
	// recorded.
	//
	// .. note::
	//
	//	This field defaults to 100/:ref:`HUNDRED
	//	<envoy_api_enum_type.FractionalPercent.DenominatorType>`.
	TapEnabled *core.RuntimeFractionalPercent
	// contains filtered or unexported fields
}

func (TapConfig_builder) Build 

func (b0 TapConfig_builder) Build() *TapConfig

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.