ui

Documentation

Index

• Variables
• type Badge
• type Config
  • func GetDefaultConfig() *Config
  • func (config *Config) ValidateAndSetDefaults() error
• type ResponseTime

Variables

var (
	ErrInvalidBadgeResponseTimeConfig = errors.New("invalid response time badge configuration: expected parameter 'response-time' to have 5 ascending numerical values")
)

Types

type Badge

type Badge struct {
	ResponseTime *ResponseTime `yaml:"response-time"`
}

type Config

type Config struct {
	// HideConditions whether to hide the condition results on the UI
	HideConditions bool `yaml:"hide-conditions"`

	// HideHostname whether to hide the hostname in the Result
	HideHostname bool `yaml:"hide-hostname"`

	// HideURL whether to ensure the URL is not displayed in the results. Useful if the URL contains a token.
	HideURL bool `yaml:"hide-url"`

	// DontResolveFailedConditions whether to resolve failed conditions in the Result for display in the UI
	DontResolveFailedConditions bool `yaml:"dont-resolve-failed-conditions"`

	// Badge is the configuration for the badges generated
	Badge *Badge `yaml:"badge"`
}

Config is the UI configuration for endpoint.Endpoint

func GetDefaultConfig

func GetDefaultConfig() *Config

GetDefaultConfig retrieves the default UI configuration

func (*Config) ValidateAndSetDefaults

func (config *Config) ValidateAndSetDefaults() error

ValidateAndSetDefaults validates the UI configuration and sets the default values

type ResponseTime

type ResponseTime struct {
	Thresholds []int `yaml:"thresholds"`
}