event

Documentation

Overview

Package event records Kubernetes events.

Index

• type APIRecorder
  • func NewAPIRecorder(r record.EventRecorder) *APIRecorder
  • func (r *APIRecorder) Event(obj runtime.Object, e Event)
  • func (r *APIRecorder) WithAnnotations(keysAndValues ...string) Recorder
• type Event
  • func Normal(r Reason, message string, keysAndValues ...string) Event
  • func Warning(r Reason, err error, keysAndValues ...string) Event
• type NopRecorder
  • func NewNopRecorder() *NopRecorder
  • func (r *NopRecorder) Event(_ runtime.Object, _ Event)
  • func (r *NopRecorder) WithAnnotations(_ ...string) Recorder
• type Reason
• type Recorder
• type Type

Types

type APIRecorder

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

An APIRecorder records Kubernetes events to an API server.

func NewAPIRecorder

func NewAPIRecorder(r record.EventRecorder) *APIRecorder

NewAPIRecorder returns an APIRecorder that records Kubernetes events to an APIServer using the supplied EventRecorder.

func (*APIRecorder) Event

func (r *APIRecorder) Event(obj runtime.Object, e Event)

Event records the supplied event.

func (*APIRecorder) WithAnnotations

func (r *APIRecorder) WithAnnotations(keysAndValues ...string) Recorder

WithAnnotations returns a new *APIRecorder that includes the supplied annotations with all recorded events.

type Event

type Event struct {
	Type        Type
	Reason      Reason
	Message     string
	Annotations map[string]string
}

An Event relating to a Crossplane resource.

func Normal

func Normal(r Reason, message string, keysAndValues ...string) Event

Normal returns a normal, informational event.

func Warning

func Warning(r Reason, err error, keysAndValues ...string) Event

Warning returns a warning event, typically due to an error.

type NopRecorder

type NopRecorder struct{}

A NopRecorder does nothing.

func NewNopRecorder

func NewNopRecorder() *NopRecorder

NewNopRecorder returns a Recorder that does nothing.

func (*NopRecorder) Event

func (r *NopRecorder) Event(_ runtime.Object, _ Event)

Event does nothing.

func (*NopRecorder) WithAnnotations

func (r *NopRecorder) WithAnnotations(_ ...string) Recorder

WithAnnotations does nothing.

type Reason

type Reason string

Reason an event occurred.

type Recorder

type Recorder interface {
	Event(obj runtime.Object, e Event)
	WithAnnotations(keysAndValues ...string) Recorder
}

A Recorder records Kubernetes events.

type Type

type Type string

A Type of event.

const (
	TypeNormal  Type = "Normal"
	TypeWarning Type = "Warning"
)

Event types. See below for valid types. https://godoc.org/k8s.io/client-go/tools/record#EventRecorder