als

package
v1.18.0-rc2 Latest Latest
Warning

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

 Go to latest Published: Nov 25, 2024 License: Apache-2.0 Imports: 25 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ComparisonFilter_Op_name = map[int32]string{
		0: "EQ",
		1: "GE",
		2: "LE",
	}
	ComparisonFilter_Op_value = map[string]int32{
		"EQ": 0,
		"GE": 1,
		"LE": 2,
	}
)

Enum value maps for ComparisonFilter_Op.

View Source 
var (
	GrpcStatusFilter_Status_name = map[int32]string{
		0:  "OK",
		1:  "CANCELED",
		2:  "UNKNOWN",
		3:  "INVALID_ARGUMENT",
		4:  "DEADLINE_EXCEEDED",
		5:  "NOT_FOUND",
		6:  "ALREADY_EXISTS",
		7:  "PERMISSION_DENIED",
		8:  "RESOURCE_EXHAUSTED",
		9:  "FAILED_PRECONDITION",
		10: "ABORTED",
		11: "OUT_OF_RANGE",
		12: "UNIMPLEMENTED",
		13: "INTERNAL",
		14: "UNAVAILABLE",
		15: "DATA_LOSS",
		16: "UNAUTHENTICATED",
	}
	GrpcStatusFilter_Status_value = map[string]int32{
		"OK":                  0,
		"CANCELED":            1,
		"UNKNOWN":             2,
		"INVALID_ARGUMENT":    3,
		"DEADLINE_EXCEEDED":   4,
		"NOT_FOUND":           5,
		"ALREADY_EXISTS":      6,
		"PERMISSION_DENIED":   7,
		"RESOURCE_EXHAUSTED":  8,
		"FAILED_PRECONDITION": 9,
		"ABORTED":             10,
		"OUT_OF_RANGE":        11,
		"UNIMPLEMENTED":       12,
		"INTERNAL":            13,
		"UNAVAILABLE":         14,
		"DATA_LOSS":           15,
		"UNAUTHENTICATED":     16,
	}
)

Enum value maps for GrpcStatusFilter_Status.

View Source 
var File_github_com_solo_io_gloo_projects_gloo_api_v1_options_als_als_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AccessLog 

