observability

Documentation

Overview

Package observability provides a metrics extension for CtrlPlane that records lifecycle event counts via go-utils MetricFactory.

Index

• type MetricsExtension
  • func NewMetricsExtension() *MetricsExtension
  • func NewMetricsExtensionWithFactory(factory gu.MetricFactory) *MetricsExtension
  • func (m *MetricsExtension) Name() string
  • func (m *MetricsExtension) OnCertExpiring(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnCertProvisioned(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnDeployFailed(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnDeployRolledBack(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnDeployStarted(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnDeploySucceeded(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnDomainAdded(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnDomainRemoved(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnDomainVerified(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnHealthCheckFailed(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnHealthCheckPassed(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnHealthDegraded(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnHealthRecovered(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnInstanceCreated(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnInstanceDeleted(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnInstanceFailed(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnInstanceScaled(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnInstanceStarted(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnInstanceStopped(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnInstanceSuspended(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnInstanceUnsuspended(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnQuotaExceeded(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnTenantCreated(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnTenantDeleted(_ context.Context, _ *event.Event) error
  • func (m *MetricsExtension) OnTenantSuspended(_ context.Context, _ *event.Event) error

Types

type MetricsExtension

type MetricsExtension struct {
	// Instance counters.
	InstanceCreatedCount     gu.Counter
	InstanceStartedCount     gu.Counter
	InstanceStoppedCount     gu.Counter
	InstanceFailedCount      gu.Counter
	InstanceDeletedCount     gu.Counter
	InstanceScaledCount      gu.Counter
	InstanceSuspendedCount   gu.Counter
	InstanceUnsuspendedCount gu.Counter

	// Deploy counters.
	DeployStartedCount    gu.Counter
	DeploySucceededCount  gu.Counter
	DeployFailedCount     gu.Counter
	DeployRolledBackCount gu.Counter

	// Health counters.
	HealthCheckPassedCount gu.Counter
	HealthCheckFailedCount gu.Counter
	HealthDegradedCount    gu.Counter
	HealthRecoveredCount   gu.Counter

	// Network counters.
	DomainAddedCount     gu.Counter
	DomainVerifiedCount  gu.Counter
	DomainRemovedCount   gu.Counter
	CertProvisionedCount gu.Counter
	CertExpiringCount    gu.Counter

	// Admin counters.
	TenantCreatedCount   gu.Counter
	TenantSuspendedCount gu.Counter
	TenantDeletedCount   gu.Counter
	QuotaExceededCount   gu.Counter
}

MetricsExtension records lifecycle metrics via go-utils MetricFactory.

func NewMetricsExtension

func NewMetricsExtension() *MetricsExtension

NewMetricsExtension creates a MetricsExtension with a default metrics collector.

func NewMetricsExtensionWithFactory

func NewMetricsExtensionWithFactory(factory gu.MetricFactory) *MetricsExtension

NewMetricsExtensionWithFactory creates a MetricsExtension with the provided MetricFactory.

func (*MetricsExtension) Name

func (m *MetricsExtension) Name() string

Name implements plugin.Extension.

func (*MetricsExtension) OnCertExpiring

func (m *MetricsExtension) OnCertExpiring(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnCertProvisioned

func (m *MetricsExtension) OnCertProvisioned(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnDeployFailed

func (m *MetricsExtension) OnDeployFailed(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnDeployRolledBack

func (m *MetricsExtension) OnDeployRolledBack(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnDeployStarted

func (m *MetricsExtension) OnDeployStarted(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnDeploySucceeded

func (m *MetricsExtension) OnDeploySucceeded(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnDomainAdded

func (m *MetricsExtension) OnDomainAdded(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnDomainRemoved

func (m *MetricsExtension) OnDomainRemoved(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnDomainVerified

func (m *MetricsExtension) OnDomainVerified(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnHealthCheckFailed

func (m *MetricsExtension) OnHealthCheckFailed(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnHealthCheckPassed

func (m *MetricsExtension) OnHealthCheckPassed(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnHealthDegraded

func (m *MetricsExtension) OnHealthDegraded(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnHealthRecovered

func (m *MetricsExtension) OnHealthRecovered(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnInstanceCreated

func (m *MetricsExtension) OnInstanceCreated(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnInstanceDeleted

func (m *MetricsExtension) OnInstanceDeleted(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnInstanceFailed

func (m *MetricsExtension) OnInstanceFailed(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnInstanceScaled

func (m *MetricsExtension) OnInstanceScaled(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnInstanceStarted

func (m *MetricsExtension) OnInstanceStarted(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnInstanceStopped

func (m *MetricsExtension) OnInstanceStopped(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnInstanceSuspended

func (m *MetricsExtension) OnInstanceSuspended(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnInstanceUnsuspended

func (m *MetricsExtension) OnInstanceUnsuspended(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnQuotaExceeded

func (m *MetricsExtension) OnQuotaExceeded(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnTenantCreated

func (m *MetricsExtension) OnTenantCreated(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnTenantDeleted

func (m *MetricsExtension) OnTenantDeleted(_ context.Context, _ *event.Event) error

func (*MetricsExtension) OnTenantSuspended

func (m *MetricsExtension) OnTenantSuspended(_ context.Context, _ *event.Event) error