v1alpha1

package
v1.20.6 Latest Latest
Warning

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

 Go to latest Published: Apr 4, 2024 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	PluginConfig_AccessLogging_name = map[int32]string{
		0: "NONE",
		1: "FULL",
		2: "ERRORS_ONLY",
	}
	PluginConfig_AccessLogging_value = map[string]int32{
		"NONE":        0,
		"FULL":        1,
		"ERRORS_ONLY": 2,
	}
)

Enum value maps for PluginConfig_AccessLogging.

View Source 
var File_envoy_extensions_stackdriver_config_v1alpha1_config_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CustomConfig 

type CustomConfig struct {

	// (Optional) Collection of tag names and tag expressions to include in the
	// instance. Conflicts are resolved by the tag name by overriding previously
	// supplied values.
	Dimensions map[string]string `` /* 161-byte string literal not displayed */
	// (Optional) A list of tags to remove.
	// Not implemented yet.
	// $hide_from_docs
	TagsToRemove []string `protobuf:"bytes,2,rep,name=tags_to_remove,json=tagsToRemove,proto3" json:"tags_to_remove,omitempty"`
	// contains filtered or unexported fields
}

Custom instance configuration overrides. Provides a way to customize logs.

func (*CustomConfig) Descriptor deprecated 

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

Deprecated: Use CustomConfig.ProtoReflect.Descriptor instead.

func (*CustomConfig) GetDimensions 

func (x *CustomConfig) GetDimensions() map[string]string

func (*CustomConfig) GetTagsToRemove 

func (x *CustomConfig) GetTagsToRemove() []string

func (*CustomConfig) ProtoMessage 

func (*CustomConfig) ProtoMessage()

func (*CustomConfig) ProtoReflect 

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

func (*CustomConfig) Reset 

func (x *CustomConfig) Reset()

func (*CustomConfig) String 

func (x *CustomConfig) String() string

type MetricsOverride 

type MetricsOverride struct {

	// Optional. If true, no data for the associated metric will be collected or
	// exported.
	Drop bool `protobuf:"varint,1,opt,name=drop,proto3" json:"drop,omitempty"`
	// Optional. Maps tag names to value expressions that will be used at
	// reporting time. If the tag name does not match a well-known tag for the
	// istio Cloud Monitoring metrics, the configuration will have no effect.
	TagOverrides map[string]string `` /* 185-byte string literal not displayed */
	// contains filtered or unexported fields
}

Provides behavior modifications for Cloud Monitoring metrics.

func (*MetricsOverride) Descriptor deprecated 

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

Deprecated: Use MetricsOverride.ProtoReflect.Descriptor instead.

func (*MetricsOverride) GetDrop 

func (x *MetricsOverride) GetDrop() bool

func (*MetricsOverride) GetTagOverrides 

func (x *MetricsOverride) GetTagOverrides() map[string]string

func (*MetricsOverride) ProtoMessage 

func (*MetricsOverride) ProtoMessage()

func (*MetricsOverride) ProtoReflect 

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

func (*MetricsOverride) Reset 

func (x *MetricsOverride) Reset()

func (*MetricsOverride) String 

func (x *MetricsOverride) String() string

type PluginConfig 

