ui

package

v0.34.1 Latest Latest Go to latest Published: Feb 19, 2024 License: Apache-2.0 Imports: 26 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/thanos-io/thanos

Links

Open Source Insights

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)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetWebPrefix ¶ added in v0.3.0

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 ¶ added in v0.3.0

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 ¶ added in v0.7.0

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 ¶ added in v0.7.0

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

func (*Bucket) Register ¶ added in v0.7.0

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)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL