Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterTapSinkServiceServer(s grpc.ServiceRegistrar, srv TapSinkServiceServer)
- type StreamTapsRequest
- func (*StreamTapsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *StreamTapsRequest) GetIdentifier() *StreamTapsRequest_Identifier
- func (x *StreamTapsRequest) GetTrace() *v3.TraceWrapper
- func (x *StreamTapsRequest) GetTraceId() uint64
- func (*StreamTapsRequest) ProtoMessage()
- func (x *StreamTapsRequest) ProtoReflect() protoreflect.Message
- func (x *StreamTapsRequest) Reset()
- func (x *StreamTapsRequest) String() string
- type StreamTapsRequest_Identifier
- func (*StreamTapsRequest_Identifier) Descriptor() ([]byte, []int)deprecated
- func (x *StreamTapsRequest_Identifier) GetNode() *v31.Node
- func (x *StreamTapsRequest_Identifier) GetTapId() string
- func (*StreamTapsRequest_Identifier) ProtoMessage()
- func (x *StreamTapsRequest_Identifier) ProtoReflect() protoreflect.Message
- func (x *StreamTapsRequest_Identifier) Reset()
- func (x *StreamTapsRequest_Identifier) String() string
- type StreamTapsResponse
- type TapSinkServiceClient
- type TapSinkServiceServer
- type TapSinkService_StreamTapsClient
- type TapSinkService_StreamTapsServer
- type UnimplementedTapSinkServiceServer
- type UnsafeTapSinkServiceServer
Constants ¶
const (
TapSinkService_StreamTaps_FullMethodName = "/envoy.service.tap.v3.TapSinkService/StreamTaps"
)
Variables ¶
var File_envoy_service_tap_v3_tap_proto protoreflect.FileDescriptor
var TapSinkService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "envoy.service.tap.v3.TapSinkService", HandlerType: (*TapSinkServiceServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "StreamTaps", Handler: _TapSinkService_StreamTaps_Handler, ClientStreams: true, }, }, Metadata: "envoy/service/tap/v3/tap.proto", }
TapSinkService_ServiceDesc is the grpc.ServiceDesc for TapSinkService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterTapSinkServiceServer ¶
func RegisterTapSinkServiceServer(s grpc.ServiceRegistrar, srv TapSinkServiceServer)
Types ¶
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 *v3.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) Descriptor
deprecated
func (*StreamTapsRequest) Descriptor() ([]byte, []int)
Deprecated: Use StreamTapsRequest.ProtoReflect.Descriptor instead.
func (*StreamTapsRequest) GetIdentifier ¶
func (x *StreamTapsRequest) GetIdentifier() *StreamTapsRequest_Identifier
func (*StreamTapsRequest) GetTrace ¶
func (x *StreamTapsRequest) GetTrace() *v3.TraceWrapper
func (*StreamTapsRequest) GetTraceId ¶
func (x *StreamTapsRequest) GetTraceId() uint64
func (*StreamTapsRequest) ProtoMessage ¶
func (*StreamTapsRequest) ProtoMessage()
func (*StreamTapsRequest) ProtoReflect ¶
func (x *StreamTapsRequest) ProtoReflect() protoreflect.Message
func (*StreamTapsRequest) Reset ¶
func (x *StreamTapsRequest) Reset()
func (*StreamTapsRequest) String ¶
func (x *StreamTapsRequest) String() string
type StreamTapsRequest_Identifier ¶
type StreamTapsRequest_Identifier struct {
// The node sending taps over the stream.
Node *v31.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
// The opaque identifier that was set in the :ref:`output config
// <envoy_v3_api_field_config.tap.v3.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) Descriptor
deprecated
func (*StreamTapsRequest_Identifier) Descriptor() ([]byte, []int)
Deprecated: Use StreamTapsRequest_Identifier.ProtoReflect.Descriptor instead.
func (*StreamTapsRequest_Identifier) GetNode ¶
func (x *StreamTapsRequest_Identifier) GetNode() *v31.Node
func (*StreamTapsRequest_Identifier) GetTapId ¶
func (x *StreamTapsRequest_Identifier) GetTapId() string
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) String ¶
func (x *StreamTapsRequest_Identifier) String() string
type StreamTapsResponse ¶
type StreamTapsResponse struct {
// contains filtered or unexported fields
}
[#not-implemented-hide:]
func (*StreamTapsResponse) Descriptor
deprecated
func (*StreamTapsResponse) Descriptor() ([]byte, []int)
Deprecated: Use StreamTapsResponse.ProtoReflect.Descriptor instead.
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 TapSinkServiceClient ¶
type TapSinkServiceClient interface {
// Envoy will connect and send StreamTapsRequest messages forever. It does not expect any
// response to be sent as nothing would be done in the case of failure. The server should
// disconnect if it expects Envoy to reconnect.
StreamTaps(ctx context.Context, opts ...grpc.CallOption) (grpc.ClientStreamingClient[StreamTapsRequest, StreamTapsResponse], error)
}
TapSinkServiceClient is the client API for TapSinkService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
[#not-implemented-hide:] A tap service to receive incoming taps. Envoy will call StreamTaps to deliver captured taps to the server
func NewTapSinkServiceClient ¶
func NewTapSinkServiceClient(cc grpc.ClientConnInterface) TapSinkServiceClient
type TapSinkServiceServer ¶
type TapSinkServiceServer interface {
// Envoy will connect and send StreamTapsRequest messages forever. It does not expect any
// response to be sent as nothing would be done in the case of failure. The server should
// disconnect if it expects Envoy to reconnect.
StreamTaps(grpc.ClientStreamingServer[StreamTapsRequest, StreamTapsResponse]) error
// contains filtered or unexported methods
}
TapSinkServiceServer is the server API for TapSinkService service. All implementations must embed UnimplementedTapSinkServiceServer for forward compatibility.
[#not-implemented-hide:] A tap service to receive incoming taps. Envoy will call StreamTaps to deliver captured taps to the server
type TapSinkService_StreamTapsClient ¶
type TapSinkService_StreamTapsClient = grpc.ClientStreamingClient[StreamTapsRequest, StreamTapsResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type TapSinkService_StreamTapsServer ¶
type TapSinkService_StreamTapsServer = grpc.ClientStreamingServer[StreamTapsRequest, StreamTapsResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type UnimplementedTapSinkServiceServer ¶
type UnimplementedTapSinkServiceServer struct{}
UnimplementedTapSinkServiceServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedTapSinkServiceServer) StreamTaps ¶
func (UnimplementedTapSinkServiceServer) StreamTaps(grpc.ClientStreamingServer[StreamTapsRequest, StreamTapsResponse]) error
type UnsafeTapSinkServiceServer ¶
type UnsafeTapSinkServiceServer interface {
// contains filtered or unexported methods
}
UnsafeTapSinkServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TapSinkServiceServer will result in compilation errors.