tapv3

package
v1.34.1-20240411200743... Latest Latest
Warning

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

 Go to latest Published: unknown License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

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_config_tap_v3_common_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type BufferedAdminSink 

type BufferedAdminSink struct {

	// Stop collecting traces when the specified number are collected.
	// If other criteria for ending collection are reached first, this value will not be used.
	MaxTraces uint64 `protobuf:"varint,1,opt,name=max_traces,json=maxTraces,proto3" json:"max_traces,omitempty"`
	// Acts as a fallback to prevent the client from waiting for long periods of time.
	// After timeout has occurred, a buffer flush will be triggered, returning the traces buffered so far.
	// This may result in returning fewer traces than were requested, and in the case that no traces are
	// buffered during this time, no traces will be returned.
	// Specifying 0 for the timeout value (or not specifying a value at all) indicates an infinite timeout.
	Timeout *durationpb.Duration `protobuf:"bytes,2,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// contains filtered or unexported fields
}

BufferedAdminSink configures a tap output to collect traces without returning them until one of multiple criteria are satisfied. Similar to StreamingAdminSink, it is only allowed to specify the buffered admin output sink if the tap is being configured from the “/tap“ admin endpoint.

func (*BufferedAdminSink) Descriptor deprecated 

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

Deprecated: Use BufferedAdminSink.ProtoReflect.Descriptor instead.

func (*BufferedAdminSink) GetMaxTraces 

func (x *BufferedAdminSink) GetMaxTraces() uint64

func (*BufferedAdminSink) GetTimeout 

func (x *BufferedAdminSink) GetTimeout() *durationpb.Duration

func (*BufferedAdminSink) ProtoMessage 

func (*BufferedAdminSink) ProtoMessage()

func (*BufferedAdminSink) ProtoReflect 

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

func (*BufferedAdminSink) Reset 

func (x *BufferedAdminSink) Reset()

func (*BufferedAdminSink) String 

func (x *BufferedAdminSink) String() string

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) Descriptor deprecated 

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

Deprecated: Use FilePerTapSink.ProtoReflect.Descriptor instead.

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) String 

func (x *FilePerTapSink) String() string

type HttpGenericBodyMatch 

type HttpGenericBodyMatch struct {

	// Limits search to specified number of bytes - default zero (no limit - match entire captured buffer).
	BytesLimit uint32 `protobuf:"varint,1,opt,name=bytes_limit,json=bytesLimit,proto3" json:"bytes_limit,omitempty"`
	// List of patterns to match.
	Patterns []*HttpGenericBodyMatch_GenericTextMatch `protobuf:"bytes,2,rep,name=patterns,proto3" json:"patterns,omitempty"`
	// contains filtered or unexported fields
}

HTTP generic body match configuration. List of text strings and hex strings to be located in HTTP body. All specified strings must be found in the HTTP body for positive match. The search may be limited to specified number of bytes from the body start.

.. attention:: 

Searching for patterns in HTTP body is potentially cpu intensive. For each specified pattern, http body is scanned byte by byte to find a match.
If multiple patterns are specified, the process is repeated for each pattern. If location of a pattern is known, ``bytes_limit`` should be specified
to scan only part of the http body.

func (*HttpGenericBodyMatch) Descriptor deprecated 

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

Deprecated: Use HttpGenericBodyMatch.ProtoReflect.Descriptor instead.

func (*HttpGenericBodyMatch) GetBytesLimit 

func (x *HttpGenericBodyMatch) GetBytesLimit() uint32

func (*HttpGenericBodyMatch) GetPatterns 

func (x *HttpGenericBodyMatch) GetPatterns() []*HttpGenericBodyMatch_GenericTextMatch

func (*HttpGenericBodyMatch) ProtoMessage 

func (*HttpGenericBodyMatch) ProtoMessage()

func (*HttpGenericBodyMatch) ProtoReflect 

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

func (*HttpGenericBodyMatch) Reset 

func (x *HttpGenericBodyMatch) Reset()

func (*HttpGenericBodyMatch) String 

func (x *HttpGenericBodyMatch) String() string

type HttpGenericBodyMatch_GenericTextMatch 

type HttpGenericBodyMatch_GenericTextMatch struct {

	// Types that are assignable to Rule:
	//
	//	*HttpGenericBodyMatch_GenericTextMatch_StringMatch
	//	*HttpGenericBodyMatch_GenericTextMatch_BinaryMatch
	Rule isHttpGenericBodyMatch_GenericTextMatch_Rule `protobuf_oneof:"rule"`
	// contains filtered or unexported fields
}

func (*HttpGenericBodyMatch_GenericTextMatch) Descriptor deprecated 

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

Deprecated: Use HttpGenericBodyMatch_GenericTextMatch.ProtoReflect.Descriptor instead.

func (*HttpGenericBodyMatch_GenericTextMatch) GetBinaryMatch 

func (x *HttpGenericBodyMatch_GenericTextMatch) GetBinaryMatch() []byte

func (*HttpGenericBodyMatch_GenericTextMatch) GetRule 

func (m *HttpGenericBodyMatch_GenericTextMatch) GetRule() isHttpGenericBodyMatch_GenericTextMatch_Rule

func (*HttpGenericBodyMatch_GenericTextMatch) GetStringMatch 

func (x *HttpGenericBodyMatch_GenericTextMatch) GetStringMatch() string

func (*HttpGenericBodyMatch_GenericTextMatch) ProtoMessage 

func (*HttpGenericBodyMatch_GenericTextMatch) ProtoMessage()

func (*HttpGenericBodyMatch_GenericTextMatch) ProtoReflect 

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

func (*HttpGenericBodyMatch_GenericTextMatch) Reset 

func (x *HttpGenericBodyMatch_GenericTextMatch) Reset()

func (*HttpGenericBodyMatch_GenericTextMatch) String 

func (x *HttpGenericBodyMatch_GenericTextMatch) String() string

type HttpGenericBodyMatch_GenericTextMatch_BinaryMatch 

type HttpGenericBodyMatch_GenericTextMatch_BinaryMatch struct {
	// Sequence of bytes to be located in HTTP body.
	BinaryMatch []byte `protobuf:"bytes,2,opt,name=binary_match,json=binaryMatch,proto3,oneof"`
}

type HttpGenericBodyMatch_GenericTextMatch_StringMatch 

type HttpGenericBodyMatch_GenericTextMatch_StringMatch struct {
	// Text string to be located in HTTP body.
	StringMatch string `protobuf:"bytes,1,opt,name=string_match,json=stringMatch,proto3,oneof"`
}

type HttpHeadersMatch 

type HttpHeadersMatch struct {

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

HTTP headers match configuration.

func (*HttpHeadersMatch) Descriptor deprecated 

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

Deprecated: Use HttpHeadersMatch.ProtoReflect.Descriptor instead.

func (*HttpHeadersMatch) GetHeaders 

func (x *HttpHeadersMatch) GetHeaders() []*v32.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) String 

func (x *HttpHeadersMatch) String() string

type MatchPredicate 

type MatchPredicate struct {

	// Types that are assignable to Rule:
	//
	//	*MatchPredicate_OrMatch
	//	*MatchPredicate_AndMatch
	//	*MatchPredicate_NotMatch
	//	*MatchPredicate_AnyMatch
	//	*MatchPredicate_HttpRequestHeadersMatch
	//	*MatchPredicate_HttpRequestTrailersMatch
	//	*MatchPredicate_HttpResponseHeadersMatch
	//	*MatchPredicate_HttpResponseTrailersMatch
	//	*MatchPredicate_HttpRequestGenericBodyMatch
	//	*MatchPredicate_HttpResponseGenericBodyMatch
	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: 11]

func (*MatchPredicate) Descriptor deprecated 

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

Deprecated: Use MatchPredicate.ProtoReflect.Descriptor instead.

func (*MatchPredicate) GetAndMatch 

func (x *MatchPredicate) GetAndMatch() *MatchPredicate_MatchSet

func (*MatchPredicate) GetAnyMatch 

func (x *MatchPredicate) GetAnyMatch() bool

func (*MatchPredicate) GetHttpRequestGenericBodyMatch 

func (x *MatchPredicate) GetHttpRequestGenericBodyMatch() *HttpGenericBodyMatch

func (*MatchPredicate) GetHttpRequestHeadersMatch 

func (x *MatchPredicate) GetHttpRequestHeadersMatch() *HttpHeadersMatch

func (*MatchPredicate) GetHttpRequestTrailersMatch 

func (x *MatchPredicate) GetHttpRequestTrailersMatch() *HttpHeadersMatch

func (*MatchPredicate) GetHttpResponseGenericBodyMatch 

func (x *MatchPredicate) GetHttpResponseGenericBodyMatch() *HttpGenericBodyMatch

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 (m *MatchPredicate) GetRule() isMatchPredicate_Rule

func (*MatchPredicate) ProtoMessage 

func (*MatchPredicate) ProtoMessage()

func (*MatchPredicate) ProtoReflect 

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

func (*MatchPredicate) Reset 

func (x *MatchPredicate) Reset()

func (*MatchPredicate) String 

func (x *MatchPredicate) String() string

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_HttpRequestGenericBodyMatch 

type MatchPredicate_HttpRequestGenericBodyMatch struct {
	// HTTP request generic body match configuration.
	HttpRequestGenericBodyMatch *HttpGenericBodyMatch `protobuf:"bytes,9,opt,name=http_request_generic_body_match,json=httpRequestGenericBodyMatch,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_HttpResponseGenericBodyMatch 

type MatchPredicate_HttpResponseGenericBodyMatch struct {
	// HTTP response generic body match configuration.
	HttpResponseGenericBodyMatch *HttpGenericBodyMatch `protobuf:"bytes,10,opt,name=http_response_generic_body_match,json=httpResponseGenericBodyMatch,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) Descriptor deprecated 

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

Deprecated: Use MatchPredicate_MatchSet.ProtoReflect.Descriptor instead.

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) String 

func (x *MatchPredicate_MatchSet) String() string

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 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_v3_api_field_data.tap.v3.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_v3_api_field_data.tap.v3.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_v3_api_msg_data.tap.v3.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) Descriptor deprecated 

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

Deprecated: Use OutputConfig.ProtoReflect.Descriptor instead.

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) ProtoMessage 

func (*OutputConfig) ProtoMessage()

func (*OutputConfig) ProtoReflect 

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

func (*OutputConfig) Reset 

func (x *OutputConfig) Reset()

func (*OutputConfig) String 

func (x *OutputConfig) String() string

type OutputSink 

type OutputSink struct {

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

Tap output sink configuration. [#next-free-field: 7]

func (*OutputSink) Descriptor deprecated 

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

Deprecated: Use OutputSink.ProtoReflect.Descriptor instead.

func (*OutputSink) GetBufferedAdmin 

func (x *OutputSink) GetBufferedAdmin() *BufferedAdminSink

func (*OutputSink) GetCustomSink 

func (x *OutputSink) GetCustomSink() *v31.TypedExtensionConfig

func (*OutputSink) GetFilePerTap 

func (x *OutputSink) GetFilePerTap() *FilePerTapSink

func (*OutputSink) GetFormat 

func (x *OutputSink) GetFormat() OutputSink_Format

func (*OutputSink) GetOutputSinkType 

func (m *OutputSink) GetOutputSinkType() isOutputSink_OutputSinkType

func (*OutputSink) GetStreamingAdmin 

func (x *OutputSink) GetStreamingAdmin() *StreamingAdminSink

func (*OutputSink) GetStreamingGrpc 

func (x *OutputSink) GetStreamingGrpc() *StreamingGrpcSink

func (*OutputSink) ProtoMessage 

func (*OutputSink) ProtoMessage()

func (*OutputSink) ProtoReflect 

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

func (*OutputSink) Reset 

func (x *OutputSink) Reset()

func (*OutputSink) String 

func (x *OutputSink) String() string

type OutputSink_BufferedAdmin 

type OutputSink_BufferedAdmin struct {
	// Tap output will be buffered in a single block before flushing to the :http:post:`/tap` admin endpoint
	//
	// .. attention::
	//
	//	It is only allowed to specify the buffered 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 buffered admin output type will fail.
	BufferedAdmin *BufferedAdminSink `protobuf:"bytes,5,opt,name=buffered_admin,json=bufferedAdmin,proto3,oneof"`
}

type OutputSink_CustomSink 

type OutputSink_CustomSink struct {
	// Tap output filter will be defined by an extension type
	CustomSink *v31.TypedExtensionConfig `protobuf:"bytes,6,opt,name=custom_sink,json=customSink,proto3,oneof"`
}

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_v3_api_msg_data.tap.v3.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_v3_api_msg_data.tap.v3.Body>`
	// data will be present in the :ref:`as_bytes
	// <envoy_v3_api_field_data.tap.v3.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_v3_api_msg_data.tap.v3.Body>`
	// data will be present in the :ref:`as_string
	// <envoy_v3_api_field_data.tap.v3.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) EnumDescriptor deprecated 

func (OutputSink_Format) EnumDescriptor() ([]byte, []int)

Deprecated: Use OutputSink_Format.Descriptor instead.

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.
	// [#comment: TODO(samflattery): remove cleanup in uber_per_filter.cc once implemented]
	StreamingGrpc *StreamingGrpcSink `protobuf:"bytes,4,opt,name=streaming_grpc,json=streamingGrpc,proto3,oneof"`
}

type StreamingAdminSink 

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

Streaming admin sink configuration.

func (*StreamingAdminSink) Descriptor deprecated 

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

Deprecated: Use StreamingAdminSink.ProtoReflect.Descriptor instead.

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 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 *v31.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) Descriptor deprecated 

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

