als

Documentation

Index

• Constants
• Variables
• func DetectUnusefulCmds(filterLocationType aclType, proposedLogFormats []*envoyal.AccessLog) error
• func NewPlugin() *plugin
• func ProcessAccessLogPlugins(service *als.AccessLoggingService, logCfg []*envoyal.AccessLog) ([]*envoyal.AccessLog, error)

Constants

const (
	ExtensionName = "als"
	ClusterName   = "access_log_cluster"
)

Variables

var (
	NoValueError = func(filterName string, fieldName string) error {
		return eris.Errorf("No value found for field %s of %s", fieldName, filterName)
	}
	InvalidEnumValueError = func(filterName string, fieldName string, value string) error {
		return eris.Errorf("Invalid value of %s in Enum field %s of %s", value, fieldName, filterName)
	}
	WrapInvalidEnumValueError = func(filterName string, err error) error {
		return eris.Wrap(err, fmt.Sprintf("Invalid subfilter in %s", filterName))
	}
)

var (
	Hcm          aclType = "hcm"
	HttpListener aclType = "http-listener"
	Tcp          aclType = "tcp"
	Udp          aclType = "udp"
)

Functions

func DetectUnusefulCmds

func DetectUnusefulCmds(filterLocationType aclType, proposedLogFormats []*envoyal.AccessLog) error

DetectUnusefulCmds will detect commands that are not useful in the current configuration It returns errors that may some day be bubbled up arbitrarly high. See https://github.com/envoyproxy/envoy/blob/313b6fb7cf0f806e74a2d42c93e7c1fcccce2391/docs/root/configuration/observability/access_log/usage.rst?plain=1#L114-L123

func NewPlugin

func NewPlugin() *plugin

NewPlugin creates an empty als plugin with no extra data

func ProcessAccessLogPlugins

func ProcessAccessLogPlugins(service *als.AccessLoggingService, logCfg []*envoyal.AccessLog) ([]*envoyal.AccessLog, error)

ProcessAccessLogPlugins will configure access logging for envoy, regardless of whether it will be applied to an HttpConnectionManager, http listener, TcpProxy NetworkFilter or perhaps someday a UdpProxy NetworkFilter. We have exposed plugins to allow configuration of http listeners and filters across multiple plugins. However, the TCP proxy is still configured by the TCP plugin only. To keep our access logging translation in a single place, we expose this function and the TCP plugin calls out to it.