exp

package

v0.0.0-...-736556e Latest Latest Go to latest Published: Oct 12, 2023 License: MIT Imports: 6 Imported by: 0

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/Notifiarr/mysql-auth-proxy

Documentation ¶

Index ¶

func AddVar(name string, newVar expvar.Var)
func GetMap(name string) *expvar.Map
type CacheCollector
- func (c *CacheCollector) Collect(ch chan<- prometheus.Metric)
- func (c *CacheCollector) Describe(ch chan<- *prometheus.Desc)
type CacheList
type Metrics
- func GetMetrics(collector *CacheCollector) *Metrics
type Time
- func (e *Time) Since() interface{}

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddVar ¶

func AddVar(name string, newVar expvar.Var)

AddVar allows adding arbitrary vars or maps to our main map.

func GetMap ¶

func GetMap(name string) *expvar.Map

GetMap returns a known-expvar map by name.

Types ¶

type CacheCollector ¶

type CacheCollector struct {
	Stats CacheList
	// contains filtered or unexported fields
}

CacheCollector is our input for creating metrics for our cache data.

func (*CacheCollector) Collect ¶

func (c *CacheCollector) Collect(ch chan<- prometheus.Metric)

Collect satisfies the Collector interface for prometheus.

func (*CacheCollector) Describe ¶

func (c *CacheCollector) Describe(ch chan<- *prometheus.Desc)

Describe satisfies the Collector interface for prometheus.

type CacheList ¶

type CacheList map[string]func() *cache.Stats

CacheList is a map of label to stats functions for each cache.

type Metrics ¶

type Metrics struct {
	QueryErrors  *prometheus.CounterVec
	QueryMissing *prometheus.CounterVec
	QueryTime    *prometheus.HistogramVec
	ReqTime      *prometheus.HistogramVec
	Uptime       prometheus.CounterFunc
}

Metrics contains the exported prometheus metrics used by the application.

func GetMetrics ¶

func GetMetrics(collector *CacheCollector) *Metrics

GetMetrics sets up metrics on startup. @Description Retreive internal application metrics. @Summary Return auth proxy metrics in open metrics format @Tags stats @Produce json @Success 200 {object} any "Auth Proxy Prometheus metrics" @Router /metrics [get]

type Time ¶

type Time struct {
	time.Time
	Num int
}

Time allows formatting time Durations.

func (*Time) Since ¶

func (e *Time) Since() interface{}

Since returns a pretty-formatted time duration for expvar.

Source Files ¶

View all Source files

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