metrics

Documentation

Index

• Constants
• Variables
• func GetPolicyInfos(policy kyvernov1.PolicyInterface) (string, string, PolicyType, PolicyBackgroundMode, PolicyValidationMode, error)
• func NewOTLPGRPCConfig(ctx context.Context, endpoint string, certs string, ...) (metric.MeterProvider, error)
• func NewPrometheusConfig(ctx context.Context, log logr.Logger) (metric.MeterProvider, *http.ServeMux, error)
• func ShutDownController(ctx context.Context, pusher *sdkmetric.MeterProvider)
• type ClientQueryOperation
• type ClientType
• type MetricsConfig
  • func NewFakeMetricsConfig() *MetricsConfig
  • func (m *MetricsConfig) Config() kconfig.MetricsConfiguration
  • func (m *MetricsConfig) RecordClientQueries(ctx context.Context, clientQueryOperation ClientQueryOperation, ...)
  • func (m *MetricsConfig) RecordPolicyChanges(ctx context.Context, policyValidationMode PolicyValidationMode, ...)
• type MetricsConfigManager
  • func InitMetrics(ctx context.Context, disableMetricsExport bool, otel string, ...) (MetricsConfigManager, *http.ServeMux, *sdkmetric.MeterProvider, error)
• type PolicyBackgroundMode
  • func ParsePolicyBackgroundMode(policy kyvernov1.PolicyInterface) PolicyBackgroundMode
• type PolicyType
• type PolicyValidationMode
  • func ParsePolicyValidationMode(validationFailureAction kyvernov1.ValidationFailureAction) (PolicyValidationMode, error)
• type Recorder
  • func ClusteredClientQueryRecorder(m MetricsConfigManager, kind string, client ClientType) Recorder
  • func NamespacedClientQueryRecorder(m MetricsConfigManager, ns, kind string, client ClientType) Recorder
• type ResourceRequestOperation
  • func ParseResourceRequestOperation(requestOperationStr string) (ResourceRequestOperation, error)
• type RuleExecutionCause
• type RuleResult
• type RuleType
  • func ParseRuleType(rule kyvernov1.Rule) RuleType
  • func ParseRuleTypeFromEngineRuleResponse(rule engineapi.RuleResponse) RuleType

Constants

const (
	MeterName = "kyverno"
)

const (
	// keys
	RequestWebhookKey = attribute.Key("request_webhook")
)

Variables

var (
	// keyvalues
	WebhookMutating   = RequestWebhookKey.String("MutatingWebhookConfiguration")
	WebhookValidating = RequestWebhookKey.String("ValidatingWebhookConfiguration")
)

Functions

func GetPolicyInfos

func GetPolicyInfos(policy kyvernov1.PolicyInterface) (string, string, PolicyType, PolicyBackgroundMode, PolicyValidationMode, error)

func NewOTLPGRPCConfig

func NewOTLPGRPCConfig(
	ctx context.Context,
	endpoint string,
	certs string,
	kubeClient kubernetes.Interface,
	log logr.Logger,
) (metric.MeterProvider, error)

func NewPrometheusConfig

func NewPrometheusConfig(
	ctx context.Context,
	log logr.Logger,
) (metric.MeterProvider, *http.ServeMux, error)

func ShutDownController

func ShutDownController(ctx context.Context, pusher *sdkmetric.MeterProvider)

Types

type ClientQueryOperation

type ClientQueryOperation string

const (
	ClientCreate           ClientQueryOperation = "create"
	ClientGet              ClientQueryOperation = "get"
	ClientList             ClientQueryOperation = "list"
	ClientUpdate           ClientQueryOperation = "update"
	ClientUpdateStatus     ClientQueryOperation = "update_status"
	ClientDelete           ClientQueryOperation = "delete"
	ClientDeleteCollection ClientQueryOperation = "delete_collection"
	ClientWatch            ClientQueryOperation = "watch"
	ClientPatch            ClientQueryOperation = "patch"
)

type ClientType

type ClientType string

const (
	DynamicClient      ClientType = "dynamic"
	KubeClient         ClientType = "kubeclient"
	KyvernoClient      ClientType = "kyverno"
	MetadataClient     ClientType = "metadata"
	ApiServerClient    ClientType = "apiserver"
	PolicyReportClient ClientType = "policyreport"
)

type MetricsConfig

type MetricsConfig struct {
	Log logr.Logger
	// contains filtered or unexported fields
}

