metrics

Documentation

Index

• type Metrics
  • func New(applicationName string) *Metrics
  • func (m *Metrics) GinHandler() gin.HandlerFunc
  • func (m *Metrics) IncAuthenticationAccepted(r *request.Request)
  • func (m *Metrics) IncAuthenticationRejected(r *request.Request)
  • func (m *Metrics) IncConnectionInfoFailure()
  • func (m *Metrics) IncCountryHits(country string)
  • func (m *Metrics) IncDatabaseFetchFailure(r *request.Request)
  • func (m *Metrics) IncOAuthClientStoreHits()
  • func (m *Metrics) IncOAuthClientStoreMisses()
  • func (m *Metrics) IncOAuthTokenStoreIssueFailures()
  • func (m *Metrics) IncOAuthTokenStoreIssueSuccesses()
  • func (m *Metrics) IncOAuthTokenStoreLookupHits(method string)
  • func (m *Metrics) IncOAuthTokenStoreLookupMisses(method string)
  • func (m *Metrics) IncPolicyHits(scope, name string)
  • func (m *Metrics) IncPolicyMisses(scope, name string)
  • func (m *Metrics) IncUnknownAPIKey(r *request.Request)
  • func (m *Metrics) IncreaseMetricConfigLoad(what string)
  • func (m *Metrics) NewTimerAuthLatency() *prometheus.Timer
  • func (m *Metrics) RegisterWithPrometheus()

Types

type Metrics

type Metrics struct {
	UnknownAPIkey                 *prometheus.CounterVec
	PolicyHits                    *prometheus.CounterVec
	PolicyMisses                  *prometheus.CounterVec
	CountryHits                   *prometheus.CounterVec
	OAuthClientStoreHits          prometheus.Counter
	OAuthClientStoreMisses        prometheus.Counter
	OAuthTokenStoreIssueSuccesses prometheus.Counter
	OAuthTokenStoreIssueFailures  prometheus.Counter
	OAuthTokenStoreLookupHits     *prometheus.CounterVec
	OAuthTokenStoreLookupMisses   *prometheus.CounterVec
	// contains filtered or unexported fields
}

Metrics holds all our metrics

func New

func New(applicationName string) *Metrics

New returns a new Metrics instance

func (*Metrics) GinHandler

func (m *Metrics) GinHandler() gin.HandlerFunc

GinHandler returns a Gin handler for Prometheus metrics endpoint

func (*Metrics) IncAuthenticationAccepted

func (m *Metrics) IncAuthenticationAccepted(r *request.Request)

IncAuthenticationAccepted counts requests that are accepted

func (*Metrics) IncAuthenticationRejected

func (m *Metrics) IncAuthenticationRejected(r *request.Request)

IncAuthenticationRejected counts requests that are rejected

func (*Metrics) IncConnectionInfoFailure

func (m *Metrics) IncConnectionInfoFailure()

IncConnectionInfoFailure increases connection info failures metric

func (*Metrics) IncCountryHits

func (m *Metrics) IncCountryHits(country string)

IncCountryHits increases country hit metric

func (*Metrics) IncDatabaseFetchFailure

func (m *Metrics) IncDatabaseFetchFailure(r *request.Request)

IncDatabaseFetchFailure increases database retrieval failure metric

func (*Metrics) IncOAuthClientStoreHits

func (m *Metrics) IncOAuthClientStoreHits()

IncOAuthClientStoreHits increases oauth client store hit metric

func (*Metrics) IncOAuthClientStoreMisses

func (m *Metrics) IncOAuthClientStoreMisses()

IncOAuthClientStoreMisses increases oauth client store miss metric

func (*Metrics) IncOAuthTokenStoreIssueFailures

func (m *Metrics) IncOAuthTokenStoreIssueFailures()

IncOAuthTokenStoreIssueFailures increases oauth token store failure metric

func (*Metrics) IncOAuthTokenStoreIssueSuccesses

func (m *Metrics) IncOAuthTokenStoreIssueSuccesses()

IncOAuthTokenStoreIssueSuccesses increases oauth token store success hit metric

func (*Metrics) IncOAuthTokenStoreLookupHits

func (m *Metrics) IncOAuthTokenStoreLookupHits(method string)

IncOAuthTokenStoreLookupHits increases oauth token store lookup hit metric

func (*Metrics) IncOAuthTokenStoreLookupMisses

func (m *Metrics) IncOAuthTokenStoreLookupMisses(method string)

IncOAuthTokenStoreLookupMisses increases oauth token store lookup miss metric

func (*Metrics) IncPolicyHits

func (m *Metrics) IncPolicyHits(scope, name string)

IncPolicyHits increases policy hit metric

func (*Metrics) IncPolicyMisses

func (m *Metrics) IncPolicyMisses(scope, name string)

IncPolicyMisses increases policy miss metric

func (*Metrics) IncUnknownAPIKey

func (m *Metrics) IncUnknownAPIKey(r *request.Request)

IncUnknownAPIKey increases unknown apikey metric

func (*Metrics) IncreaseMetricConfigLoad

func (m *Metrics) IncreaseMetricConfigLoad(what string)

IncreaseMetricConfigLoad increases configuration loads metric

func (*Metrics) NewTimerAuthLatency

func (m *Metrics) NewTimerAuthLatency() *prometheus.Timer

NewTimerAuthLatency returns timer to record latency of authentication

func (*Metrics) RegisterWithPrometheus

func (m *Metrics) RegisterWithPrometheus()

RegisterWithPrometheus registers our operational metrics