accesslogv3

package
v0.13.1 Latest Latest
Warning

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

Go to latest
Published: Oct 15, 2024 License: Apache-2.0 Imports: 24 Imported by: 43

Documentation

Index

Constants

View Source
const (
	AccessLogService_StreamAccessLogs_FullMethodName = "/envoy.service.accesslog.v3.AccessLogService/StreamAccessLogs"
)

Variables

View Source
var AccessLogService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "envoy.service.accesslog.v3.AccessLogService",
	HandlerType: (*AccessLogServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamAccessLogs",
			Handler:       _AccessLogService_StreamAccessLogs_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "envoy/service/accesslog/v3/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)

View Source
var File_envoy_service_accesslog_v3_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) (AccessLogService_StreamAccessLogsClient, 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.

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(AccessLogService_StreamAccessLogsServer) error
}

AccessLogServiceServer is the server API for AccessLogService service. All implementations should embed UnimplementedAccessLogServiceServer for forward compatibility

type AccessLogService_StreamAccessLogsClient

type AccessLogService_StreamAccessLogsClient interface {
	Send(*StreamAccessLogsMessage) error
	CloseAndRecv() (*StreamAccessLogsResponse, error)
	grpc.ClientStream
}

type AccessLogService_StreamAccessLogsServer

type AccessLogService_StreamAccessLogsServer interface {
	SendAndClose(*StreamAccessLogsResponse) error
	Recv() (*StreamAccessLogsMessage, error)
	grpc.ServerStream
}

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 (*StreamAccessLogsMessage) GetIdentifier

func (*StreamAccessLogsMessage) GetLogEntries

func (m *StreamAccessLogsMessage) GetLogEntries() isStreamAccessLogsMessage_LogEntries

func (*StreamAccessLogsMessage) GetTcpLogs

func (*StreamAccessLogsMessage) ProtoMessage

func (*StreamAccessLogsMessage) ProtoMessage()

func (*StreamAccessLogsMessage) ProtoReflect added in v0.9.6

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

func (*StreamAccessLogsMessage) Reset

func (x *StreamAccessLogsMessage) Reset()

func (*StreamAccessLogsMessage) String

func (x *StreamAccessLogsMessage) String() string

func (*StreamAccessLogsMessage) Validate

func (m *StreamAccessLogsMessage) Validate() error

Validate checks the field values on StreamAccessLogsMessage with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*StreamAccessLogsMessage) ValidateAll added in v0.10.0

func (m *StreamAccessLogsMessage) ValidateAll() error

ValidateAll checks the field values on StreamAccessLogsMessage with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in StreamAccessLogsMessageMultiError, or nil if none found.

type StreamAccessLogsMessageMultiError added in v0.10.0

type StreamAccessLogsMessageMultiError []error

StreamAccessLogsMessageMultiError is an error wrapping multiple validation errors returned by StreamAccessLogsMessage.ValidateAll() if the designated constraints aren't met.

func (StreamAccessLogsMessageMultiError) AllErrors added in v0.10.0

func (m StreamAccessLogsMessageMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StreamAccessLogsMessageMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type StreamAccessLogsMessageValidationError

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

StreamAccessLogsMessageValidationError is the validation error returned by StreamAccessLogsMessage.Validate if the designated constraints aren't met.

func (StreamAccessLogsMessageValidationError) Cause

Cause function returns cause value.

func (StreamAccessLogsMessageValidationError) Error

Error satisfies the builtin error interface

func (StreamAccessLogsMessageValidationError) ErrorName

ErrorName returns error name.

func (StreamAccessLogsMessageValidationError) Field

Field function returns field value.

func (StreamAccessLogsMessageValidationError) Key

Key function returns key value.

func (StreamAccessLogsMessageValidationError) Reason

Reason function returns reason value.

type StreamAccessLogsMessage_HTTPAccessLogEntries

type StreamAccessLogsMessage_HTTPAccessLogEntries struct {
	LogEntry []*v31.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

Deprecated: Use StreamAccessLogsMessage_HTTPAccessLogEntries.ProtoReflect.Descriptor instead.

func (*StreamAccessLogsMessage_HTTPAccessLogEntries) GetLogEntry

func (*StreamAccessLogsMessage_HTTPAccessLogEntries) ProtoMessage

func (*StreamAccessLogsMessage_HTTPAccessLogEntries) ProtoReflect added in v0.9.6

func (*StreamAccessLogsMessage_HTTPAccessLogEntries) Reset

func (*StreamAccessLogsMessage_HTTPAccessLogEntries) String

func (*StreamAccessLogsMessage_HTTPAccessLogEntries) Validate

Validate checks the field values on StreamAccessLogsMessage_HTTPAccessLogEntries with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*StreamAccessLogsMessage_HTTPAccessLogEntries) ValidateAll added in v0.10.0

ValidateAll checks the field values on StreamAccessLogsMessage_HTTPAccessLogEntries with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in StreamAccessLogsMessage_HTTPAccessLogEntriesMultiError, or nil if none found.

type StreamAccessLogsMessage_HTTPAccessLogEntriesMultiError added in v0.10.0

type StreamAccessLogsMessage_HTTPAccessLogEntriesMultiError []error

StreamAccessLogsMessage_HTTPAccessLogEntriesMultiError is an error wrapping multiple validation errors returned by StreamAccessLogsMessage_HTTPAccessLogEntries.ValidateAll() if the designated constraints aren't met.

func (StreamAccessLogsMessage_HTTPAccessLogEntriesMultiError) AllErrors added in v0.10.0

AllErrors returns a list of validation violation errors.

func (StreamAccessLogsMessage_HTTPAccessLogEntriesMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type StreamAccessLogsMessage_HTTPAccessLogEntriesValidationError

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

StreamAccessLogsMessage_HTTPAccessLogEntriesValidationError is the validation error returned by StreamAccessLogsMessage_HTTPAccessLogEntries.Validate if the designated constraints aren't met.

func (StreamAccessLogsMessage_HTTPAccessLogEntriesValidationError) Cause

Cause function returns cause value.

func (StreamAccessLogsMessage_HTTPAccessLogEntriesValidationError) Error

Error satisfies the builtin error interface

func (StreamAccessLogsMessage_HTTPAccessLogEntriesValidationError) ErrorName

ErrorName returns error name.

func (StreamAccessLogsMessage_HTTPAccessLogEntriesValidationError) Field

Field function returns field value.

func (StreamAccessLogsMessage_HTTPAccessLogEntriesValidationError) Key

Key function returns key value.

func (StreamAccessLogsMessage_HTTPAccessLogEntriesValidationError) Reason

Reason function returns reason value.

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 *v3.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	// The friendly name of the log configured in :ref:`CommonGrpcAccessLogConfig
	// <envoy_v3_api_msg_extensions.access_loggers.grpc.v3.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 (*StreamAccessLogsMessage_Identifier) GetNode

func (*StreamAccessLogsMessage_Identifier) ProtoMessage

func (*StreamAccessLogsMessage_Identifier) ProtoMessage()

func (*StreamAccessLogsMessage_Identifier) ProtoReflect added in v0.9.6

func (*StreamAccessLogsMessage_Identifier) Reset

func (*StreamAccessLogsMessage_Identifier) String

func (*StreamAccessLogsMessage_Identifier) Validate

Validate checks the field values on StreamAccessLogsMessage_Identifier with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*StreamAccessLogsMessage_Identifier) ValidateAll added in v0.10.0

func (m *StreamAccessLogsMessage_Identifier) ValidateAll() error

ValidateAll checks the field values on StreamAccessLogsMessage_Identifier with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in StreamAccessLogsMessage_IdentifierMultiError, or nil if none found.

type StreamAccessLogsMessage_IdentifierMultiError added in v0.10.0

type StreamAccessLogsMessage_IdentifierMultiError []error

StreamAccessLogsMessage_IdentifierMultiError is an error wrapping multiple validation errors returned by StreamAccessLogsMessage_Identifier.ValidateAll() if the designated constraints aren't met.

func (StreamAccessLogsMessage_IdentifierMultiError) AllErrors added in v0.10.0

AllErrors returns a list of validation violation errors.

func (StreamAccessLogsMessage_IdentifierMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type StreamAccessLogsMessage_IdentifierValidationError

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

StreamAccessLogsMessage_IdentifierValidationError is the validation error returned by StreamAccessLogsMessage_Identifier.Validate if the designated constraints aren't met.

func (StreamAccessLogsMessage_IdentifierValidationError) Cause

Cause function returns cause value.

func (StreamAccessLogsMessage_IdentifierValidationError) Error

Error satisfies the builtin error interface

func (StreamAccessLogsMessage_IdentifierValidationError) ErrorName

ErrorName returns error name.

func (StreamAccessLogsMessage_IdentifierValidationError) Field

Field function returns field value.

func (StreamAccessLogsMessage_IdentifierValidationError) Key

Key function returns key value.

func (StreamAccessLogsMessage_IdentifierValidationError) Reason

Reason function returns reason value.

type StreamAccessLogsMessage_TCPAccessLogEntries

type StreamAccessLogsMessage_TCPAccessLogEntries struct {
	LogEntry []*v31.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

Deprecated: Use StreamAccessLogsMessage_TCPAccessLogEntries.ProtoReflect.Descriptor instead.

func (*StreamAccessLogsMessage_TCPAccessLogEntries) GetLogEntry

func (*StreamAccessLogsMessage_TCPAccessLogEntries) ProtoMessage

func (*StreamAccessLogsMessage_TCPAccessLogEntries) ProtoReflect added in v0.9.6

func (*StreamAccessLogsMessage_TCPAccessLogEntries) Reset

func (*StreamAccessLogsMessage_TCPAccessLogEntries) String

func (*StreamAccessLogsMessage_TCPAccessLogEntries) Validate

Validate checks the field values on StreamAccessLogsMessage_TCPAccessLogEntries with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*StreamAccessLogsMessage_TCPAccessLogEntries) ValidateAll added in v0.10.0

ValidateAll checks the field values on StreamAccessLogsMessage_TCPAccessLogEntries with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in StreamAccessLogsMessage_TCPAccessLogEntriesMultiError, or nil if none found.

type StreamAccessLogsMessage_TCPAccessLogEntriesMultiError added in v0.10.0

type StreamAccessLogsMessage_TCPAccessLogEntriesMultiError []error

StreamAccessLogsMessage_TCPAccessLogEntriesMultiError is an error wrapping multiple validation errors returned by StreamAccessLogsMessage_TCPAccessLogEntries.ValidateAll() if the designated constraints aren't met.

func (StreamAccessLogsMessage_TCPAccessLogEntriesMultiError) AllErrors added in v0.10.0

AllErrors returns a list of validation violation errors.

func (StreamAccessLogsMessage_TCPAccessLogEntriesMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type StreamAccessLogsMessage_TCPAccessLogEntriesValidationError

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

StreamAccessLogsMessage_TCPAccessLogEntriesValidationError is the validation error returned by StreamAccessLogsMessage_TCPAccessLogEntries.Validate if the designated constraints aren't met.

func (StreamAccessLogsMessage_TCPAccessLogEntriesValidationError) Cause

Cause function returns cause value.

func (StreamAccessLogsMessage_TCPAccessLogEntriesValidationError) Error

Error satisfies the builtin error interface

func (StreamAccessLogsMessage_TCPAccessLogEntriesValidationError) ErrorName

ErrorName returns error name.

func (StreamAccessLogsMessage_TCPAccessLogEntriesValidationError) Field

Field function returns field value.

func (StreamAccessLogsMessage_TCPAccessLogEntriesValidationError) Key

Key function returns key value.

func (StreamAccessLogsMessage_TCPAccessLogEntriesValidationError) Reason

Reason function returns reason value.

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 added in v0.9.6

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

func (*StreamAccessLogsResponse) Reset

func (x *StreamAccessLogsResponse) Reset()

func (*StreamAccessLogsResponse) String

func (x *StreamAccessLogsResponse) String() string

func (*StreamAccessLogsResponse) Validate

func (m *StreamAccessLogsResponse) Validate() error

Validate checks the field values on StreamAccessLogsResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*StreamAccessLogsResponse) ValidateAll added in v0.10.0

func (m *StreamAccessLogsResponse) ValidateAll() error

ValidateAll checks the field values on StreamAccessLogsResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in StreamAccessLogsResponseMultiError, or nil if none found.

type StreamAccessLogsResponseMultiError added in v0.10.0

type StreamAccessLogsResponseMultiError []error

StreamAccessLogsResponseMultiError is an error wrapping multiple validation errors returned by StreamAccessLogsResponse.ValidateAll() if the designated constraints aren't met.

func (StreamAccessLogsResponseMultiError) AllErrors added in v0.10.0

func (m StreamAccessLogsResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StreamAccessLogsResponseMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type StreamAccessLogsResponseValidationError

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

StreamAccessLogsResponseValidationError is the validation error returned by StreamAccessLogsResponse.Validate if the designated constraints aren't met.

func (StreamAccessLogsResponseValidationError) Cause

Cause function returns cause value.

func (StreamAccessLogsResponseValidationError) Error

Error satisfies the builtin error interface

func (StreamAccessLogsResponseValidationError) ErrorName

ErrorName returns error name.

func (StreamAccessLogsResponseValidationError) Field

Field function returns field value.

func (StreamAccessLogsResponseValidationError) Key

Key function returns key value.

func (StreamAccessLogsResponseValidationError) Reason

Reason function returns reason value.

type UnimplementedAccessLogServiceServer

type UnimplementedAccessLogServiceServer struct {
}

UnimplementedAccessLogServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedAccessLogServiceServer) StreamAccessLogs

type UnsafeAccessLogServiceServer added in v0.13.0

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.

Jump to

Keyboard shortcuts

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