metrics

Documentation

Overview

Package metrics contains global structures related to metrics collection cert-manager exposes the following metrics: certificate_expiration_timestamp_seconds{name, namespace} certificate_ready_status{name, namespace, condition}

Index

• Variables
• type Metrics
  • func New(ctx context.Context) *Metrics
  • func (m *Metrics) IncrementSyncCallCount(controllerName string)
  • func (m *Metrics) SetActiveCertificates(cl cmlisters.CertificateLister)
  • func (m *Metrics) Start(stopCh <-chan struct{})
  • func (m *Metrics) UpdateCertificateExpiry(crt *v1alpha1.Certificate, secretLister corelisters.SecretLister)
  • func (m *Metrics) UpdateCertificateStatus(crt *v1alpha1.Certificate)

Variables

var ACMEClientRequestCount = prometheus.NewCounterVec(
	prometheus.CounterOpts{
		Namespace: namespace,
		Name:      "acme_client_request_count",
		Help:      "The number of requests made by the ACME client.",
		Subsystem: "http",
	},
	[]string{"scheme", "host", "path", "method", "status"},
)

ACMEClientRequestCount is a Prometheus summary to collect the number of requests made to each endpoint with the ACME client.

var ACMEClientRequestDurationSeconds = prometheus.NewSummaryVec(
	prometheus.SummaryOpts{
		Namespace:  namespace,
		Name:       "acme_client_request_duration_seconds",
		Help:       "The HTTP request latencies in seconds for the ACME client.",
		Subsystem:  "http",
		Objectives: map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001},
	},
	[]string{"scheme", "host", "path", "method", "status"},
)

ACMEClientRequestDurationSeconds is a Prometheus summary to collect request times for the ACME client.

var CertificateExpiryTimeSeconds = prometheus.NewGaugeVec(
	prometheus.GaugeOpts{
		Namespace: namespace,
		Name:      "certificate_expiration_timestamp_seconds",
		Help:      "The date after which the certificate expires. Expressed as a Unix Epoch Time.",
	},
	[]string{"name", "namespace"},
)

var CertificateReadyStatus = prometheus.NewGaugeVec(
	prometheus.GaugeOpts{
		Namespace: namespace,
		Name:      "certificate_ready_status",
		Help:      "The ready status of the certificate.",
	},
	[]string{"name", "namespace", "condition"},
)

var ControllerSyncCallCount = prometheus.NewCounterVec(
	prometheus.CounterOpts{
		Namespace: namespace,
		Name:      "controller_sync_call_count",
		Help:      "The number of sync() calls made by a controller.",
	},
	[]string{"controller"},
)

var Default = New(logf.NewContext(context.Background(), logf.Log.WithName("metrics")))

Default set of metrics

Types

type Metrics

type Metrics struct {
	http.Server

	CertificateExpiryTimeSeconds     *prometheus.GaugeVec
	CertificateReadyStatus           *prometheus.GaugeVec
	ACMEClientRequestDurationSeconds *prometheus.SummaryVec
	ACMEClientRequestCount           *prometheus.CounterVec
	ControllerSyncCallCount          *prometheus.CounterVec
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context) *Metrics

func (*Metrics) IncrementSyncCallCount

func (m *Metrics) IncrementSyncCallCount(controllerName string)

func (*Metrics) SetActiveCertificates

func (m *Metrics) SetActiveCertificates(cl cmlisters.CertificateLister)

func (*Metrics) Start

func (m *Metrics) Start(stopCh <-chan struct{})

func (*Metrics) UpdateCertificateExpiry

func (m *Metrics) UpdateCertificateExpiry(crt *v1alpha1.Certificate, secretLister corelisters.SecretLister)

UpdateCertificateExpiry updates the expiry time of a certificate

func (*Metrics) UpdateCertificateStatus

func (m *Metrics) UpdateCertificateStatus(crt *v1alpha1.Certificate)