v2

Documentation

Overview

Package v2 is a generated protocol buffer package.

It is generated from these files:

envoy/config/transport_socket/capture/v2alpha/capture.proto

It has these top-level messages:

FileSink
Capture

Index

• Variables
• type Capture
  • func (*Capture) Descriptor() ([]byte, []int)
  • func (m *Capture) GetFileSink() *FileSink
  • func (m *Capture) GetSinkSelector() isCapture_SinkSelector
  • func (m *Capture) GetTransportSocket() *envoy_api_v2_core.TransportSocket
  • func (m *Capture) Marshal() (dAtA []byte, err error)
  • func (m *Capture) MarshalTo(dAtA []byte) (int, error)
  • func (*Capture) ProtoMessage()
  • func (m *Capture) Reset()
  • func (m *Capture) Size() (n int)
  • func (m *Capture) String() string
  • func (m *Capture) Unmarshal(dAtA []byte) error
  • func (m *Capture) Validate() error
  • func (*Capture) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
• type CaptureValidationError
  • func (e CaptureValidationError) Error() string
• type Capture_FileSink
  • func (m *Capture_FileSink) MarshalTo(dAtA []byte) (int, error)
  • func (m *Capture_FileSink) Size() (n int)
• type FileSink
  • func (*FileSink) Descriptor() ([]byte, []int)
  • func (m *FileSink) GetFormat() FileSink_Format
  • func (m *FileSink) GetPathPrefix() string
  • func (m *FileSink) Marshal() (dAtA []byte, err error)
  • func (m *FileSink) MarshalTo(dAtA []byte) (int, error)
  • func (*FileSink) ProtoMessage()
  • func (m *FileSink) Reset()
  • func (m *FileSink) Size() (n int)
  • func (m *FileSink) String() string
  • func (m *FileSink) Unmarshal(dAtA []byte) error
  • func (m *FileSink) Validate() error
• type FileSinkValidationError
  • func (e FileSinkValidationError) Error() string
• type FileSink_Format
  • func (FileSink_Format) EnumDescriptor() ([]byte, []int)
  • func (x FileSink_Format) String() string

Variables

var (
	ErrInvalidLengthCapture = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowCapture   = fmt.Errorf("proto: integer overflow")
)

var FileSink_Format_name = map[int32]string{
	0: "PROTO_BINARY",
	1: "PROTO_TEXT",
}

var FileSink_Format_value = map[string]int32{
	"PROTO_BINARY": 0,
	"PROTO_TEXT":   1,
}

Types

type Capture

type Capture struct {
	// Types that are valid to be assigned to SinkSelector:
	//	*Capture_FileSink
	SinkSelector isCapture_SinkSelector `protobuf_oneof:"sink_selector"`
	// The underlying transport socket being wrapped.
	TransportSocket *envoy_api_v2_core.TransportSocket `protobuf:"bytes,2,opt,name=transport_socket,json=transportSocket" json:"transport_socket,omitempty"`
}

Configuration for capture transport socket. This wraps another transport socket, providing the ability to interpose and record in plain text any traffic that is surfaced to Envoy.

func (*Capture) Descriptor

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

func (*Capture) GetFileSink

func (m *Capture) GetFileSink() *FileSink

func (*Capture) GetSinkSelector

func (m *Capture) GetSinkSelector() isCapture_SinkSelector

func (*Capture) GetTransportSocket

func (m *Capture) GetTransportSocket() *envoy_api_v2_core.TransportSocket

func (*Capture) Marshal

func (m *Capture) Marshal() (dAtA []byte, err error)

func (*Capture) MarshalTo

func (m *Capture) MarshalTo(dAtA []byte) (int, error)

func (*Capture) ProtoMessage

func (*Capture) ProtoMessage()

func (*Capture) Reset

func (m *Capture) Reset()

func (*Capture) Size

func (m *Capture) Size() (n int)

func (*Capture) String

func (m *Capture) String() string

func (*Capture) Unmarshal

func (m *Capture) Unmarshal(dAtA []byte) error

func (*Capture) Validate

func (m *Capture) Validate() error

Validate checks the field values on Capture with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*Capture) XXX_OneofFuncs

func (*Capture) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type CaptureValidationError

type CaptureValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

CaptureValidationError is the validation error returned by Capture.Validate if the designated constraints aren't met.

func (CaptureValidationError) Error

func (e CaptureValidationError) Error() string

Error satisfies the builtin error interface

type Capture_FileSink

type Capture_FileSink struct {
	FileSink *FileSink `protobuf:"bytes,1,opt,name=file_sink,json=fileSink,oneof"`
}

func (*Capture_FileSink) MarshalTo

func (m *Capture_FileSink) MarshalTo(dAtA []byte) (int, error)

func (*Capture_FileSink) Size

func (m *Capture_FileSink) Size() (n int)

type FileSink

type FileSink 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 individual socket instances (the Envoy
	// connection ID).
	PathPrefix string          `protobuf:"bytes,1,opt,name=path_prefix,json=pathPrefix,proto3" json:"path_prefix,omitempty"`
	Format     FileSink_Format `` /* 133-byte string literal not displayed */
}

File sink.

.. warning::

The current file sink implementation buffers the entire trace in memory
prior to writing. This will OOM for long lived sockets and/or where there
is a large amount of traffic on the socket.

func (*FileSink) Descriptor

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

func (*FileSink) GetFormat

func (m *FileSink) GetFormat() FileSink_Format

func (*FileSink) GetPathPrefix

func (m *FileSink) GetPathPrefix() string

func (*FileSink) Marshal

func (m *FileSink) Marshal() (dAtA []byte, err error)

func (*FileSink) MarshalTo

func (m *FileSink) MarshalTo(dAtA []byte) (int, error)

func (*FileSink) ProtoMessage

func (*FileSink) ProtoMessage()

func (*FileSink) Reset

func (m *FileSink) Reset()

func (*FileSink) Size

func (m *FileSink) Size() (n int)

func (*FileSink) String

func (m *FileSink) String() string

func (*FileSink) Unmarshal

func (m *FileSink) Unmarshal(dAtA []byte) error

func (*FileSink) Validate

func (m *FileSink) Validate() error

Validate checks the field values on FileSink with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FileSinkValidationError

type FileSinkValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

FileSinkValidationError is the validation error returned by FileSink.Validate if the designated constraints aren't met.

func (FileSinkValidationError) Error

func (e FileSinkValidationError) Error() string

Error satisfies the builtin error interface

type FileSink_Format

type FileSink_Format int32

File format.

const (
	// Binary proto format as per :ref:`Trace
	// <envoy_api_msg_data.tap.v2alpha.Trace>`.
	FileSink_PROTO_BINARY FileSink_Format = 0
	// Text proto format as per :ref:`Trace
	// <envoy_api_msg_data.tap.v2alpha.Trace>`.
	FileSink_PROTO_TEXT FileSink_Format = 1
)

func (FileSink_Format) EnumDescriptor

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

func (FileSink_Format) String

func (x FileSink_Format) String() string