metrics

Documentation

Index

• Constants
• func NewGitClientEventHandlers(metricsServer *Server) git.EventHandlers
• type CommitResponseType
• type GitRequestType
• type Server
  • func NewMetricsServer() *Server
  • func (m *Server) DecPendingCommitRequest(repo string)
  • func (m *Server) GetHandler() http.Handler
  • func (m *Server) IncCommitRequest(repo string, rt CommitResponseType)
  • func (m *Server) IncGitRequest(repo string, requestType GitRequestType)
  • func (m *Server) IncPendingCommitRequest(repo string)
  • func (m *Server) ObserveCommitRequestDuration(repo string, rt CommitResponseType, duration time.Duration)
  • func (m *Server) ObserveGitRequestDuration(repo string, requestType GitRequestType, duration time.Duration)
  • func (m *Server) ObserveUserInfoRequestDuration(repo string, credentialType string, duration time.Duration)

Constants

const (
	// GitRequestTypeLsRemote is a request to list remote refs
	GitRequestTypeLsRemote = "ls-remote"
	// GitRequestTypeFetch is a request to fetch from remote
	GitRequestTypeFetch = "fetch"
	// GitRequestTypePush is a request to push to remote
	GitRequestTypePush = "push"
)

Functions

func NewGitClientEventHandlers

func NewGitClientEventHandlers(metricsServer *Server) git.EventHandlers

NewGitClientEventHandlers creates event handlers that update Git related metrics

Types

type CommitResponseType

type CommitResponseType string

CommitResponseType is the type of response for a commit request

const (
	// CommitResponseTypeSuccess is a successful commit request
	CommitResponseTypeSuccess CommitResponseType = "success"
	// CommitResponseTypeFailure is a failed commit request
	CommitResponseTypeFailure CommitResponseType = "failure"
)

type GitRequestType

type GitRequestType string

GitRequestType is the type of git request

type Server

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

Server is a prometheus server which collects application metrics.

func NewMetricsServer

func NewMetricsServer() *Server

NewMetricsServer returns a new prometheus server which collects application metrics.

func (*Server) DecPendingCommitRequest

func (m *Server) DecPendingCommitRequest(repo string)

DecPendingCommitRequest decrements the pending commit requests gauge

func (*Server) GetHandler

func (m *Server) GetHandler() http.Handler

GetHandler returns the http.Handler for the prometheus server

func (*Server) IncCommitRequest

func (m *Server) IncCommitRequest(repo string, rt CommitResponseType)

IncCommitRequest increments the commit request counter

func (*Server) IncGitRequest

func (m *Server) IncGitRequest(repo string, requestType GitRequestType)

IncGitRequest increments the git requests counter

func (*Server) IncPendingCommitRequest

func (m *Server) IncPendingCommitRequest(repo string)

IncPendingCommitRequest increments the pending commit requests gauge

func (*Server) ObserveCommitRequestDuration

func (m *Server) ObserveCommitRequestDuration(repo string, rt CommitResponseType, duration time.Duration)

ObserveCommitRequestDuration observes the duration of a commit request

func (*Server) ObserveGitRequestDuration

func (m *Server) ObserveGitRequestDuration(repo string, requestType GitRequestType, duration time.Duration)

ObserveGitRequestDuration observes the duration of a git request

func (*Server) ObserveUserInfoRequestDuration

func (m *Server) ObserveUserInfoRequestDuration(repo string, credentialType string, duration time.Duration)

ObserveUserInfoRequestDuration observes the duration of a userinfo request