Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterAccessLogServiceServer(s grpc.ServiceRegistrar, srv AccessLogServiceServer)
- type AccessLogServiceClient
- type AccessLogServiceServer
- type AccessLogService_StreamAccessLogsClient
- type AccessLogService_StreamAccessLogsServer
- type StreamAccessLogsMessage
- func (*StreamAccessLogsMessage) Descriptor() ([]byte, []int)deprecated
- func (x *StreamAccessLogsMessage) GetHttpLogs() *StreamAccessLogsMessage_HTTPAccessLogEntries
- func (x *StreamAccessLogsMessage) GetIdentifier() *StreamAccessLogsMessage_Identifier
- func (m *StreamAccessLogsMessage) GetLogEntries() isStreamAccessLogsMessage_LogEntries
- func (x *StreamAccessLogsMessage) GetTcpLogs() *StreamAccessLogsMessage_TCPAccessLogEntries
- func (*StreamAccessLogsMessage) ProtoMessage()
- func (x *StreamAccessLogsMessage) ProtoReflect() protoreflect.Message
- func (x *StreamAccessLogsMessage) Reset()
- func (x *StreamAccessLogsMessage) String() string
- type StreamAccessLogsMessage_HTTPAccessLogEntries
- func (*StreamAccessLogsMessage_HTTPAccessLogEntries) Descriptor() ([]byte, []int)deprecated
- func (x *StreamAccessLogsMessage_HTTPAccessLogEntries) GetLogEntry() []*v2.HTTPAccessLogEntry
- func (*StreamAccessLogsMessage_HTTPAccessLogEntries) ProtoMessage()
- func (x *StreamAccessLogsMessage_HTTPAccessLogEntries) ProtoReflect() protoreflect.Message
- func (x *StreamAccessLogsMessage_HTTPAccessLogEntries) Reset()
- func (x *StreamAccessLogsMessage_HTTPAccessLogEntries) String() string
- type StreamAccessLogsMessage_HttpLogs
- type StreamAccessLogsMessage_Identifier
- func (*StreamAccessLogsMessage_Identifier) Descriptor() ([]byte, []int)deprecated
- func (x *StreamAccessLogsMessage_Identifier) GetLogName() string
- func (x *StreamAccessLogsMessage_Identifier) GetNode() *core.Node
- func (*StreamAccessLogsMessage_Identifier) ProtoMessage()
- func (x *StreamAccessLogsMessage_Identifier) ProtoReflect() protoreflect.Message
- func (x *StreamAccessLogsMessage_Identifier) Reset()
- func (x *StreamAccessLogsMessage_Identifier) String() string
- type StreamAccessLogsMessage_TCPAccessLogEntries
- func (*StreamAccessLogsMessage_TCPAccessLogEntries) Descriptor() ([]byte, []int)deprecated
- func (x *StreamAccessLogsMessage_TCPAccessLogEntries) GetLogEntry() []*v2.TCPAccessLogEntry
- func (*StreamAccessLogsMessage_TCPAccessLogEntries) ProtoMessage()
- func (x *StreamAccessLogsMessage_TCPAccessLogEntries) ProtoReflect() protoreflect.Message
- func (x *StreamAccessLogsMessage_TCPAccessLogEntries) Reset()
- func (x *StreamAccessLogsMessage_TCPAccessLogEntries) String() string
- type StreamAccessLogsMessage_TcpLogs
- type StreamAccessLogsResponse
- type UnimplementedAccessLogServiceServer
- type UnsafeAccessLogServiceServer
Constants ¶
const (
AccessLogService_StreamAccessLogs_FullMethodName = "/envoy.service.accesslog.v2.AccessLogService/StreamAccessLogs"
)
Variables ¶
var AccessLogService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "envoy.service.accesslog.v2.AccessLogService", HandlerType: (*AccessLogServiceServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "StreamAccessLogs", Handler: _AccessLogService_StreamAccessLogs_Handler, ClientStreams: true, }, }, Metadata: "envoy/service/accesslog/v2/als.proto", }
AccessLogService_ServiceDesc is the grpc.ServiceDesc for AccessLogService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_envoy_service_accesslog_v2_als_proto protoreflect.FileDescriptor
Functions ¶
func RegisterAccessLogServiceServer ¶
func RegisterAccessLogServiceServer(s grpc.ServiceRegistrar, srv AccessLogServiceServer)
Types ¶
type AccessLogServiceClient ¶
type AccessLogServiceClient interface { // Envoy will connect and send StreamAccessLogsMessage 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. In the future we may decide to add a different // API for "critical" access logs in which Envoy will buffer access logs for some period of time // until it gets an ACK so it could then retry. This API is designed for high throughput with the // expectation that it might be lossy. StreamAccessLogs(ctx context.Context, opts ...grpc.CallOption) (grpc.ClientStreamingClient[StreamAccessLogsMessage, StreamAccessLogsResponse], error) }
AccessLogServiceClient is the client API for AccessLogService 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.
Service for streaming access logs from Envoy to an access log server.
func NewAccessLogServiceClient ¶
func NewAccessLogServiceClient(cc grpc.ClientConnInterface) AccessLogServiceClient
type AccessLogServiceServer ¶
type AccessLogServiceServer interface { // Envoy will connect and send StreamAccessLogsMessage 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. In the future we may decide to add a different // API for "critical" access logs in which Envoy will buffer access logs for some period of time // until it gets an ACK so it could then retry. This API is designed for high throughput with the // expectation that it might be lossy. StreamAccessLogs(grpc.ClientStreamingServer[StreamAccessLogsMessage, StreamAccessLogsResponse]) error // contains filtered or unexported methods }
AccessLogServiceServer is the server API for AccessLogService service. All implementations must embed UnimplementedAccessLogServiceServer for forward compatibility.
Service for streaming access logs from Envoy to an access log server.
type AccessLogService_StreamAccessLogsClient ¶
type AccessLogService_StreamAccessLogsClient = grpc.ClientStreamingClient[StreamAccessLogsMessage, StreamAccessLogsResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type AccessLogService_StreamAccessLogsServer ¶
type AccessLogService_StreamAccessLogsServer = grpc.ClientStreamingServer[StreamAccessLogsMessage, StreamAccessLogsResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type StreamAccessLogsMessage ¶
type StreamAccessLogsMessage 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 *StreamAccessLogsMessage_Identifier `protobuf:"bytes,1,opt,name=identifier,proto3" json:"identifier,omitempty"` // Batches of log entries of a single type. Generally speaking, a given stream should only // ever include one type of log entry. // // Types that are assignable to LogEntries: // // *StreamAccessLogsMessage_HttpLogs // *StreamAccessLogsMessage_TcpLogs LogEntries isStreamAccessLogsMessage_LogEntries `protobuf_oneof:"log_entries"` // contains filtered or unexported fields }
Stream message for the StreamAccessLogs API. Envoy will open a stream to the server and stream access logs without ever expecting a response.
func (*StreamAccessLogsMessage) Descriptor
deprecated
func (*StreamAccessLogsMessage) Descriptor() ([]byte, []int)
Deprecated: Use StreamAccessLogsMessage.ProtoReflect.Descriptor instead.
func (*StreamAccessLogsMessage) GetHttpLogs ¶
func (x *StreamAccessLogsMessage) GetHttpLogs() *StreamAccessLogsMessage_HTTPAccessLogEntries
func (*StreamAccessLogsMessage) GetIdentifier ¶
func (x *StreamAccessLogsMessage) GetIdentifier() *StreamAccessLogsMessage_Identifier
func (*StreamAccessLogsMessage) GetLogEntries ¶
func (m *StreamAccessLogsMessage) GetLogEntries() isStreamAccessLogsMessage_LogEntries
func (*StreamAccessLogsMessage) GetTcpLogs ¶
func (x *StreamAccessLogsMessage) GetTcpLogs() *StreamAccessLogsMessage_TCPAccessLogEntries
func (*StreamAccessLogsMessage) ProtoMessage ¶
func (*StreamAccessLogsMessage) ProtoMessage()
func (*StreamAccessLogsMessage) ProtoReflect ¶
func (x *StreamAccessLogsMessage) ProtoReflect() protoreflect.Message
func (*StreamAccessLogsMessage) Reset ¶
func (x *StreamAccessLogsMessage) Reset()
func (*StreamAccessLogsMessage) String ¶
func (x *StreamAccessLogsMessage) String() string
type StreamAccessLogsMessage_HTTPAccessLogEntries ¶
type StreamAccessLogsMessage_HTTPAccessLogEntries struct { LogEntry []*v2.HTTPAccessLogEntry `protobuf:"bytes,1,rep,name=log_entry,json=logEntry,proto3" json:"log_entry,omitempty"` // contains filtered or unexported fields }
Wrapper for batches of HTTP access log entries.
func (*StreamAccessLogsMessage_HTTPAccessLogEntries) Descriptor
deprecated
func (*StreamAccessLogsMessage_HTTPAccessLogEntries) Descriptor() ([]byte, []int)
Deprecated: Use StreamAccessLogsMessage_HTTPAccessLogEntries.ProtoReflect.Descriptor instead.
func (*StreamAccessLogsMessage_HTTPAccessLogEntries) GetLogEntry ¶
func (x *StreamAccessLogsMessage_HTTPAccessLogEntries) GetLogEntry() []*v2.HTTPAccessLogEntry
func (*StreamAccessLogsMessage_HTTPAccessLogEntries) ProtoMessage ¶
func (*StreamAccessLogsMessage_HTTPAccessLogEntries) ProtoMessage()
func (*StreamAccessLogsMessage_HTTPAccessLogEntries) ProtoReflect ¶
func (x *StreamAccessLogsMessage_HTTPAccessLogEntries) ProtoReflect() protoreflect.Message
func (*StreamAccessLogsMessage_HTTPAccessLogEntries) Reset ¶
func (x *StreamAccessLogsMessage_HTTPAccessLogEntries) Reset()
func (*StreamAccessLogsMessage_HTTPAccessLogEntries) String ¶
func (x *StreamAccessLogsMessage_HTTPAccessLogEntries) String() string
type StreamAccessLogsMessage_HttpLogs ¶
type StreamAccessLogsMessage_HttpLogs struct {
HttpLogs *StreamAccessLogsMessage_HTTPAccessLogEntries `protobuf:"bytes,2,opt,name=http_logs,json=httpLogs,proto3,oneof"`
}
type StreamAccessLogsMessage_Identifier ¶
type StreamAccessLogsMessage_Identifier struct { // The node sending the access log messages over the stream. Node *core.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"` // The friendly name of the log configured in :ref:`CommonGrpcAccessLogConfig // <envoy_api_msg_config.accesslog.v2.CommonGrpcAccessLogConfig>`. LogName string `protobuf:"bytes,2,opt,name=log_name,json=logName,proto3" json:"log_name,omitempty"` // contains filtered or unexported fields }
func (*StreamAccessLogsMessage_Identifier) Descriptor
deprecated
func (*StreamAccessLogsMessage_Identifier) Descriptor() ([]byte, []int)
Deprecated: Use StreamAccessLogsMessage_Identifier.ProtoReflect.Descriptor instead.
func (*StreamAccessLogsMessage_Identifier) GetLogName ¶
func (x *StreamAccessLogsMessage_Identifier) GetLogName() string
func (*StreamAccessLogsMessage_Identifier) GetNode ¶
func (x *StreamAccessLogsMessage_Identifier) GetNode() *core.Node
func (*StreamAccessLogsMessage_Identifier) ProtoMessage ¶
func (*StreamAccessLogsMessage_Identifier) ProtoMessage()
func (*StreamAccessLogsMessage_Identifier) ProtoReflect ¶
func (x *StreamAccessLogsMessage_Identifier) ProtoReflect() protoreflect.Message
func (*StreamAccessLogsMessage_Identifier) Reset ¶
func (x *StreamAccessLogsMessage_Identifier) Reset()
func (*StreamAccessLogsMessage_Identifier) String ¶
func (x *StreamAccessLogsMessage_Identifier) String() string
type StreamAccessLogsMessage_TCPAccessLogEntries ¶
type StreamAccessLogsMessage_TCPAccessLogEntries struct { LogEntry []*v2.TCPAccessLogEntry `protobuf:"bytes,1,rep,name=log_entry,json=logEntry,proto3" json:"log_entry,omitempty"` // contains filtered or unexported fields }
Wrapper for batches of TCP access log entries.
func (*StreamAccessLogsMessage_TCPAccessLogEntries) Descriptor
deprecated
func (*StreamAccessLogsMessage_TCPAccessLogEntries) Descriptor() ([]byte, []int)
Deprecated: Use StreamAccessLogsMessage_TCPAccessLogEntries.ProtoReflect.Descriptor instead.
func (*StreamAccessLogsMessage_TCPAccessLogEntries) GetLogEntry ¶
func (x *StreamAccessLogsMessage_TCPAccessLogEntries) GetLogEntry() []*v2.TCPAccessLogEntry
func (*StreamAccessLogsMessage_TCPAccessLogEntries) ProtoMessage ¶
func (*StreamAccessLogsMessage_TCPAccessLogEntries) ProtoMessage()
func (*StreamAccessLogsMessage_TCPAccessLogEntries) ProtoReflect ¶
func (x *StreamAccessLogsMessage_TCPAccessLogEntries) ProtoReflect() protoreflect.Message
func (*StreamAccessLogsMessage_TCPAccessLogEntries) Reset ¶
func (x *StreamAccessLogsMessage_TCPAccessLogEntries) Reset()
func (*StreamAccessLogsMessage_TCPAccessLogEntries) String ¶
func (x *StreamAccessLogsMessage_TCPAccessLogEntries) String() string
type StreamAccessLogsMessage_TcpLogs ¶
type StreamAccessLogsMessage_TcpLogs struct {
TcpLogs *StreamAccessLogsMessage_TCPAccessLogEntries `protobuf:"bytes,3,opt,name=tcp_logs,json=tcpLogs,proto3,oneof"`
}
type StreamAccessLogsResponse ¶
type StreamAccessLogsResponse struct {
// contains filtered or unexported fields
}
Empty response for the StreamAccessLogs API. Will never be sent. See below.
func (*StreamAccessLogsResponse) Descriptor
deprecated
func (*StreamAccessLogsResponse) Descriptor() ([]byte, []int)
Deprecated: Use StreamAccessLogsResponse.ProtoReflect.Descriptor instead.
func (*StreamAccessLogsResponse) ProtoMessage ¶
func (*StreamAccessLogsResponse) ProtoMessage()
func (*StreamAccessLogsResponse) ProtoReflect ¶
func (x *StreamAccessLogsResponse) ProtoReflect() protoreflect.Message
func (*StreamAccessLogsResponse) Reset ¶
func (x *StreamAccessLogsResponse) Reset()
func (*StreamAccessLogsResponse) String ¶
func (x *StreamAccessLogsResponse) String() string
type UnimplementedAccessLogServiceServer ¶
type UnimplementedAccessLogServiceServer struct{}
UnimplementedAccessLogServiceServer 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 (UnimplementedAccessLogServiceServer) StreamAccessLogs ¶
func (UnimplementedAccessLogServiceServer) StreamAccessLogs(grpc.ClientStreamingServer[StreamAccessLogsMessage, StreamAccessLogsResponse]) error
type UnsafeAccessLogServiceServer ¶
type UnsafeAccessLogServiceServer interface {
// contains filtered or unexported methods
}
UnsafeAccessLogServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AccessLogServiceServer will result in compilation errors.