alerts

Documentation

Overview

Package alerts contains a client to query RBFS alerts

Index

• type Alert
• type Client
  • func NewClient(c *http.Client) Client

Types

type Alert

type Alert struct {
	// AlertName holds the alert rule name
	AlertName string `json:"name"`
	// Summary holds the alert summary.
	Summary string `json:"summary"`
	// Level holds the alert level.
	Level int `json:"level"`
	// DateCreated holds the alert creation time.
	DateCreated time.Time `json:"date_created"`
}

Alert describes a single switch alert.

type Client

type Client interface {
	// QueryAlerts returns a list of firing alerts.
	QueryAlerts(ctx rbfs.RbfsContext) ([]Alert, error)
}

Client providess access to the switch metrics.

func NewClient

func NewClient(c *http.Client) Client

NewClient creates a new client to query switch alerts.