type AccessLog struct {

	// type of Access Logging service to implement
	//
	// Types that are assignable to OutputDestination:
	//
	//	*AccessLog_FileSink
	//	*AccessLog_GrpcService
	OutputDestination isAccessLog_OutputDestination `protobuf_oneof:"OutputDestination"`
	Filter            *AccessLogFilter              `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

func (*AccessLog) Clone added in v1.8.24 

func (m *AccessLog) Clone() proto.Message

Clone function

func (*AccessLog) Descriptor deprecated 

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

Deprecated: Use AccessLog.ProtoReflect.Descriptor instead.

func (*AccessLog) Equal 

func (m *AccessLog) Equal(that interface{}) bool

Equal function

func (*AccessLog) GetFileSink 

func (x *AccessLog) GetFileSink() *FileSink

func (*AccessLog) GetFilter added in v1.13.20 

func (x *AccessLog) GetFilter() *AccessLogFilter

func (*AccessLog) GetGrpcService 

func (x *AccessLog) GetGrpcService() *GrpcService

func (*AccessLog) GetOutputDestination 

func (m *AccessLog) GetOutputDestination() isAccessLog_OutputDestination

func (*AccessLog) Hash deprecated added in v1.2.13 

func (m *AccessLog) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*AccessLog) HashUnique 

func (m *AccessLog) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*AccessLog) ProtoMessage 

func (*AccessLog) ProtoMessage()

func (*AccessLog) ProtoReflect added in v1.6.0 

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

func (*AccessLog) Reset 

func (x *AccessLog) Reset()

func (*AccessLog) String 

func (x *AccessLog) String() string

type AccessLogFilter added in v1.13.20 

type AccessLogFilter struct {

	// Types that are assignable to FilterSpecifier:
	//
	//	*AccessLogFilter_StatusCodeFilter
	//	*AccessLogFilter_DurationFilter
	//	*AccessLogFilter_NotHealthCheckFilter
	//	*AccessLogFilter_TraceableFilter
	//	*AccessLogFilter_RuntimeFilter
	//	*AccessLogFilter_AndFilter
	//	*AccessLogFilter_OrFilter
	//	*AccessLogFilter_HeaderFilter
	//	*AccessLogFilter_ResponseFlagFilter
	//	*AccessLogFilter_GrpcStatusFilter
	FilterSpecifier isAccessLogFilter_FilterSpecifier `protobuf_oneof:"filter_specifier"`
	// contains filtered or unexported fields
}

func (*AccessLogFilter) Clone added in v1.13.20 

func (m *AccessLogFilter) Clone() proto.Message

Clone function

func (*AccessLogFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use AccessLogFilter.ProtoReflect.Descriptor instead.

func (*AccessLogFilter) Equal added in v1.13.20 

func (m *AccessLogFilter) Equal(that interface{}) bool

Equal function

func (*AccessLogFilter) GetAndFilter added in v1.13.20 

func (x *AccessLogFilter) GetAndFilter() *AndFilter

func (*AccessLogFilter) GetDurationFilter added in v1.13.20 

func (x *AccessLogFilter) GetDurationFilter() *DurationFilter

func (*AccessLogFilter) GetFilterSpecifier added in v1.13.20 

func (m *AccessLogFilter) GetFilterSpecifier() isAccessLogFilter_FilterSpecifier

func (*AccessLogFilter) GetGrpcStatusFilter added in v1.13.20 

func (x *AccessLogFilter) GetGrpcStatusFilter() *GrpcStatusFilter

func (*AccessLogFilter) GetHeaderFilter added in v1.13.20 

func (x *AccessLogFilter) GetHeaderFilter() *HeaderFilter

func (*AccessLogFilter) GetNotHealthCheckFilter added in v1.13.20 

func (x *AccessLogFilter) GetNotHealthCheckFilter() *NotHealthCheckFilter

func (*AccessLogFilter) GetOrFilter added in v1.13.20 

func (x *AccessLogFilter) GetOrFilter() *OrFilter

func (*AccessLogFilter) GetResponseFlagFilter added in v1.13.20 

func (x *AccessLogFilter) GetResponseFlagFilter() *ResponseFlagFilter

func (*AccessLogFilter) GetRuntimeFilter added in v1.13.20 

func (x *AccessLogFilter) GetRuntimeFilter() *RuntimeFilter

func (*AccessLogFilter) GetStatusCodeFilter added in v1.13.20 

func (x *AccessLogFilter) GetStatusCodeFilter() *StatusCodeFilter

func (*AccessLogFilter) GetTraceableFilter added in v1.13.20 

func (x *AccessLogFilter) GetTraceableFilter() *TraceableFilter

func (*AccessLogFilter) Hash deprecated added in v1.13.20 

func (m *AccessLogFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*AccessLogFilter) HashUnique 

func (m *AccessLogFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*AccessLogFilter) ProtoMessage added in v1.13.20 

func (*AccessLogFilter) ProtoMessage()

func (*AccessLogFilter) ProtoReflect added in v1.13.20 

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

func (*AccessLogFilter) Reset added in v1.13.20 

func (x *AccessLogFilter) Reset()

func (*AccessLogFilter) String added in v1.13.20 

func (x *AccessLogFilter) String() string

type AccessLogFilter_AndFilter added in v1.13.20 

type AccessLogFilter_AndFilter struct {
	// And filter.
	AndFilter *AndFilter `protobuf:"bytes,6,opt,name=and_filter,json=andFilter,proto3,oneof"`
}

type AccessLogFilter_DurationFilter added in v1.13.20 

type AccessLogFilter_DurationFilter struct {
	// Duration filter.
	DurationFilter *DurationFilter `protobuf:"bytes,2,opt,name=duration_filter,json=durationFilter,proto3,oneof"`
}

type AccessLogFilter_GrpcStatusFilter added in v1.13.20 

type AccessLogFilter_GrpcStatusFilter struct {
	// gRPC status filter.
	GrpcStatusFilter *GrpcStatusFilter `protobuf:"bytes,10,opt,name=grpc_status_filter,json=grpcStatusFilter,proto3,oneof"`
}

type AccessLogFilter_HeaderFilter added in v1.13.20 

type AccessLogFilter_HeaderFilter struct {
	// Header filter.
	HeaderFilter *HeaderFilter `protobuf:"bytes,8,opt,name=header_filter,json=headerFilter,proto3,oneof"`
}

type AccessLogFilter_NotHealthCheckFilter added in v1.13.20 

type AccessLogFilter_NotHealthCheckFilter struct {
	// Not health check filter.
	NotHealthCheckFilter *NotHealthCheckFilter `protobuf:"bytes,3,opt,name=not_health_check_filter,json=notHealthCheckFilter,proto3,oneof"`
}

type AccessLogFilter_OrFilter added in v1.13.20 

type AccessLogFilter_OrFilter struct {
	// Or filter.
	OrFilter *OrFilter `protobuf:"bytes,7,opt,name=or_filter,json=orFilter,proto3,oneof"`
}

type AccessLogFilter_ResponseFlagFilter added in v1.13.20 

type AccessLogFilter_ResponseFlagFilter struct {
	// Response flag filter.
	ResponseFlagFilter *ResponseFlagFilter `protobuf:"bytes,9,opt,name=response_flag_filter,json=responseFlagFilter,proto3,oneof"`
}

type AccessLogFilter_RuntimeFilter added in v1.13.20 

type AccessLogFilter_RuntimeFilter struct {
	// Runtime filter.
	RuntimeFilter *RuntimeFilter `protobuf:"bytes,5,opt,name=runtime_filter,json=runtimeFilter,proto3,oneof"`
}

type AccessLogFilter_StatusCodeFilter added in v1.13.20 

type AccessLogFilter_StatusCodeFilter struct {
	// Status code filter.
	StatusCodeFilter *StatusCodeFilter `protobuf:"bytes,1,opt,name=status_code_filter,json=statusCodeFilter,proto3,oneof"`
}

type AccessLogFilter_TraceableFilter added in v1.13.20 

type AccessLogFilter_TraceableFilter struct {
	// Traceable filter.
	TraceableFilter *TraceableFilter `protobuf:"bytes,4,opt,name=traceable_filter,json=traceableFilter,proto3,oneof"`
}

type AccessLog_FileSink 

type AccessLog_FileSink struct {
	// Output access logs to local file
	FileSink *FileSink `protobuf:"bytes,2,opt,name=file_sink,json=fileSink,proto3,oneof"`
}

type AccessLog_GrpcService 

type AccessLog_GrpcService struct {
	// Send access logs to gRPC service
	GrpcService *GrpcService `protobuf:"bytes,3,opt,name=grpc_service,json=grpcService,proto3,oneof"`
}

type AccessLoggingService 

type AccessLoggingService struct {
	AccessLog []*AccessLog `protobuf:"bytes,1,rep,name=access_log,json=accessLog,proto3" json:"access_log,omitempty"`
	// contains filtered or unexported fields
}

Contains various settings for Envoy's access logging service. See here for more information: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/accesslog/v3/accesslog.proto

func (*AccessLoggingService) Clone added in v1.8.24 

func (m *AccessLoggingService) Clone() proto.Message

Clone function

func (*AccessLoggingService) Descriptor deprecated 

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

Deprecated: Use AccessLoggingService.ProtoReflect.Descriptor instead.

func (*AccessLoggingService) Equal 

func (m *AccessLoggingService) Equal(that interface{}) bool

Equal function

func (*AccessLoggingService) GetAccessLog 

func (x *AccessLoggingService) GetAccessLog() []*AccessLog

func (*AccessLoggingService) Hash deprecated added in v1.2.13 

func (m *AccessLoggingService) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*AccessLoggingService) HashUnique 

func (m *AccessLoggingService) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*AccessLoggingService) ProtoMessage 

func (*AccessLoggingService) ProtoMessage()

func (*AccessLoggingService) ProtoReflect added in v1.6.0 

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

func (*AccessLoggingService) Reset 

func (x *AccessLoggingService) Reset()

func (*AccessLoggingService) String 

func (x *AccessLoggingService) String() string

type AndFilter added in v1.13.20 

type AndFilter struct {
	Filters []*AccessLogFilter `protobuf:"bytes,1,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

Performs a logical “and” operation on the result of each filter in filters. Filters are evaluated sequentially and if one of them returns false, the filter returns false immediately.

func (*AndFilter) Clone added in v1.13.20 

func (m *AndFilter) Clone() proto.Message

Clone function

func (*AndFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use AndFilter.ProtoReflect.Descriptor instead.

func (*AndFilter) Equal added in v1.13.20 

func (m *AndFilter) Equal(that interface{}) bool

Equal function

func (*AndFilter) GetFilters added in v1.13.20 

func (x *AndFilter) GetFilters() []*AccessLogFilter

func (*AndFilter) Hash deprecated added in v1.13.20 

func (m *AndFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*AndFilter) HashUnique 

func (m *AndFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*AndFilter) ProtoMessage added in v1.13.20 

func (*AndFilter) ProtoMessage()

func (*AndFilter) ProtoReflect added in v1.13.20 

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

func (*AndFilter) Reset added in v1.13.20 

func (x *AndFilter) Reset()

func (*AndFilter) String added in v1.13.20 

func (x *AndFilter) String() string

type ComparisonFilter added in v1.13.20 

type ComparisonFilter struct {

	// Comparison operator.
	Op ComparisonFilter_Op `protobuf:"varint,1,opt,name=op,proto3,enum=als.options.gloo.solo.io.ComparisonFilter_Op" json:"op,omitempty"`
	// Value to compare against. Note that the `defaultValue` field must be defined unless
	// the `runtimeKey` matches a key that is defined in Envoy's [runtime configuration layer](https://www.envoyproxy.io/docs/envoy/v1.30.0/configuration/operations/runtime#config-runtime-bootstrap).
	// Gloo Gateway does not include a key by default. To specify a key-value pair, use the
	// [gatewayProxies.NAME.customStaticLayer]({{< versioned_link_path fromRoot="/reference/helm_chart_values/" >}})
	// Helm value or set the key at runtime by using the gateway proxy admin interface.
	Value *v3.RuntimeUInt32 `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Filter on an integer comparison.

func (*ComparisonFilter) Clone added in v1.13.20 

func (m *ComparisonFilter) Clone() proto.Message

Clone function

func (*ComparisonFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use ComparisonFilter.ProtoReflect.Descriptor instead.

func (*ComparisonFilter) Equal added in v1.13.20 

func (m *ComparisonFilter) Equal(that interface{}) bool

Equal function

func (*ComparisonFilter) GetOp added in v1.13.20 

func (x *ComparisonFilter) GetOp() ComparisonFilter_Op

func (*ComparisonFilter) GetValue added in v1.13.20 

func (x *ComparisonFilter) GetValue() *v3.RuntimeUInt32

func (*ComparisonFilter) Hash deprecated added in v1.13.20 

func (m *ComparisonFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*ComparisonFilter) HashUnique 

func (m *ComparisonFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*ComparisonFilter) ProtoMessage added in v1.13.20 

func (*ComparisonFilter) ProtoMessage()

func (*ComparisonFilter) ProtoReflect added in v1.13.20 

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

func (*ComparisonFilter) Reset added in v1.13.20 

func (x *ComparisonFilter) Reset()

func (*ComparisonFilter) String added in v1.13.20 

func (x *ComparisonFilter) String() string

type ComparisonFilter_Op added in v1.13.20 

type ComparisonFilter_Op int32
const (
	// =
	ComparisonFilter_EQ ComparisonFilter_Op = 0
	// >=
	ComparisonFilter_GE ComparisonFilter_Op = 1
	// <=
	ComparisonFilter_LE ComparisonFilter_Op = 2
)

func (ComparisonFilter_Op) Descriptor added in v1.13.20 

func (ComparisonFilter_Op) Descriptor() protoreflect.EnumDescriptor

func (ComparisonFilter_Op) Enum added in v1.13.20 

func (x ComparisonFilter_Op) Enum() *ComparisonFilter_Op

func (ComparisonFilter_Op) EnumDescriptor deprecated added in v1.13.20 

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

Deprecated: Use ComparisonFilter_Op.Descriptor instead.

func (ComparisonFilter_Op) Number added in v1.13.20 

func (x ComparisonFilter_Op) Number() protoreflect.EnumNumber

func (ComparisonFilter_Op) String added in v1.13.20 

func (x ComparisonFilter_Op) String() string

func (ComparisonFilter_Op) Type added in v1.13.20 

func (ComparisonFilter_Op) Type() protoreflect.EnumType

type DurationFilter added in v1.13.20 

type DurationFilter struct {

	// Comparison.
	Comparison *ComparisonFilter `protobuf:"bytes,1,opt,name=comparison,proto3" json:"comparison,omitempty"`
	// contains filtered or unexported fields
}

Filters on total request duration in milliseconds.

func (*DurationFilter) Clone added in v1.13.20 

func (m *DurationFilter) Clone() proto.Message

Clone function

func (*DurationFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use DurationFilter.ProtoReflect.Descriptor instead.

func (*DurationFilter) Equal added in v1.13.20 

func (m *DurationFilter) Equal(that interface{}) bool

Equal function

func (*DurationFilter) GetComparison added in v1.13.20 

func (x *DurationFilter) GetComparison() *ComparisonFilter

func (*DurationFilter) Hash deprecated added in v1.13.20 

func (m *DurationFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*DurationFilter) HashUnique 

func (m *DurationFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*DurationFilter) ProtoMessage added in v1.13.20 

func (*DurationFilter) ProtoMessage()

func (*DurationFilter) ProtoReflect added in v1.13.20 

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

func (*DurationFilter) Reset added in v1.13.20 

func (x *DurationFilter) Reset()

func (*DurationFilter) String added in v1.13.20 

func (x *DurationFilter) String() string

type FileSink 

type FileSink struct {

	// the file path to which the file access logging service will sink
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// the format which the logs should be outputted by
	//
	// Types that are assignable to OutputFormat:
	//
	//	*FileSink_StringFormat
	//	*FileSink_JsonFormat
	OutputFormat isFileSink_OutputFormat `protobuf_oneof:"output_format"`
	// contains filtered or unexported fields
}

func (*FileSink) Clone added in v1.8.24 

func (m *FileSink) Clone() proto.Message

Clone function

func (*FileSink) Descriptor deprecated 

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

Deprecated: Use FileSink.ProtoReflect.Descriptor instead.

func (*FileSink) Equal 

func (m *FileSink) Equal(that interface{}) bool

Equal function

func (*FileSink) GetJsonFormat 

func (x *FileSink) GetJsonFormat() *structpb.Struct

func (*FileSink) GetOutputFormat 

func (m *FileSink) GetOutputFormat() isFileSink_OutputFormat

func (*FileSink) GetPath 

func (x *FileSink) GetPath() string

func (*FileSink) GetStringFormat 

func (x *FileSink) GetStringFormat() string

func (*FileSink) Hash deprecated added in v1.2.13 

func (m *FileSink) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*FileSink) HashUnique 

func (m *FileSink) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*FileSink) ProtoMessage 

func (*FileSink) ProtoMessage()

func (*FileSink) ProtoReflect added in v1.6.0 

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

func (*FileSink) Reset 

func (x *FileSink) Reset()

func (*FileSink) String 

func (x *FileSink) String() string

type FileSink_JsonFormat 

type FileSink_JsonFormat struct {
	// the format object by which to envoy will emit the logs in a structured way.
	// https://www.envoyproxy.io/docs/envoy/v1.14.1/configuration/observability/access_log#format-dictionaries
	JsonFormat *structpb.Struct `protobuf:"bytes,3,opt,name=json_format,json=jsonFormat,proto3,oneof"`
}

type FileSink_StringFormat 

type FileSink_StringFormat struct {
	// the format string by which envoy will format the log lines
	// https://www.envoyproxy.io/docs/envoy/v1.14.1/configuration/observability/access_log#config-access-log-format-strings
	StringFormat string `protobuf:"bytes,2,opt,name=string_format,json=stringFormat,proto3,oneof"`
}

type GrpcService 

type GrpcService struct {

	// name of log stream
	LogName string `protobuf:"bytes,1,opt,name=log_name,json=logName,proto3" json:"log_name,omitempty"`
	// The static cluster defined in bootstrap config to route to
	//
	// Types that are assignable to ServiceRef:
	//
	//	*GrpcService_StaticClusterName
	ServiceRef                      isGrpcService_ServiceRef `protobuf_oneof:"service_ref"`
	AdditionalRequestHeadersToLog   []string                 `` /* 154-byte string literal not displayed */
	AdditionalResponseHeadersToLog  []string                 `` /* 157-byte string literal not displayed */
	AdditionalResponseTrailersToLog []string                 `` /* 160-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GrpcService) Clone added in v1.8.24 

func (m *GrpcService) Clone() proto.Message

Clone function

func (*GrpcService) Descriptor deprecated 

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

Deprecated: Use GrpcService.ProtoReflect.Descriptor instead.

func (*GrpcService) Equal 

func (m *GrpcService) Equal(that interface{}) bool

Equal function

func (*GrpcService) GetAdditionalRequestHeadersToLog 

func (x *GrpcService) GetAdditionalRequestHeadersToLog() []string

func (*GrpcService) GetAdditionalResponseHeadersToLog 

func (x *GrpcService) GetAdditionalResponseHeadersToLog() []string

func (*GrpcService) GetAdditionalResponseTrailersToLog 

func (x *GrpcService) GetAdditionalResponseTrailersToLog() []string

func (*GrpcService) GetLogName 

func (x *GrpcService) GetLogName() string

func (*GrpcService) GetServiceRef 

func (m *GrpcService) GetServiceRef() isGrpcService_ServiceRef

func (*GrpcService) GetStaticClusterName 

func (x *GrpcService) GetStaticClusterName() string

func (*GrpcService) Hash deprecated added in v1.2.13 

func (m *GrpcService) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*GrpcService) HashUnique 

func (m *GrpcService) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*GrpcService) ProtoMessage 

func (*GrpcService) ProtoMessage()

func (*GrpcService) ProtoReflect added in v1.6.0 

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

func (*GrpcService) Reset 

func (x *GrpcService) Reset()

func (*GrpcService) String 

func (x *GrpcService) String() string

type GrpcService_StaticClusterName 

type GrpcService_StaticClusterName struct {
	StaticClusterName string `protobuf:"bytes,2,opt,name=static_cluster_name,json=staticClusterName,proto3,oneof"`
}

type GrpcStatusFilter added in v1.13.20 

type GrpcStatusFilter struct {

	// Logs only responses that have any one of the gRPC statuses in this field.
	Statuses []GrpcStatusFilter_Status `` /* 131-byte string literal not displayed */
	// If included and set to true, the filter will instead block all responses
	// with a gRPC status or inferred gRPC status enumerated in statuses, and
	// allow all other responses.
	Exclude bool `protobuf:"varint,2,opt,name=exclude,proto3" json:"exclude,omitempty"`
	// contains filtered or unexported fields
}

Filters gRPC requests based on their response status. If a gRPC status is not provided, the filter will infer the status from the HTTP status code.

func (*GrpcStatusFilter) Clone added in v1.13.20 

func (m *GrpcStatusFilter) Clone() proto.Message

Clone function

func (*GrpcStatusFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use GrpcStatusFilter.ProtoReflect.Descriptor instead.

func (*GrpcStatusFilter) Equal added in v1.13.20 

func (m *GrpcStatusFilter) Equal(that interface{}) bool

Equal function

func (*GrpcStatusFilter) GetExclude added in v1.13.20 

func (x *GrpcStatusFilter) GetExclude() bool

func (*GrpcStatusFilter) GetStatuses added in v1.13.20 

func (x *GrpcStatusFilter) GetStatuses() []GrpcStatusFilter_Status

func (*GrpcStatusFilter) Hash deprecated added in v1.13.20 

func (m *GrpcStatusFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*GrpcStatusFilter) HashUnique 

func (m *GrpcStatusFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*GrpcStatusFilter) ProtoMessage added in v1.13.20 

func (*GrpcStatusFilter) ProtoMessage()

func (*GrpcStatusFilter) ProtoReflect added in v1.13.20 

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

func (*GrpcStatusFilter) Reset added in v1.13.20 

func (x *GrpcStatusFilter) Reset()

func (*GrpcStatusFilter) String added in v1.13.20 

func (x *GrpcStatusFilter) String() string

type GrpcStatusFilter_Status added in v1.13.20 

type GrpcStatusFilter_Status int32
const (
	GrpcStatusFilter_OK                  GrpcStatusFilter_Status = 0
	GrpcStatusFilter_CANCELED            GrpcStatusFilter_Status = 1
	GrpcStatusFilter_UNKNOWN             GrpcStatusFilter_Status = 2
	GrpcStatusFilter_INVALID_ARGUMENT    GrpcStatusFilter_Status = 3
	GrpcStatusFilter_DEADLINE_EXCEEDED   GrpcStatusFilter_Status = 4
	GrpcStatusFilter_NOT_FOUND           GrpcStatusFilter_Status = 5
	GrpcStatusFilter_ALREADY_EXISTS      GrpcStatusFilter_Status = 6
	GrpcStatusFilter_PERMISSION_DENIED   GrpcStatusFilter_Status = 7
	GrpcStatusFilter_RESOURCE_EXHAUSTED  GrpcStatusFilter_Status = 8
	GrpcStatusFilter_FAILED_PRECONDITION GrpcStatusFilter_Status = 9
	GrpcStatusFilter_ABORTED             GrpcStatusFilter_Status = 10
	GrpcStatusFilter_OUT_OF_RANGE        GrpcStatusFilter_Status = 11
	GrpcStatusFilter_UNIMPLEMENTED       GrpcStatusFilter_Status = 12
	GrpcStatusFilter_INTERNAL            GrpcStatusFilter_Status = 13
	GrpcStatusFilter_UNAVAILABLE         GrpcStatusFilter_Status = 14
	GrpcStatusFilter_DATA_LOSS           GrpcStatusFilter_Status = 15
	GrpcStatusFilter_UNAUTHENTICATED     GrpcStatusFilter_Status = 16
)

func (GrpcStatusFilter_Status) Descriptor added in v1.13.20 

func (GrpcStatusFilter_Status) Descriptor() protoreflect.EnumDescriptor

func (GrpcStatusFilter_Status) Enum added in v1.13.20 

func (x GrpcStatusFilter_Status) Enum() *GrpcStatusFilter_Status

func (GrpcStatusFilter_Status) EnumDescriptor deprecated added in v1.13.20 

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

Deprecated: Use GrpcStatusFilter_Status.Descriptor instead.

func (GrpcStatusFilter_Status) Number added in v1.13.20 

func (x GrpcStatusFilter_Status) Number() protoreflect.EnumNumber

func (GrpcStatusFilter_Status) String added in v1.13.20 

func (x GrpcStatusFilter_Status) String() string

func (GrpcStatusFilter_Status) Type added in v1.13.20 

func (GrpcStatusFilter_Status) Type() protoreflect.EnumType

type HeaderFilter added in v1.13.20 

type HeaderFilter struct {

	// Only requests with a header which matches the specified HeaderMatcher will
	// pass the filter check.
	Header *v32.HeaderMatcher `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// contains filtered or unexported fields
}

Filters requests based on the presence or value of a request header.

func (*HeaderFilter) Clone added in v1.13.20 

func (m *HeaderFilter) Clone() proto.Message

Clone function

func (*HeaderFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use HeaderFilter.ProtoReflect.Descriptor instead.

func (*HeaderFilter) Equal added in v1.13.20 

func (m *HeaderFilter) Equal(that interface{}) bool

Equal function

func (*HeaderFilter) GetHeader added in v1.13.20 

func (x *HeaderFilter) GetHeader() *v32.HeaderMatcher

func (*HeaderFilter) Hash deprecated added in v1.13.20 

func (m *HeaderFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*HeaderFilter) HashUnique 

func (m *HeaderFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*HeaderFilter) ProtoMessage added in v1.13.20 

func (*HeaderFilter) ProtoMessage()

func (*HeaderFilter) ProtoReflect added in v1.13.20 

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

func (*HeaderFilter) Reset added in v1.13.20 

func (x *HeaderFilter) Reset()

func (*HeaderFilter) String added in v1.13.20 

func (x *HeaderFilter) String() string

type NotHealthCheckFilter added in v1.13.20 

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

Filters for requests that are not health check requests. A health check request is marked by the health check filter.

func (*NotHealthCheckFilter) Clone added in v1.13.20 

func (m *NotHealthCheckFilter) Clone() proto.Message

Clone function

func (*NotHealthCheckFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use NotHealthCheckFilter.ProtoReflect.Descriptor instead.

func (*NotHealthCheckFilter) Equal added in v1.13.20 

func (m *NotHealthCheckFilter) Equal(that interface{}) bool

Equal function

func (*NotHealthCheckFilter) Hash deprecated added in v1.13.20 

func (m *NotHealthCheckFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*NotHealthCheckFilter) HashUnique 

func (m *NotHealthCheckFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*NotHealthCheckFilter) ProtoMessage added in v1.13.20 

func (*NotHealthCheckFilter) ProtoMessage()

func (*NotHealthCheckFilter) ProtoReflect added in v1.13.20 

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

func (*NotHealthCheckFilter) Reset added in v1.13.20 

func (x *NotHealthCheckFilter) Reset()

func (*NotHealthCheckFilter) String added in v1.13.20 

func (x *NotHealthCheckFilter) String() string

type OrFilter added in v1.13.20 

type OrFilter struct {
	Filters []*AccessLogFilter `protobuf:"bytes,2,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

Performs a logical “or” operation on the result of each individual filter. Filters are evaluated sequentially and if one of them returns true, the filter returns true immediately.

func (*OrFilter) Clone added in v1.13.20 

func (m *OrFilter) Clone() proto.Message

Clone function

func (*OrFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use OrFilter.ProtoReflect.Descriptor instead.

func (*OrFilter) Equal added in v1.13.20 

func (m *OrFilter) Equal(that interface{}) bool

Equal function

func (*OrFilter) GetFilters added in v1.13.20 

func (x *OrFilter) GetFilters() []*AccessLogFilter

func (*OrFilter) Hash deprecated added in v1.13.20 

func (m *OrFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*OrFilter) HashUnique 

func (m *OrFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*OrFilter) ProtoMessage added in v1.13.20 

func (*OrFilter) ProtoMessage()

func (*OrFilter) ProtoReflect added in v1.13.20 

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

func (*OrFilter) Reset added in v1.13.20 

func (x *OrFilter) Reset()

func (*OrFilter) String added in v1.13.20 

func (x *OrFilter) String() string

type ResponseFlagFilter added in v1.13.20 

type ResponseFlagFilter struct {

	// Only responses with the any of the flags listed in this field will be
	// logged. This field is optional. If it is not specified, then any response
	// flag will pass the filter check.
	Flags []string `protobuf:"bytes,1,rep,name=flags,proto3" json:"flags,omitempty"`
	// contains filtered or unexported fields
}

Filters requests that received responses with an Envoy response flag set. A list of the response flags can be found in the access log formatter :ref:`documentation<config_access_log_format_response_flags>`.

func (*ResponseFlagFilter) Clone added in v1.13.20 

func (m *ResponseFlagFilter) Clone() proto.Message

Clone function

func (*ResponseFlagFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use ResponseFlagFilter.ProtoReflect.Descriptor instead.

func (*ResponseFlagFilter) Equal added in v1.13.20 

func (m *ResponseFlagFilter) Equal(that interface{}) bool

Equal function

func (*ResponseFlagFilter) GetFlags added in v1.13.20 

func (x *ResponseFlagFilter) GetFlags() []string

func (*ResponseFlagFilter) Hash deprecated added in v1.13.20 

func (m *ResponseFlagFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*ResponseFlagFilter) HashUnique 

func (m *ResponseFlagFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*ResponseFlagFilter) ProtoMessage added in v1.13.20 

func (*ResponseFlagFilter) ProtoMessage()

func (*ResponseFlagFilter) ProtoReflect added in v1.13.20 

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

func (*ResponseFlagFilter) Reset added in v1.13.20 

func (x *ResponseFlagFilter) Reset()

func (*ResponseFlagFilter) String added in v1.13.20 

func (x *ResponseFlagFilter) String() string

type RuntimeFilter added in v1.13.20 

type RuntimeFilter struct {

	// Runtime key to get an optional overridden numerator for use in the
	// `percent_sampled` field. If found in runtime, this value will replace the
	// default numerator.
	RuntimeKey string `protobuf:"bytes,1,opt,name=runtime_key,json=runtimeKey,proto3" json:"runtime_key,omitempty"`
	// The default sampling percentage. If not specified, defaults to 0% with
	// denominator of 100.
	PercentSampled *v31.FractionalPercent `protobuf:"bytes,2,opt,name=percent_sampled,json=percentSampled,proto3" json:"percent_sampled,omitempty"`
	// By default, sampling pivots on the header
	// :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being
	// present. If :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`
	// is present, the filter will consistently sample across multiple hosts based
	// on the runtime key value and the value extracted from
	// :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`. If it is
	// missing, or `use_independent_randomness` is set to true, the filter will
	// randomly sample based on the runtime key value alone.
	// `use_independent_randomness` can be used for logging kill switches within
	// complex nested :ref:`AndFilter
	// <envoy_v3_api_msg_config.accesslog.v3.AndFilter>` and :ref:`OrFilter
	// <envoy_v3_api_msg_config.accesslog.v3.OrFilter>` blocks that are easier to
	// reason about from a probability perspective (i.e., setting to true will
	// cause the filter to behave like an independent random variable when
	// composed within logical operator filters).
	UseIndependentRandomness bool `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

Filters for random sampling of requests.

func (*RuntimeFilter) Clone added in v1.13.20 

func (m *RuntimeFilter) Clone() proto.Message

Clone function

func (*RuntimeFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use RuntimeFilter.ProtoReflect.Descriptor instead.

func (*RuntimeFilter) Equal added in v1.13.20 

func (m *RuntimeFilter) Equal(that interface{}) bool

Equal function

func (*RuntimeFilter) GetPercentSampled added in v1.13.20 

func (x *RuntimeFilter) GetPercentSampled() *v31.FractionalPercent

func (*RuntimeFilter) GetRuntimeKey added in v1.13.20 

func (x *RuntimeFilter) GetRuntimeKey() string

func (*RuntimeFilter) GetUseIndependentRandomness added in v1.13.20 

func (x *RuntimeFilter) GetUseIndependentRandomness() bool

func (*RuntimeFilter) Hash deprecated added in v1.13.20 

func (m *RuntimeFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*RuntimeFilter) HashUnique 

func (m *RuntimeFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*RuntimeFilter) ProtoMessage added in v1.13.20 

func (*RuntimeFilter) ProtoMessage()

func (*RuntimeFilter) ProtoReflect added in v1.13.20 

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

func (*RuntimeFilter) Reset added in v1.13.20 

func (x *RuntimeFilter) Reset()

func (*RuntimeFilter) String added in v1.13.20 

func (x *RuntimeFilter) String() string

type StatusCodeFilter added in v1.13.20 

type StatusCodeFilter struct {

	// Comparison.
	Comparison *ComparisonFilter `protobuf:"bytes,1,opt,name=comparison,proto3" json:"comparison,omitempty"`
	// contains filtered or unexported fields
}

Filters on HTTP response/status code.

func (*StatusCodeFilter) Clone added in v1.13.20 

func (m *StatusCodeFilter) Clone() proto.Message

Clone function

func (*StatusCodeFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use StatusCodeFilter.ProtoReflect.Descriptor instead.

func (*StatusCodeFilter) Equal added in v1.13.20 

func (m *StatusCodeFilter) Equal(that interface{}) bool

Equal function

func (*StatusCodeFilter) GetComparison added in v1.13.20 

func (x *StatusCodeFilter) GetComparison() *ComparisonFilter

func (*StatusCodeFilter) Hash deprecated added in v1.13.20 

func (m *StatusCodeFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*StatusCodeFilter) HashUnique 

func (m *StatusCodeFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*StatusCodeFilter) ProtoMessage added in v1.13.20 

func (*StatusCodeFilter) ProtoMessage()

func (*StatusCodeFilter) ProtoReflect added in v1.13.20 

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

func (*StatusCodeFilter) Reset added in v1.13.20 

func (x *StatusCodeFilter) Reset()

func (*StatusCodeFilter) String added in v1.13.20 

func (x *StatusCodeFilter) String() string

type TraceableFilter added in v1.13.20 

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

Filters for requests that are traceable. See the tracing overview for more information on how a request becomes traceable.

func (*TraceableFilter) Clone added in v1.13.20 

func (m *TraceableFilter) Clone() proto.Message

Clone function

func (*TraceableFilter) Descriptor deprecated added in v1.13.20 

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

Deprecated: Use TraceableFilter.ProtoReflect.Descriptor instead.

func (*TraceableFilter) Equal added in v1.13.20 

func (m *TraceableFilter) Equal(that interface{}) bool

Equal function

func (*TraceableFilter) Hash deprecated added in v1.13.20 

func (m *TraceableFilter) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*TraceableFilter) HashUnique 

func (m *TraceableFilter) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*TraceableFilter) ProtoMessage added in v1.13.20 

func (*TraceableFilter) ProtoMessage()

func (*TraceableFilter) ProtoReflect added in v1.13.20 

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

func (*TraceableFilter) Reset added in v1.13.20 

func (x *TraceableFilter) Reset()

func (*TraceableFilter) String added in v1.13.20 

func (x *TraceableFilter) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.