event_reportingv3

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Aug 8, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	EventReportingService_StreamEvents_FullMethodName = "/envoy.service.event_reporting.v3.EventReportingService/StreamEvents"
)

Variables

View Source
var EventReportingService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "envoy.service.event_reporting.v3.EventReportingService",
	HandlerType: (*EventReportingServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamEvents",
			Handler:       _EventReportingService_StreamEvents_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "envoy/service/event_reporting/v3/event_reporting_service.proto",
}

EventReportingService_ServiceDesc is the grpc.ServiceDesc for EventReportingService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_envoy_service_event_reporting_v3_event_reporting_service_proto protoreflect.FileDescriptor

Functions

func RegisterEventReportingServiceServer

func RegisterEventReportingServiceServer(s grpc.ServiceRegistrar, srv EventReportingServiceServer)

Types

type EventReportingServiceClient

type EventReportingServiceClient interface {
	// Envoy will connect and send StreamEventsRequest messages forever.
	// The management server may send StreamEventsResponse to configure event stream. See below.
	// This API is designed for high throughput with the expectation that it might be lossy.
	StreamEvents(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[StreamEventsRequest, StreamEventsResponse], error)
}

EventReportingServiceClient is the client API for EventReportingService 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:] Service for streaming different types of events from Envoy to a server. The examples of such events may be health check or outlier detection events.

type EventReportingServiceServer

type EventReportingServiceServer interface {
	// Envoy will connect and send StreamEventsRequest messages forever.
	// The management server may send StreamEventsResponse to configure event stream. See below.
	// This API is designed for high throughput with the expectation that it might be lossy.
	StreamEvents(grpc.BidiStreamingServer[StreamEventsRequest, StreamEventsResponse]) error
	// contains filtered or unexported methods
}

EventReportingServiceServer is the server API for EventReportingService service. All implementations must embed UnimplementedEventReportingServiceServer for forward compatibility.

[#not-implemented-hide:] Service for streaming different types of events from Envoy to a server. The examples of such events may be health check or outlier detection events.

type EventReportingService_StreamEventsClient

type EventReportingService_StreamEventsClient = grpc.BidiStreamingClient[StreamEventsRequest, StreamEventsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type EventReportingService_StreamEventsServer

type EventReportingService_StreamEventsServer = grpc.BidiStreamingServer[StreamEventsRequest, StreamEventsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type StreamEventsRequest

type StreamEventsRequest struct {

	// Identifier data that will only be sent in the first message on the stream. This is effectively
	// structured metadata and is a performance optimization.
	Identifier *StreamEventsRequest_Identifier `protobuf:"bytes,1,opt,name=identifier,proto3" json:"identifier,omitempty"`
	// Batch of events. When the stream is already active, it will be the events occurred
	// since the last message had been sent. If the server receives unknown event type, it should
	// silently ignore it.
	//
	// The following events are supported:
	//
	// * :ref:`HealthCheckEvent <envoy_v3_api_msg_data.core.v3.HealthCheckEvent>`
	// * :ref:`OutlierDetectionEvent <envoy_v3_api_msg_data.cluster.v3.OutlierDetectionEvent>`
	Events []*anypb.Any `protobuf:"bytes,2,rep,name=events,proto3" json:"events,omitempty"`
	// contains filtered or unexported fields
}

[#not-implemented-hide:] An events envoy sends to the management server.

func (*StreamEventsRequest) Descriptor deprecated

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

Deprecated: Use StreamEventsRequest.ProtoReflect.Descriptor instead.

func (*StreamEventsRequest) GetEvents

func (x *StreamEventsRequest) GetEvents() []*anypb.Any

func (*StreamEventsRequest) GetIdentifier

func (*StreamEventsRequest) ProtoMessage

func (*StreamEventsRequest) ProtoMessage()

func (*StreamEventsRequest) ProtoReflect

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

func (*StreamEventsRequest) Reset

func (x *StreamEventsRequest) Reset()

func (*StreamEventsRequest) String

func (x *StreamEventsRequest) String() string

type StreamEventsRequest_Identifier

type StreamEventsRequest_Identifier struct {

	// The node sending the event messages over the stream.
	Node *v3.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	// contains filtered or unexported fields
}

func (*StreamEventsRequest_Identifier) Descriptor deprecated

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

Deprecated: Use StreamEventsRequest_Identifier.ProtoReflect.Descriptor instead.

func (*StreamEventsRequest_Identifier) GetNode

func (x *StreamEventsRequest_Identifier) GetNode() *v3.Node

func (*StreamEventsRequest_Identifier) ProtoMessage

func (*StreamEventsRequest_Identifier) ProtoMessage()

func (*StreamEventsRequest_Identifier) ProtoReflect

func (*StreamEventsRequest_Identifier) Reset

func (x *StreamEventsRequest_Identifier) Reset()

func (*StreamEventsRequest_Identifier) String

type StreamEventsResponse

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

[#not-implemented-hide:] The management server may send envoy a StreamEventsResponse to tell which events the server is interested in. In future, with aggregated event reporting service, this message will contain, for example, clusters the envoy should send events for, or event types the server wants to process.

func (*StreamEventsResponse) Descriptor deprecated

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

Deprecated: Use StreamEventsResponse.ProtoReflect.Descriptor instead.

func (*StreamEventsResponse) ProtoMessage

func (*StreamEventsResponse) ProtoMessage()

func (*StreamEventsResponse) ProtoReflect

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

func (*StreamEventsResponse) Reset

func (x *StreamEventsResponse) Reset()

func (*StreamEventsResponse) String

func (x *StreamEventsResponse) String() string

type UnimplementedEventReportingServiceServer

type UnimplementedEventReportingServiceServer struct{}

UnimplementedEventReportingServiceServer 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.

type UnsafeEventReportingServiceServer

type UnsafeEventReportingServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeEventReportingServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EventReportingServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL