ui

README

The ui package contains static files and templates used in the web UI. For easier distribution they are included in the Thanos binary using go:embed.

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 react-app before committing to update the generated static files and templates.

Documentation

Index

• func GetWebPrefix(logger log.Logger, externalPrefix, prefixHeader string, r *http.Request) string
• func SanitizePrefix(prefix string) (string, error)
• type BaseUI
  • func NewBaseUI(logger log.Logger, funcMap template.FuncMap, tmplVariables map[string]string, ...) *BaseUI
• type Bucket
  • func NewBucketUI(logger log.Logger, externalPrefix, prefixHeader string, ...) *Bucket
  • func (b *Bucket) Register(r *route.Router, ins extpromhttp.InstrumentationMiddleware)
• type Query
  • func NewQueryUI(logger log.Logger, endpointSet *query.EndpointSet, ...) *Query
  • func (q *Query) Register(r *route.Router, ins extpromhttp.InstrumentationMiddleware)
• type Rule
  • func NewRuleUI(logger log.Logger, reg prometheus.Registerer, ruleManager *thanosrules.Manager, ...) *Rule
  • func (ru *Rule) Register(r *route.Router, ins extpromhttp.InstrumentationMiddleware)

Functions

func GetWebPrefix

func GetWebPrefix(logger log.Logger, externalPrefix, prefixHeader 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 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 BaseUI

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

func NewBaseUI

func NewBaseUI(logger log.Logger, funcMap template.FuncMap, tmplVariables map[string]string, externalPrefix, prefixHeader string, component component.Component) *BaseUI

type Bucket

type Bucket struct {
	*BaseUI

	Err error
	// contains filtered or unexported fields
}

Bucket is a web UI representing state of buckets as a timeline.

func NewBucketUI

func NewBucketUI(logger log.Logger, externalPrefix, prefixHeader string, comp component.Component) *Bucket

func (*Bucket) Register

func (b *Bucket) Register(r *route.Router, ins extpromhttp.InstrumentationMiddleware)

Register registers http routes for bucket UI.

type Query

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

func NewQueryUI

func NewQueryUI(logger log.Logger, endpointSet *query.EndpointSet, externalPrefix, prefixHeader, alertQueryURL string) *Query

func (*Query) Register

func (q *Query) Register(r *route.Router, ins extpromhttp.InstrumentationMiddleware)

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

type Rule

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

func NewRuleUI

func NewRuleUI(logger log.Logger, reg prometheus.Registerer, ruleManager *thanosrules.Manager, queryURL, externalPrefix, prefixHeader string) *Rule

func (*Rule) Register

func (ru *Rule) Register(r *route.Router, ins extpromhttp.InstrumentationMiddleware)