events

Documentation

Index

• Constants
• Variables
• func QueryForEvent(eventType string) tmpubsub.Query
• type EventDataHealthStatus

Constants

const (
	EventHealthStatus = "HealthStatus"
)

Define the event types

const (
	// EventTypeKey is a reserved composite key for event name.
	EventNodeTypeKey = "node.event"
)

Define the event type keys

Variables

var (
	EventQueryHealthStatus = QueryForEvent(EventHealthStatus)
)

Define queries

Functions

func QueryForEvent

func QueryForEvent(eventType string) tmpubsub.Query

QueryForEvent returns a query for the given event.

Types

type EventDataHealthStatus

type EventDataHealthStatus struct {
	// Healthy is true if the base layers are healthy
	Healthy bool
	// Error is the error that was encountered in case of a health check failure
	Error error
}

EventDataHealthStatus defines the structure of the event data for the EventHealthStatus