func NewFakeMetricsConfig

func NewFakeMetricsConfig() *MetricsConfig

func (*MetricsConfig) Config

func (m *MetricsConfig) Config() kconfig.MetricsConfiguration

func (*MetricsConfig) RecordClientQueries

func (m *MetricsConfig) RecordClientQueries(ctx context.Context, clientQueryOperation ClientQueryOperation, clientType ClientType, resourceKind string, resourceNamespace string)

func (*MetricsConfig) RecordPolicyChanges

func (m *MetricsConfig) RecordPolicyChanges(ctx context.Context, policyValidationMode PolicyValidationMode, policyType PolicyType, policyBackgroundMode PolicyBackgroundMode, policyNamespace string, policyName string, policyChangeType string)

type MetricsConfigManager

type MetricsConfigManager interface {
	Config() kconfig.MetricsConfiguration
	RecordPolicyChanges(ctx context.Context, policyValidationMode PolicyValidationMode, policyType PolicyType, policyBackgroundMode PolicyBackgroundMode, policyNamespace string, policyName string, policyChangeType string)
	RecordClientQueries(ctx context.Context, clientQueryOperation ClientQueryOperation, clientType ClientType, resourceKind string, resourceNamespace string)
}

func InitMetrics

func InitMetrics(
	ctx context.Context,
	disableMetricsExport bool,
	otel string,
	metricsAddr string,
	otelCollector string,
	metricsConfiguration config.MetricsConfiguration,
	transportCreds string,
	kubeClient kubernetes.Interface,
	logger logr.Logger,
) (MetricsConfigManager, *http.ServeMux, *sdkmetric.MeterProvider, error)

type PolicyBackgroundMode

type PolicyBackgroundMode string

const (
	BackgroundTrue  PolicyBackgroundMode = "true"
	BackgroundFalse PolicyBackgroundMode = "false"
)

func ParsePolicyBackgroundMode

func ParsePolicyBackgroundMode(policy kyvernov1.PolicyInterface) PolicyBackgroundMode

type PolicyType

type PolicyType string

const (
	Cluster    PolicyType = "cluster"
	Namespaced PolicyType = "namespaced"
)

type PolicyValidationMode

type PolicyValidationMode string

const (
	Enforce PolicyValidationMode = "enforce"
	Audit   PolicyValidationMode = "audit"
)

func ParsePolicyValidationMode

func ParsePolicyValidationMode(validationFailureAction kyvernov1.ValidationFailureAction) (PolicyValidationMode, error)

type Recorder

type Recorder interface {
	Record(ClientQueryOperation)
	RecordWithContext(context.Context, ClientQueryOperation)
}

func ClusteredClientQueryRecorder

func ClusteredClientQueryRecorder(m MetricsConfigManager, kind string, client ClientType) Recorder

func NamespacedClientQueryRecorder

func NamespacedClientQueryRecorder(m MetricsConfigManager, ns, kind string, client ClientType) Recorder

type ResourceRequestOperation

type ResourceRequestOperation string

const (
	ResourceCreated   ResourceRequestOperation = "create"
	ResourceUpdated   ResourceRequestOperation = "update"
	ResourceDeleted   ResourceRequestOperation = "delete"
	ResourceConnected ResourceRequestOperation = "connect"
)

func ParseResourceRequestOperation

func ParseResourceRequestOperation(requestOperationStr string) (ResourceRequestOperation, error)

type RuleExecutionCause

type RuleExecutionCause string

const (
	AdmissionRequest RuleExecutionCause = "admission_request"
	BackgroundScan   RuleExecutionCause = "background_scan"
)

type RuleResult

type RuleResult string

const (
	Pass  RuleResult = "pass"
	Fail  RuleResult = "fail"
	Warn  RuleResult = "warn"
	Error RuleResult = "error"
	Skip  RuleResult = "skip"
)

type RuleType

type RuleType string

const (
	Validate      RuleType = "validate"
	Mutate        RuleType = "mutate"
	Generate      RuleType = "generate"
	ImageVerify   RuleType = "imageVerify"
	EmptyRuleType RuleType = "-"
)

func ParseRuleType

func ParseRuleType(rule kyvernov1.Rule) RuleType

func ParseRuleTypeFromEngineRuleResponse

func ParseRuleTypeFromEngineRuleResponse(rule engineapi.RuleResponse) RuleType