Deprecated: Use StreamingGrpcSink.ProtoReflect.Descriptor instead.

func (*StreamingGrpcSink) GetGrpcService 

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

func (*StreamingGrpcSink) GetTapId 

func (x *StreamingGrpcSink) GetTapId() string

func (*StreamingGrpcSink) ProtoMessage 

func (*StreamingGrpcSink) ProtoMessage()

func (*StreamingGrpcSink) ProtoReflect 

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

func (*StreamingGrpcSink) Reset 

func (x *StreamingGrpcSink) Reset()

func (*StreamingGrpcSink) String 

func (x *StreamingGrpcSink) String() string

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.
	// Exactly one of :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` and
	// :ref:`match_config <envoy_v3_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
	// are set, the :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` will be used.
	//
	// Deprecated: Marked as deprecated in envoy/config/tap/v3/common.proto.
	MatchConfig *MatchPredicate `protobuf:"bytes,1,opt,name=match_config,json=matchConfig,proto3" json:"match_config,omitempty"`
	// The match configuration. If the configuration matches the data source being tapped, a tap will
	// occur, with the result written to the configured output.
	// Exactly one of :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` and
	// :ref:`match_config <envoy_v3_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
	// are set, the :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` will be used.
	Match *v3.MatchPredicate `protobuf:"bytes,4,opt,name=match,proto3" json:"match,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_v3_api_enum_type.v3.FractionalPercent.DenominatorType>`.
	TapEnabled *v31.RuntimeFractionalPercent `protobuf:"bytes,3,opt,name=tap_enabled,json=tapEnabled,proto3" json:"tap_enabled,omitempty"`
	// contains filtered or unexported fields
}

Tap configuration.

func (*TapConfig) Descriptor deprecated 

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

Deprecated: Use TapConfig.ProtoReflect.Descriptor instead.

func (*TapConfig) GetMatch 

func (x *TapConfig) GetMatch() *v3.MatchPredicate

func (*TapConfig) GetMatchConfig deprecated 

func (x *TapConfig) GetMatchConfig() *MatchPredicate

Deprecated: Marked as deprecated in envoy/config/tap/v3/common.proto.

func (*TapConfig) GetOutputConfig 

func (x *TapConfig) GetOutputConfig() *OutputConfig

func (*TapConfig) GetTapEnabled 

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

func (*TapConfig) ProtoMessage 

func (*TapConfig) ProtoMessage()

func (*TapConfig) ProtoReflect 

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

func (*TapConfig) Reset 

func (x *TapConfig) Reset()

func (*TapConfig) String 

func (x *TapConfig) String() string

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.