record

Documentation

Index

• Constants
• func NewAPIFactorySettings(arInformer argoinformers.AnalysisRunInformer) api.Settings
• func NewFakeApiFactory() api.Factory
• type EventOptions
• type EventRecorder
  • func NewEventRecorder(kubeclientset kubernetes.Interface, rolloutEventCounter *prometheus.CounterVec, ...) EventRecorder
• type EventRecorderAdapter
  • func (e *EventRecorderAdapter) Eventf(object runtime.Object, opts EventOptions, messageFmt string, args ...any)
  • func (e *EventRecorderAdapter) K8sRecorder() record.EventRecorder
  • func (e *EventRecorderAdapter) Warnf(object runtime.Object, opts EventOptions, messageFmt string, args ...any)
• type FakeEventRecorder
  • func NewFakeEventRecorder() *FakeEventRecorder
  • func (e *FakeEventRecorder) Events() []string

Constants

const (
	NotificationConfigMap = "argo-rollouts-notification-configmap"
	NotificationSecret    = "argo-rollouts-notification-secret"
)

Functions

func NewAPIFactorySettings

func NewAPIFactorySettings(arInformer argoinformers.AnalysisRunInformer) api.Settings

func NewFakeApiFactory

func NewFakeApiFactory() api.Factory

Types

type EventOptions

type EventOptions struct {
	// EventType is the kubernetes event type (Normal or Warning). Defaults to Normal
	EventType string
	// EventReason is a Kubernetes EventReason of why this event is generated.
	// Reason should be short and unique; it  should be in UpperCamelCase format (starting with a
	// capital letter). "reason" will be used to automate handling of events, so imagine people
	// writing switch statements to handle them.
	EventReason string
}

type EventRecorder

type EventRecorder interface {
	Eventf(object runtime.Object, opts EventOptions, messageFmt string, args ...any)
	Warnf(object runtime.Object, opts EventOptions, messageFmt string, args ...any)
	K8sRecorder() record.EventRecorder
}

func NewEventRecorder

func NewEventRecorder(kubeclientset kubernetes.Interface, rolloutEventCounter *prometheus.CounterVec, notificationFailedCounter *prometheus.CounterVec, notificationSuccessCounter *prometheus.CounterVec, notificationSendPerformance *prometheus.HistogramVec, apiFactory api.Factory) EventRecorder

type EventRecorderAdapter

type EventRecorderAdapter struct {
	// Recorder is a K8s EventRecorder
	Recorder record.EventRecorder
	// RolloutEventCounter is a counter to increment on events
	RolloutEventCounter *prometheus.CounterVec
	// NotificationFailCounter is a counter to increment on failing to send notifications
	NotificationFailedCounter *prometheus.CounterVec
	// NotificationSuccessCounter is a counter to increment on successful send notifications
	NotificationSuccessCounter  *prometheus.CounterVec
	NotificationSendPerformance *prometheus.HistogramVec
	// contains filtered or unexported fields
}

EventRecorderAdapter implements the EventRecorder interface

func (*EventRecorderAdapter) Eventf

func (e *EventRecorderAdapter) Eventf(object runtime.Object, opts EventOptions, messageFmt string, args ...any)

func (*EventRecorderAdapter) K8sRecorder

func (e *EventRecorderAdapter) K8sRecorder() record.EventRecorder

func (*EventRecorderAdapter) Warnf

func (e *EventRecorderAdapter) Warnf(object runtime.Object, opts EventOptions, messageFmt string, args ...any)

type FakeEventRecorder

type FakeEventRecorder struct {
	EventRecorderAdapter
	// contains filtered or unexported fields
}

FakeEventRecorder wraps EventRecorderAdapter but with a convenience function to get all the event reasons which were emitted

func NewFakeEventRecorder

func NewFakeEventRecorder() *FakeEventRecorder

func (*FakeEventRecorder) Events

func (e *FakeEventRecorder) Events() []string

Events returns a list of received events, with thread safety