type PluginConfig struct {

	// Optional. Controls whether to export server access log.
	// This is deprecated in favor of AccessLogging enum.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/stackdriver/config/v1alpha1/config.proto.
	DisableServerAccessLogging bool `` /* 144-byte string literal not displayed */
	// Optional. Allows configuration of the size of the LogWrite request. The
	// size is in bytes, so that it allows for better performance. Default is 4MB.
	// The size of one log entry within LogWrite request is approx 1Kb.
	MaxLogBatchSizeInBytes int32 `` /* 137-byte string literal not displayed */
	// Optional. Allows configuration of the time between calls out to the
	// stackdriver logging service to report buffered LogWrite request.
	// Customers can choose to report more aggressively by keeping shorter report
	// interval if needed. Default is 10s.
	LogReportDuration *duration.Duration `protobuf:"bytes,13,opt,name=log_report_duration,json=logReportDuration,proto3" json:"log_report_duration,omitempty"`
	// Optional. Controls whether to export audit log.
	EnableAuditLog bool `protobuf:"varint,11,opt,name=enable_audit_log,json=enableAuditLog,proto3" json:"enable_audit_log,omitempty"`
	// Optional. FQDN of destination service that the request routed to, e.g.
	// productpage.default.svc.cluster.local. If not provided, request host header
	// will be used instead
	DestinationServiceName string `` /* 129-byte string literal not displayed */
	// Optional. Controls whether or not to export mesh edges to a mesh edges
	// service. This is disabled by default.
	// Deprecated -- Mesh edge reporting is no longer supported and this setting
	// is no-op.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/stackdriver/config/v1alpha1/config.proto.
	EnableMeshEdgesReporting bool `` /* 138-byte string literal not displayed */
	// Optional. Allows configuration of the time between calls out to the mesh
	// edges service to report *NEW* edges. The minimum configurable duration is
	// `10s`. NOTE: This option ONLY configures the intermediate reporting of
	// novel edges. Once every `10m`, all edges observed in that 10m window are
	// reported and the local cache is cleared.
	// The default duration is `1m`. Any value greater than `10m` will result in
	// reporting every `10m`.
	// Deprecated -- Mesh edge reporting is no longer supported and this setting
	// is no-op.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/stackdriver/config/v1alpha1/config.proto.
	MeshEdgesReportingDuration *duration.Duration `` /* 143-byte string literal not displayed */
	// maximum size of the peer metadata cache.
	// A long lived proxy that connects with many transient peers can build up a
	// large cache. To turn off the cache, set this field to a negative value.
	MaxPeerCacheSize int32 `protobuf:"varint,5,opt,name=max_peer_cache_size,json=maxPeerCacheSize,proto3" json:"max_peer_cache_size,omitempty"`
	// Optional: Disable using host header as a fallback if destination service is
	// not available from the controlplane. Disable the fallback if the host
	// header originates outsides the mesh, like at ingress.
	DisableHostHeaderFallback bool `` /* 141-byte string literal not displayed */
	// Optional. Allows configuration of the number of traffic assertions to batch
	// into a single request. Default is 100. Max is 1000.
	MaxEdgesBatchSize int32 `protobuf:"varint,7,opt,name=max_edges_batch_size,json=maxEdgesBatchSize,proto3" json:"max_edges_batch_size,omitempty"`
	// Optional. Allows disabling of reporting of the request and response size
	// metrics for HTTP traffic. Defaults to false (request and response size
	// metrics are enabled).
	// Deprecated -- use `metrics_overrides` instead.
	// if `metrics_overrides` is used, this value will be ignored.
	//
	// Deprecated: Marked as deprecated in envoy/extensions/stackdriver/config/v1alpha1/config.proto.
	DisableHttpSizeMetrics bool `` /* 132-byte string literal not displayed */
	// Optional. Allows enabling log compression for stackdriver access logs.
	EnableLogCompression *wrappers.BoolValue `protobuf:"bytes,9,opt,name=enable_log_compression,json=enableLogCompression,proto3" json:"enable_log_compression,omitempty"`
	// Optional. Controls what type of logs to export..
	AccessLogging PluginConfig_AccessLogging `` /* 162-byte string literal not displayed */
	// CEL expression for filtering access logging. If the expression evaluates
	// to true, an access log entry will be generated. Otherwise, no access log
	// entry will be generated. If there are any type errors, the CEL expression
	// is evaluated as false. More details on type checking can be found
	// at https://kubernetes.io/docs/reference/using-api/cel/#type-checking.
	// A common error is referring to a non-existent field in the log entry.
	// It's crucial to note that in Envoy, the fields that appear in access log
	// entries can vary. This variation is influenced by several factors,
	// including the protocol in use (such as HTTP or TCP), the applied filters,
	// and the specific configuration of the Envoy instance. Therefore, when
	// using CEL expressions for filtering access logs, it's essential to ensure
	// that the expressions accurately refer to existing fields in the log entry.
	// The has() macro in CEL may be used in CEL expressions to check if a field
	// is accessible before attempting to access the field's value.
	// You can also quickly test CEL expressions at the CEL Playground
	// at https://playcel.undistro.io/.
	// NOTE: Audit logs ignore configured filters.
	AccessLoggingFilterExpression string `` /* 153-byte string literal not displayed */
	// (Optional) Collection of tag names and tag expressions to include in the
	// logs. Conflicts are resolved by the tag name by overriding previously
	// supplied values. Does not apply to audit logs.
	// See
	// https://istio.io/latest/docs/tasks/observability/metrics/customize-metrics/#use-expressions-for-values
	// for more details about the expression language.
	CustomLogConfig *CustomConfig `protobuf:"bytes,14,opt,name=custom_log_config,json=customLogConfig,proto3" json:"custom_log_config,omitempty"`
	// Optional. Controls the metric expiry duration. If a metric time series is
	// not updated for the given duration, it will be purged from time series
	// cache as well as metric reporting. If this is not set or set to 0, time
	// series will never be expired. This option is useful to avoid unbounded
	// metric label explodes proxy memory.
	MetricExpiryDuration *duration.Duration `protobuf:"bytes,15,opt,name=metric_expiry_duration,json=metricExpiryDuration,proto3" json:"metric_expiry_duration,omitempty"`
	// Optional. Allows altering metrics behavior.
	// Metric names for specifying overloads drop the `istio.io/service` prefix.
	// Examples: `server/request_count`, `client/roundtrip_latencies`
	MetricsOverrides map[string]*MetricsOverride `` /* 198-byte string literal not displayed */
	// contains filtered or unexported fields
}

