healthinterface

Documentation

Index

• Variables
• type ConnectionStatus
• type Health
• type InboundInterface
• type OutboundInterface
• type ServiceStatus

Variables

var (
	// ServiceRunning represents service is Running
	ServiceRunning ServiceStatus = "Running"
	// ServiceDegraded represents service health is Degraded
	ServiceDegraded ServiceStatus = "Degraded"
	// ServiceStopped represents service is Stopped
	ServiceStopped ServiceStatus = "Stopped"
	// ConnectionActive represents connection is active
	ConnectionActive ConnectionStatus = "Active"
	// ConnectionDisconnected represents connection is disconnected
	ConnectionDisconnected ConnectionStatus = "Disconnected"
)

Types

type ConnectionStatus

type ConnectionStatus string

ConnectionStatus represents the connection status

type Health

type Health struct {
	TimeStampUTC        time.Time           `json:"TimeStampUTC,omitempty"`
	ServiceName         string              `json:"ServiceName,omitempty"`
	ServiceProvider     string              `json:"ServiceProvider,omitempty"`
	ServiceVersion      string              `json:"ServiceVersion,omitempty"`
	ServiceStatus       ServiceStatus       `json:"ServiceStatus,omitempty"`
	ServiceStartTimeUTC time.Time           `json:"ServiceStartTimeUTC,omitempty"`
	Uptime              float64             `json:"Uptime,omitempty"`
	InboundInterfaces   []InboundInterface  `json:"InboundInterfaces,omitempty"`
	OutboundInterfaces  []OutboundInterface `json:"OutboundInterfaces,omitempty"`
}

Health represents health response

type InboundInterface

type InboundInterface struct {
	ApplicationName  string           `json:"ApplicationName,omitempty"`
	ConnectionStatus ConnectionStatus `json:"ConnectionStatus,omitempty"`
	TimeStampUTC     time.Time        `json:"TimeStampUTC,omitempty"`
	Hostname         string           `json:"Hostname,omitempty"`
	Address          string           `json:"Address,omitempty"`
	OS               string           `json:"OS,omitempty"`
}

InboundInterface is inbound network inferfaces

type OutboundInterface

type OutboundInterface struct {
	ApplicationName  string           `json:"ApplicationName,omitempty"`
	TimeStampUTC     time.Time        `json:"TimeStampUTC,omitempty"`
	URLs             []string         `json:"URLs,omitempty"`
	ConnectionStatus ConnectionStatus `json:"ConnectionStatus,omitempty"`
}

OutboundInterface is outbound network interfaces

type ServiceStatus

type ServiceStatus string

ServiceStatus represents the service status