metrics

Documentation

Index

• type CacheMetrics
• type Metrics
  • func CreateMetrics(cfg config.Configuration) *Metrics
  • func (m Metrics) Export(cfg config.Configuration)
  • func (m Metrics) GetEngineRegistry(name string) interface{}
  • func (m Metrics) RecordAcceptConnectionErrors()
  • func (m Metrics) RecordCloseConnectionErrors()
  • func (m Metrics) RecordConnectionClosed()
  • func (m Metrics) RecordConnectionOpen()
  • func (m Metrics) RecordGetBackendDuration(duration time.Duration)
  • func (m Metrics) RecordGetBackendError()
  • func (m Metrics) RecordGetBackendTotal()
  • func (m Metrics) RecordGetBadRequest()
  • func (m Metrics) RecordGetDuration(duration time.Duration)
  • func (m Metrics) RecordGetError()
  • func (m Metrics) RecordGetTotal()
  • func (m Metrics) RecordKeyNotFoundError()
  • func (m Metrics) RecordMissingKeyError()
  • func (m Metrics) RecordPutBackendDuration(duration time.Duration)
  • func (m Metrics) RecordPutBackendError()
  • func (m Metrics) RecordPutBackendInvalid()
  • func (m Metrics) RecordPutBackendJson()
  • func (m Metrics) RecordPutBackendSize(sizeInBytes float64)
  • func (m Metrics) RecordPutBackendTTLSeconds(duration time.Duration)
  • func (m Metrics) RecordPutBackendXml()
  • func (m Metrics) RecordPutBadRequest()
  • func (m Metrics) RecordPutDuration(duration time.Duration)
  • func (m Metrics) RecordPutError()
  • func (m Metrics) RecordPutKeyProvided()
  • func (m Metrics) RecordPutTotal()

Types

type CacheMetrics

type CacheMetrics interface {
	// Auxiliary functions
	Export(cfg config.Metrics)
	GetMetricsEngineName() string
	GetEngineRegistry() interface{}

	// Record, update and log metrics functions
	RecordPutError()
	RecordPutBadRequest()
	RecordPutTotal()
	RecordPutDuration(duration time.Duration)
	RecordPutKeyProvided()
	RecordGetError()
	RecordGetBadRequest()
	RecordGetTotal()
	RecordGetDuration(duration time.Duration)
	RecordPutBackendXml()
	RecordPutBackendJson()
	RecordPutBackendInvalid()
	RecordPutBackendDuration(duration time.Duration)
	RecordPutBackendTTLSeconds(duration time.Duration)
	RecordPutBackendError()
	RecordPutBackendSize(sizeInBytes float64)
	RecordGetBackendTotal()
	RecordGetBackendDuration(duration time.Duration)
	RecordGetBackendError()
	RecordKeyNotFoundError()
	RecordMissingKeyError()
	RecordConnectionOpen()
	RecordConnectionClosed()
	RecordCloseConnectionErrors()
	RecordAcceptConnectionErrors()
}

type Metrics

type Metrics struct {
	MetricEngines []CacheMetrics
}

Metrics provides access to metric engines.

func CreateMetrics

func CreateMetrics(cfg config.Configuration) *Metrics

func (Metrics) Export

func (m Metrics) Export(cfg config.Configuration)

func (Metrics) GetEngineRegistry

func (m Metrics) GetEngineRegistry(name string) interface{}

func (Metrics) RecordAcceptConnectionErrors

func (m Metrics) RecordAcceptConnectionErrors()

func (Metrics) RecordCloseConnectionErrors

func (m Metrics) RecordCloseConnectionErrors()

func (Metrics) RecordConnectionClosed

func (m Metrics) RecordConnectionClosed()

func (Metrics) RecordConnectionOpen

func (m Metrics) RecordConnectionOpen()

func (Metrics) RecordGetBackendDuration

func (m Metrics) RecordGetBackendDuration(duration time.Duration)

func (Metrics) RecordGetBackendError

func (m Metrics) RecordGetBackendError()

func (Metrics) RecordGetBackendTotal

func (m Metrics) RecordGetBackendTotal()

func (Metrics) RecordGetBadRequest

func (m Metrics) RecordGetBadRequest()

func (Metrics) RecordGetDuration

func (m Metrics) RecordGetDuration(duration time.Duration)

func (Metrics) RecordGetError

func (m Metrics) RecordGetError()

func (Metrics) RecordGetTotal

func (m Metrics) RecordGetTotal()

func (Metrics) RecordKeyNotFoundError

func (m Metrics) RecordKeyNotFoundError()

func (Metrics) RecordMissingKeyError

func (m Metrics) RecordMissingKeyError()

func (Metrics) RecordPutBackendDuration

func (m Metrics) RecordPutBackendDuration(duration time.Duration)

func (Metrics) RecordPutBackendError

func (m Metrics) RecordPutBackendError()

func (Metrics) RecordPutBackendInvalid

func (m Metrics) RecordPutBackendInvalid()

func (Metrics) RecordPutBackendJson

func (m Metrics) RecordPutBackendJson()

func (Metrics) RecordPutBackendSize

func (m Metrics) RecordPutBackendSize(sizeInBytes float64)

func (Metrics) RecordPutBackendTTLSeconds

func (m Metrics) RecordPutBackendTTLSeconds(duration time.Duration)

func (Metrics) RecordPutBackendXml

func (m Metrics) RecordPutBackendXml()

func (Metrics) RecordPutBadRequest

func (m Metrics) RecordPutBadRequest()

func (Metrics) RecordPutDuration

func (m Metrics) RecordPutDuration(duration time.Duration)

func (Metrics) RecordPutError

func (m Metrics) RecordPutError()

Methods so the metrics object executes the methods of the `CacheMetrics` interface

func (Metrics) RecordPutKeyProvided

func (m Metrics) RecordPutKeyProvided()

func (Metrics) RecordPutTotal

func (m Metrics) RecordPutTotal()