next id: 17

func (*PluginConfig) Descriptor deprecated 

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

Deprecated: Use PluginConfig.ProtoReflect.Descriptor instead.

func (*PluginConfig) GetAccessLogging 

func (x *PluginConfig) GetAccessLogging() PluginConfig_AccessLogging

func (*PluginConfig) GetAccessLoggingFilterExpression 

func (x *PluginConfig) GetAccessLoggingFilterExpression() string

func (*PluginConfig) GetCustomLogConfig 

func (x *PluginConfig) GetCustomLogConfig() *CustomConfig

func (*PluginConfig) GetDestinationServiceName 

func (x *PluginConfig) GetDestinationServiceName() string

func (*PluginConfig) GetDisableHostHeaderFallback 

func (x *PluginConfig) GetDisableHostHeaderFallback() bool

func (*PluginConfig) GetDisableHttpSizeMetrics deprecated 

func (x *PluginConfig) GetDisableHttpSizeMetrics() bool

Deprecated: Marked as deprecated in envoy/extensions/stackdriver/config/v1alpha1/config.proto.

func (*PluginConfig) GetDisableServerAccessLogging deprecated 

func (x *PluginConfig) GetDisableServerAccessLogging() bool

Deprecated: Marked as deprecated in envoy/extensions/stackdriver/config/v1alpha1/config.proto.

func (*PluginConfig) GetEnableAuditLog 

func (x *PluginConfig) GetEnableAuditLog() bool

func (*PluginConfig) GetEnableLogCompression 

func (x *PluginConfig) GetEnableLogCompression() *wrappers.BoolValue

func (*PluginConfig) GetEnableMeshEdgesReporting deprecated 

func (x *PluginConfig) GetEnableMeshEdgesReporting() bool

Deprecated: Marked as deprecated in envoy/extensions/stackdriver/config/v1alpha1/config.proto.

func (*PluginConfig) GetLogReportDuration 

func (x *PluginConfig) GetLogReportDuration() *duration.Duration

func (*PluginConfig) GetMaxEdgesBatchSize 

func (x *PluginConfig) GetMaxEdgesBatchSize() int32

func (*PluginConfig) GetMaxLogBatchSizeInBytes 

func (x *PluginConfig) GetMaxLogBatchSizeInBytes() int32

func (*PluginConfig) GetMaxPeerCacheSize 

func (x *PluginConfig) GetMaxPeerCacheSize() int32

func (*PluginConfig) GetMeshEdgesReportingDuration deprecated 

func (x *PluginConfig) GetMeshEdgesReportingDuration() *duration.Duration

Deprecated: Marked as deprecated in envoy/extensions/stackdriver/config/v1alpha1/config.proto.

func (*PluginConfig) GetMetricExpiryDuration 

func (x *PluginConfig) GetMetricExpiryDuration() *duration.Duration

func (*PluginConfig) GetMetricsOverrides 

func (x *PluginConfig) GetMetricsOverrides() map[string]*MetricsOverride

func (*PluginConfig) ProtoMessage 

func (*PluginConfig) ProtoMessage()

func (*PluginConfig) ProtoReflect 

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

func (*PluginConfig) Reset 

func (x *PluginConfig) Reset()

func (*PluginConfig) String 

func (x *PluginConfig) String() string

type PluginConfig_AccessLogging 

type PluginConfig_AccessLogging int32

Types of Access logs to export. Does not affect audit logging. 

const (
	// No Logs.
	PluginConfig_NONE PluginConfig_AccessLogging = 0
	// All logs including both success and error logs.
	PluginConfig_FULL PluginConfig_AccessLogging = 1
	// All error logs. This is currently only available for outbound/client side
	// logs. A request is classified as error when `status>=400 or
	// response_flag != "-"`
	PluginConfig_ERRORS_ONLY PluginConfig_AccessLogging = 2
)

func (PluginConfig_AccessLogging) Descriptor 

func (PluginConfig_AccessLogging) Descriptor() protoreflect.EnumDescriptor

func (PluginConfig_AccessLogging) Enum 

func (x PluginConfig_AccessLogging) Enum() *PluginConfig_AccessLogging

func (PluginConfig_AccessLogging) EnumDescriptor deprecated 

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

Deprecated: Use PluginConfig_AccessLogging.Descriptor instead.

func (PluginConfig_AccessLogging) Number 

func (x PluginConfig_AccessLogging) Number() protoreflect.EnumNumber

func (PluginConfig_AccessLogging) String 

func (x PluginConfig_AccessLogging) String() string

func (PluginConfig_AccessLogging) Type 

func (PluginConfig_AccessLogging) Type() protoreflect.EnumType

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.