statusHandler

Documentation

Index

• Variables
• func NewStatusMetrics() *statusMetrics
• type AppStatusFacade
  • func NewAppStatusFacadeWithHandlers(aphs ...core.AppStatusHandler) (*AppStatusFacade, error)
  • func (asf *AppStatusFacade) AddUint64(key string, value uint64)
  • func (asf *AppStatusFacade) Close()
  • func (asf *AppStatusFacade) Decrement(key string)
  • func (asf *AppStatusFacade) Increment(key string)
  • func (asf *AppStatusFacade) IsInterfaceNil() bool
  • func (asf *AppStatusFacade) SetInt64Value(key string, value int64)
  • func (asf *AppStatusFacade) SetStringValue(key string, value string)
  • func (asf *AppStatusFacade) SetUInt64Value(key string, value uint64)
• type NilStatusHandler
  • func NewNilStatusHandler() *NilStatusHandler
  • func (nsh *NilStatusHandler) AddUint64(key string, val uint64)
  • func (nsh *NilStatusHandler) Close()
  • func (nsh *NilStatusHandler) Decrement(key string)
  • func (nsh *NilStatusHandler) Increment(key string)
  • func (nsh *NilStatusHandler) IsInterfaceNil() bool
  • func (nsh *NilStatusHandler) SetInt64Value(key string, value int64)
  • func (nsh *NilStatusHandler) SetStringValue(key string, value string)
  • func (nsh *NilStatusHandler) SetUInt64Value(key string, value uint64)
• type PrometheusStatusHandler
  • func NewPrometheusStatusHandler() *PrometheusStatusHandler
  • func (psh *PrometheusStatusHandler) AddUint64(key string, val uint64)
  • func (psh *PrometheusStatusHandler) Close()
  • func (psh *PrometheusStatusHandler) Decrement(key string)
  • func (psh *PrometheusStatusHandler) Increment(key string)
  • func (psh *PrometheusStatusHandler) InitMetrics()
  • func (psh *PrometheusStatusHandler) InitMetricsMap()
  • func (psh *PrometheusStatusHandler) IsInterfaceNil() bool
  • func (psh *PrometheusStatusHandler) SetInt64Value(key string, value int64)
  • func (psh *PrometheusStatusHandler) SetStringValue(key string, value string)
  • func (psh *PrometheusStatusHandler) SetUInt64Value(key string, value uint64)

Variables

var ErrHandlersSliceIsNil = errors.New("no AppStatusHandler provided")

ErrHandlersSliceIsNil will be returned when trying to create an AppStatusFacade with no handler

var ErrNilGrid = errors.New("nil grid")

ErrNilGrid will be returned when a nil grid is returned

var ErrNilHandlerInSlice = errors.New("nil AppStatusHandler")

ErrNilHandlerInSlice will be returned when one of the handlers passed to the Facade is nil

var ErrNilPresenterInterface = errors.New("nil presenter interface")

ErrNilPresenterInterface will be returned when a nil PresenterInterface is passed as parameter

Functions

func NewStatusMetrics

func NewStatusMetrics() *statusMetrics

NewStatusMetrics will return an instance of the struct

Types

type AppStatusFacade

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

AppStatusFacade will be used for handling multiple monitoring tools at once

func NewAppStatusFacadeWithHandlers

func NewAppStatusFacadeWithHandlers(aphs ...core.AppStatusHandler) (*AppStatusFacade, error)

NewAppStatusFacadeWithHandlers will receive the handlers which should receive monitored data

func (*AppStatusFacade) AddUint64

func (asf *AppStatusFacade) AddUint64(key string, value uint64)

AddUint64 method - will increase the value for a key for every handler

func (*AppStatusFacade) Close

func (asf *AppStatusFacade) Close()

Close method will close all the handlers

func (*AppStatusFacade) Decrement

func (asf *AppStatusFacade) Decrement(key string)

Decrement method - will decrement the value for a key for every handler

func (*AppStatusFacade) Increment

func (asf *AppStatusFacade) Increment(key string)

