metrics

Documentation

Index

• type ResourcesMetricsCollector
  • func (c ResourcesMetricsCollector) Collect(metrics chan<- prometheus.Metric)
  • func (c ResourcesMetricsCollector) Describe(descs chan<- *prometheus.Desc)
  • func (c ResourcesMetricsCollector) NeedLeaderElection() bool
  • func (c *ResourcesMetricsCollector) SetupWithManager(mgr ctrl.Manager) error
  • func (c ResourcesMetricsCollector) Start(ctx context.Context) error

Types

type ResourcesMetricsCollector

type ResourcesMetricsCollector struct {
	logr.Logger
	etc.Config
	client.Client
}

ResourcesMetricsCollector is a custom Prometheus collector that produces metrics on-demand from the trivy-operator custom resources. Since these resources are already cached by the Kubernetes API client shared with the operator, metrics scrapes should never actually hit the API server. All resource reads are served from cache, reducing API server load without consuming additional cluster resources. An alternative (more traditional) approach would be to maintain metrics in the internal Prometheus registry on resource reconcile. The collector approach was selected in order to avoid potentially stale metrics; i.e. the controller would have to reconcile all resources at least once for the metrics to be up-to-date, which could take some time in large clusters. Also deleting metrics from registry for obsolete/deleted resources is challenging without introducing finalizers, which we want to avoid for operational reasons.

For more advanced use-cases, and/or very large clusters, this internal collector can be disabled and replaced by https://github.com/giantswarm/starboard-exporter, which collects trivy metrics from a dedicated workload supporting sharding etc.

func (ResourcesMetricsCollector) Collect

func (c ResourcesMetricsCollector) Collect(metrics chan<- prometheus.Metric)

func (ResourcesMetricsCollector) Describe

func (c ResourcesMetricsCollector) Describe(descs chan<- *prometheus.Desc)

func (ResourcesMetricsCollector) NeedLeaderElection

func (c ResourcesMetricsCollector) NeedLeaderElection() bool

func (*ResourcesMetricsCollector) SetupWithManager

func (c *ResourcesMetricsCollector) SetupWithManager(mgr ctrl.Manager) error

func (ResourcesMetricsCollector) Start

func (c ResourcesMetricsCollector) Start(ctx context.Context) error