observability

package
v1.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 20, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package observability provides the lifecycle event metrics plugin for Ctrl Plane.

MetricsExtension counts every lifecycle event the plugin registry delivers in one labelled counter, ctrlplane_lifecycle_events_total, whose event label is the event type (instance.created, deploy.failed, and so on). A Forge app scrapes it as forge_ctrlplane_lifecycle_events_total.

You rarely build it yourself: app.WithMetrics, which the ctrlplane Forge extension sets from app.Metrics(), registers one for you.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MetricsExtension 

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

MetricsExtension counts lifecycle events by type.

func NewMetricsExtension 

func NewMetricsExtension(m gu.MetricFactory) *MetricsExtension

NewMetricsExtension returns a MetricsExtension that records on m. In a Forge app pass app.Metrics(). A nil m records nothing.

func (*MetricsExtension) Name 

func (m *MetricsExtension) Name() string

Name implements plugin.Extension.

func (*MetricsExtension) OnCertExpiring 

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

OnCertExpiring counts an event.CertExpiring event.

func (*MetricsExtension) OnCertProvisioned 

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

OnCertProvisioned counts an event.CertProvisioned event.

func (*MetricsExtension) OnDeployFailed 

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

OnDeployFailed counts an event.DeployFailed event.

func (*MetricsExtension) OnDeployRolledBack 

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

OnDeployRolledBack counts an event.DeployRolledBack event.

func (*MetricsExtension) OnDeployStarted 

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

OnDeployStarted counts an event.DeployStarted event.

func (*MetricsExtension) OnDeploySucceeded 

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

OnDeploySucceeded counts an event.DeploySucceeded event.

func (*MetricsExtension) OnDomainAdded 

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

OnDomainAdded counts an event.DomainAdded event.

func (*MetricsExtension) OnDomainRemoved 

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

OnDomainRemoved counts an event.DomainRemoved event.

func (*MetricsExtension) OnDomainVerified 

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

OnDomainVerified counts an event.DomainVerified event.

func (*MetricsExtension) OnHealthCheckFailed 

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

OnHealthCheckFailed counts an event.HealthCheckFailed event.

func (*MetricsExtension) OnHealthCheckPassed 

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

OnHealthCheckPassed counts an event.HealthCheckPassed event.

func (*MetricsExtension) OnHealthDegraded 

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

OnHealthDegraded counts an event.HealthDegraded event.

func (*MetricsExtension) OnHealthRecovered 

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

OnHealthRecovered counts an event.HealthRecovered event.

func (*MetricsExtension) OnInstanceCreated 

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

OnInstanceCreated counts an event.InstanceCreated event.

func (*MetricsExtension) OnInstanceDeleted 

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

OnInstanceDeleted counts an event.InstanceDeleted event.

func (*MetricsExtension) OnInstanceFailed 

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

OnInstanceFailed counts an event.InstanceFailed event.

func (*MetricsExtension) OnInstanceScaled 

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

OnInstanceScaled counts an event.InstanceScaled event.

func (*MetricsExtension) OnInstanceStarted 

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

OnInstanceStarted counts an event.InstanceStarted event.

func (*MetricsExtension) OnInstanceStopped 

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

OnInstanceStopped counts an event.InstanceStopped event.

func (*MetricsExtension) OnInstanceSuspended 

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

OnInstanceSuspended counts an event.InstanceSuspended event.

func (*MetricsExtension) OnInstanceUnsuspended 

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

OnInstanceUnsuspended counts an event.InstanceUnsuspended event.

func (*MetricsExtension) OnQuotaExceeded 

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

OnQuotaExceeded counts an event.QuotaExceeded event.

func (*MetricsExtension) OnTemplateCreated added in v1.8.0 

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

OnTemplateCreated counts an event.TemplateCreated event.

func (*MetricsExtension) OnTemplateDeleted added in v1.8.0 

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

OnTemplateDeleted counts an event.TemplateDeleted event.

func (*MetricsExtension) OnTemplateUpdated added in v1.8.0 

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

OnTemplateUpdated counts an event.TemplateUpdated event.

func (*MetricsExtension) OnTenantCreated 

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

OnTenantCreated counts an event.TenantCreated event.

func (*MetricsExtension) OnTenantDeleted 

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

OnTenantDeleted counts an event.TenantDeleted event.

func (*MetricsExtension) OnTenantSuspended 

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

OnTenantSuspended counts an event.TenantSuspended event.

func (*MetricsExtension) OnWorkloadCreated added in v1.8.0 

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

OnWorkloadCreated counts an event.WorkloadCreated event.

func (*MetricsExtension) OnWorkloadDeleted added in v1.8.0 

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

OnWorkloadDeleted counts an event.WorkloadDeleted event.

func (*MetricsExtension) OnWorkloadDeployed added in v1.8.0 

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

OnWorkloadDeployed counts an event.WorkloadDeployed event.

func (*MetricsExtension) OnWorkloadFailed added in v1.8.0 

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

OnWorkloadFailed counts an event.WorkloadFailed event.

func (*MetricsExtension) OnWorkloadPaused added in v1.8.0 

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

OnWorkloadPaused counts an event.WorkloadPaused event.

func (*MetricsExtension) OnWorkloadRestarted added in v1.8.0 

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

OnWorkloadRestarted counts an event.WorkloadRestarted event.

func (*MetricsExtension) OnWorkloadResumed added in v1.8.0 

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

OnWorkloadResumed counts an event.WorkloadResumed event.

func (*MetricsExtension) OnWorkloadScaled added in v1.8.0 

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

OnWorkloadScaled counts an event.WorkloadScaled event.

func (*MetricsExtension) OnWorkloadUpdated added in v1.8.0 

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

OnWorkloadUpdated counts an event.WorkloadUpdated event.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.