ui

README

The ui package contains static files and templates used in the web UI. For easier distribution they are statically compiled into the Thanos binary using the go-bindata tool (c.f. Makefile).

During development it is more convenient to always use the files on disk to directly see changes without recompiling. Set the environment variable DEBUG=1 and compile Thanos for this to work. This is for development purposes only.

After making changes to any file, run make assets before committing to update the generated inline version of the file.

Documentation

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func GetWebPrefix(logger log.Logger, flagsMap map[string]string, r *http.Request) string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• func SanitizePrefix(prefix string) (string, error)
• type AlertStatus
• type BaseUI
  • func NewBaseUI(logger log.Logger, menuTmpl string, funcMap template.FuncMap) *BaseUI
• type Query
  • func NewQueryUI(logger log.Logger, storeSet *query.StoreSet, flagsMap map[string]string) *Query
  • func (q *Query) Register(r *route.Router)
• type Rule
  • func NewRuleUI(logger log.Logger, ruleManager *rules.Manager, queryURL string, ...) *Rule
  • func (ru *Rule) Register(r *route.Router)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func GetWebPrefix

func GetWebPrefix(logger log.Logger, flagsMap map[string]string, r *http.Request) string

GetWebPrefix sanitizes an external URL path prefix value. A value provided by web.external-prefix flag is preferred over the one supplied through an HTTP header.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

func SanitizePrefix

func SanitizePrefix(prefix string) (string, error)

SanitizePrefix makes sure that path prefix value is valid. A prefix is returned without a trailing slash. Hence empty string is returned for the root path.

Types

type AlertStatus

type AlertStatus struct {
	AlertingRules        []*rules.AlertingRule
	AlertStateToRowClass map[rules.AlertState]string
}

AlertStatus bundles alerting rules and the mapping of alert states to row classes.

type BaseUI

type BaseUI struct {
	// contains filtered or unexported fields
}

func NewBaseUI

func NewBaseUI(logger log.Logger, menuTmpl string, funcMap template.FuncMap) *BaseUI

type Query

type Query struct {
	*BaseUI
	// contains filtered or unexported fields
}

func NewQueryUI

func NewQueryUI(logger log.Logger, storeSet *query.StoreSet, flagsMap map[string]string) *Query

func (*Query) Register

func (q *Query) Register(r *route.Router)

Register registers new GET routes for subpages and retirects from / to /graph.

type Rule

type Rule struct {
	*BaseUI
	// contains filtered or unexported fields
}

func NewRuleUI

func NewRuleUI(logger log.Logger, ruleManager *rules.Manager, queryURL string, flagsMap map[string]string) *Rule

func (*Rule) Register

func (ru *Rule) Register(r *route.Router)