Increment method - will increment the value for a key for every handler

func (*AppStatusFacade) IsInterfaceNil

func (asf *AppStatusFacade) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

func (*AppStatusFacade) SetInt64Value

func (asf *AppStatusFacade) SetInt64Value(key string, value int64)

SetInt64Value method - will update the value for a key for every handler

func (*AppStatusFacade) SetStringValue

func (asf *AppStatusFacade) SetStringValue(key string, value string)

SetStringValue method - will update the value for a key for every handler

func (*AppStatusFacade) SetUInt64Value

func (asf *AppStatusFacade) SetUInt64Value(key string, value uint64)

SetUInt64Value method - will update the value for a key for every handler

type NilStatusHandler

type NilStatusHandler struct {
}

NilStatusHandler will be used when an AppStatusHandler is required, but another one isn't necessary or available

func NewNilStatusHandler

func NewNilStatusHandler() *NilStatusHandler

NewNilStatusHandler will return an instance of the struct

func (*NilStatusHandler) AddUint64

func (nsh *NilStatusHandler) AddUint64(key string, val uint64)

func (*NilStatusHandler) Close

func (nsh *NilStatusHandler) Close()

Close method - won't do anything

func (*NilStatusHandler) Decrement

func (nsh *NilStatusHandler) Decrement(key string)

Decrement method - won't do anything

func (*NilStatusHandler) Increment

func (nsh *NilStatusHandler) Increment(key string)

Increment method - won't do anything

func (*NilStatusHandler) IsInterfaceNil

func (nsh *NilStatusHandler) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

func (*NilStatusHandler) SetInt64Value

func (nsh *NilStatusHandler) SetInt64Value(key string, value int64)

SetInt64Value method - won't do anything

func (*NilStatusHandler) SetStringValue

func (nsh *NilStatusHandler) SetStringValue(key string, value string)

SetStringValue method - won't do anything

func (*NilStatusHandler) SetUInt64Value

func (nsh *NilStatusHandler) SetUInt64Value(key string, value uint64)

SetUInt64Value method - won't do anything

type PrometheusStatusHandler

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

PrometheusStatusHandler will define the handler which will update prometheus metrics

func NewPrometheusStatusHandler

func NewPrometheusStatusHandler() *PrometheusStatusHandler

NewPrometheusStatusHandler will return an instance of a PrometheusStatusHandler

func (*PrometheusStatusHandler) AddUint64

func (psh *PrometheusStatusHandler) AddUint64(key string, val uint64)

AddUint64 will be used for increase the value for a key with a specific value

func (*PrometheusStatusHandler) Close

func (psh *PrometheusStatusHandler) Close()

Close will unregister Prometheus metrics

func (*PrometheusStatusHandler) Decrement

func (psh *PrometheusStatusHandler) Decrement(key string)

Decrement will be used for decrementing the value for a key

func (*PrometheusStatusHandler) Increment

func (psh *PrometheusStatusHandler) Increment(key string)

Increment will be used for incrementing the value for a key

func (*PrometheusStatusHandler) InitMetrics

func (psh *PrometheusStatusHandler) InitMetrics()

InitMetrics will declare and init all the metrics which should be used for Prometheus

func (*PrometheusStatusHandler) InitMetricsMap

func (psh *PrometheusStatusHandler) InitMetricsMap()

InitMetricsMap will init the map of prometheus metrics

func (*PrometheusStatusHandler) IsInterfaceNil

func (psh *PrometheusStatusHandler) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

func (*PrometheusStatusHandler) SetInt64Value

func (psh *PrometheusStatusHandler) SetInt64Value(key string, value int64)

SetInt64Value method - will update the value for a key

func (*PrometheusStatusHandler) SetStringValue

func (psh *PrometheusStatusHandler) SetStringValue(key string, value string)

SetStringValue method - will update the value for a key

func (*PrometheusStatusHandler) SetUInt64Value

func (psh *PrometheusStatusHandler) SetUInt64Value(key string, value uint64)

SetUInt64Value method - will update the value for a key