Documentation
¶
Overview ¶
Package metrics provides a decoupled interface for collecting library metrics.
By using the Provider interface, the lifecycle library remains free of external monitoring dependencies (like Prometheus or OpenTelemetry) while still providing hook points for observability.
Consumers can implement their own Provider or use the provided LogProvider for debugging.
Index ¶
- func SetProvider(p Provider)
- type LogProvider
- func (l *LogProvider) IncHookExecuted()
- func (l *LogProvider) IncHookPanicked()
- func (l *LogProvider) IncProcessFailed()
- func (l *LogProvider) IncProcessStarted()
- func (l *LogProvider) IncSignalReceived(sig string)
- func (l *LogProvider) IncTerminalUpgrade(success bool)
- func (l *LogProvider) ObserveHookDuration(d time.Duration)
- type NoOpProvider
- func (n *NoOpProvider) IncHookExecuted()
- func (n *NoOpProvider) IncHookPanicked()
- func (n *NoOpProvider) IncProcessFailed()
- func (n *NoOpProvider) IncProcessStarted()
- func (n *NoOpProvider) IncSignalReceived(sig string)
- func (n *NoOpProvider) IncTerminalUpgrade(success bool)
- func (n *NoOpProvider) ObserveHookDuration(d time.Duration)
- type Provider
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type LogProvider ¶
type LogProvider struct{}
LogProvider is a metrics provider that logs increments at Debug level. This is useful for development and debugging without external dependencies.
func (*LogProvider) IncHookExecuted ¶
func (l *LogProvider) IncHookExecuted()
func (*LogProvider) IncHookPanicked ¶
func (l *LogProvider) IncHookPanicked()
func (*LogProvider) IncProcessFailed ¶
func (l *LogProvider) IncProcessFailed()
func (*LogProvider) IncProcessStarted ¶
func (l *LogProvider) IncProcessStarted()
func (*LogProvider) IncSignalReceived ¶
func (l *LogProvider) IncSignalReceived(sig string)
func (*LogProvider) IncTerminalUpgrade ¶
func (l *LogProvider) IncTerminalUpgrade(success bool)
func (*LogProvider) ObserveHookDuration ¶
func (l *LogProvider) ObserveHookDuration(d time.Duration)
type NoOpProvider ¶
type NoOpProvider struct{}
NoOpProvider is a metrics provider that does nothing.
func (*NoOpProvider) IncHookExecuted ¶
func (n *NoOpProvider) IncHookExecuted()
func (*NoOpProvider) IncHookPanicked ¶
func (n *NoOpProvider) IncHookPanicked()
func (*NoOpProvider) IncProcessFailed ¶
func (n *NoOpProvider) IncProcessFailed()
func (*NoOpProvider) IncProcessStarted ¶
func (n *NoOpProvider) IncProcessStarted()
func (*NoOpProvider) IncSignalReceived ¶
func (n *NoOpProvider) IncSignalReceived(sig string)
func (*NoOpProvider) IncTerminalUpgrade ¶
func (n *NoOpProvider) IncTerminalUpgrade(success bool)
func (*NoOpProvider) ObserveHookDuration ¶
func (n *NoOpProvider) ObserveHookDuration(d time.Duration)
type Provider ¶
type Provider interface {
IncSignalReceived(sig string)
IncProcessStarted()
IncProcessFailed()
IncTerminalUpgrade(success bool)
IncHookExecuted()
IncHookPanicked()
ObserveHookDuration(duration time.Duration)
}
Provider defines the interface for collecting lifecycle metrics. Implementations can bridge these calls to Prometheus, OpenTelemetry, etc.
func GetProvider ¶
func GetProvider() Provider
GetProvider returns the current global metrics provider.
Source Files