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_renewal_timestamp_seconds{name, namespace} certificate_ready_status{name, namespace, condition} acme_client_request_count{"scheme", "host", "path", "method", "status"} acme_client_request_duration_seconds{"scheme", "host", "path", "method", "status"} controller_sync_call_count{"controller"}

Package metrics contains global structures related to metrics collection cert-manager exposes the following metrics: certificate_expiration_timestamp_seconds{name, namespace} certificate_renewal_timestamp_seconds{name, namespace} certificate_ready_status{name, namespace, condition} acme_client_request_count{"scheme", "host", "path", "method", "status"} acme_client_request_duration_seconds{"scheme", "host", "path", "method", "status"} controller_sync_call_count{"controller"}

Package metrics contains global structures related to metrics collection cert-manager exposes the following metrics: certificate_expiration_timestamp_seconds{name, namespace} certificate_renewal_timestamp_seconds{name, namespace} certificate_ready_status{name, namespace, condition} acme_client_request_count{"scheme", "host", "path", "method", "status"} acme_client_request_duration_seconds{"scheme", "host", "path", "method", "status"} controller_sync_call_count{"controller"}

Index

• type Metrics
  • func New(log logr.Logger, c clock.Clock) *Metrics
  • func (m *Metrics) IncrementACMERequestCount(labels ...string)
  • func (m *Metrics) IncrementSyncCallCount(controllerName string)
  • func (m *Metrics) IncrementSyncErrorCount(controllerName string)
  • func (m *Metrics) NewServer(ln net.Listener) *http.Server
  • func (m *Metrics) ObserveACMERequestDuration(duration time.Duration, labels ...string)
  • func (m *Metrics) RemoveCertificate(key string)
  • func (m *Metrics) UpdateCertificate(ctx context.Context, crt *cmapi.Certificate)

Types

type Metrics

type Metrics struct {
	// contains filtered or unexported fields
}

Metrics is designed to be a shared object for updating the metrics exposed by cert-manager

func New

func New(log logr.Logger, c clock.Clock) *Metrics

New creates a Metrics struct and populates it with prometheus metric types.

func (*Metrics) IncrementACMERequestCount

func (m *Metrics) IncrementACMERequestCount(labels ...string)

IncrementACMERequestCount increases the acme client request counter.

func (*Metrics) IncrementSyncCallCount

func (m *Metrics) IncrementSyncCallCount(controllerName string)

IncrementSyncCallCount will increase the sync counter for that controller.

func (*Metrics) IncrementSyncErrorCount

func (m *Metrics) IncrementSyncErrorCount(controllerName string)

IncrementSyncErrorCount will increase count of errors during sync of that controller.

func (*Metrics) NewServer

func (m *Metrics) NewServer(ln net.Listener) *http.Server

NewServer registers Prometheus metrics and returns a new Prometheus metrics HTTP server.

func (*Metrics) ObserveACMERequestDuration

func (m *Metrics) ObserveACMERequestDuration(duration time.Duration, labels ...string)

ObserveACMERequestDuration increases bucket counters for that ACME client duration.

func (*Metrics) RemoveCertificate

func (m *Metrics) RemoveCertificate(key string)

RemoveCertificate will delete the Certificate metrics from continuing to be exposed.

func (*Metrics) UpdateCertificate

func (m *Metrics) UpdateCertificate(ctx context.Context, crt *cmapi.Certificate)

UpdateCertificate will update the given Certificate's metrics for its expiry, renewal, and status condition.