event

Documentation

Index

• Constants
• func AddCustomAttributes(e *Event, customAttributes []attribute.Attribute)
• type Event
  • func New(summary, category string) *Event
  • func NewNotification(summary string) *Event
  • func NewWithAttributes(summary, category string, attributes map[string]interface{}) *Event

Constants

const (
	// NotificationEventCategory category for notification events.
	NotificationEventCategory = "notifications"
)

Functions

func AddCustomAttributes

func AddCustomAttributes(e *Event, customAttributes []attribute.Attribute)

AddCustomAttributes add customAttributes to the Event

Types

type Event

type Event struct {
	Summary  string `json:"summary"`
	Category string `json:"category,omitempty"`
	// Attributes are optional, they represent additional information that
	// can be attached to an event.
	Attributes map[string]interface{} `json:"attributes,omitempty"`
}

Event is the data type to represent arbitrary, one-off messages for key activities on a system. Ex:

Event{
  Category: "gear",
  Summary:  "gear has been changed",
  Attributes: map[string]interface{}{
    "oldGear":      3,
    "newGear":      4,
    "transmission": "manual",
  },
}

func New

func New(summary, category string) *Event

New creates a new event.

func NewNotification

func NewNotification(summary string) *Event

NewNotification creates a new notification event.

func NewWithAttributes

func NewWithAttributes(summary, category string, attributes map[string]interface{}) *Event

NewWithAttributes creates a new event with the given attributes