metrics

Documentation

Index

• Constants
• type InstanceInfo
• type Metrics
  • func NewMetrics(info InstanceInfo) *Metrics
  • func (m *Metrics) IncrementBlocksDeleted(num int)
  • func (m *Metrics) IncrementBlocksInserted(num int)
  • func (m *Metrics) IncrementBlocksPatched(num int)
  • func (m *Metrics) IncrementLoginCount(num int)
  • func (m *Metrics) IncrementLoginFailCount(num int)
  • func (m *Metrics) IncrementLogoutCount(num int)
  • func (m *Metrics) ObserveBlockCount(blockType string, count int64)
  • func (m *Metrics) ObserveBoardCount(count int64)
  • func (m *Metrics) ObserveTeamCount(count int64)
• type Service
  • func NewMetricsServer(address string, metricsService *Metrics, logger mlog.LoggerIFace) *Service
  • func (h *Service) Run() error
  • func (h *Service) Shutdown() error

Constants

const (
	MetricsNamespace       = "focalboard"
	MetricsSubsystemBlocks = "blocks"
	MetricsSubsystemBoards = "boards"
	MetricsSubsystemTeams  = "teams"
	MetricsSubsystemSystem = "system"

	MetricsCloudInstallationLabel = "installationId"
)

Types

type InstanceInfo

type InstanceInfo struct {
	Version        string
	BuildNum       string
	Edition        string
	InstallationID string
}

type Metrics

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

Metrics used to instrumentate metrics in prometheus.

func NewMetrics

func NewMetrics(info InstanceInfo) *Metrics

NewMetrics Factory method to create a new metrics collector.

func (*Metrics) IncrementBlocksDeleted

func (m *Metrics) IncrementBlocksDeleted(num int)

func (*Metrics) IncrementBlocksInserted

func (m *Metrics) IncrementBlocksInserted(num int)

func (*Metrics) IncrementBlocksPatched

func (m *Metrics) IncrementBlocksPatched(num int)

func (*Metrics) IncrementLoginCount

func (m *Metrics) IncrementLoginCount(num int)

func (*Metrics) IncrementLoginFailCount

func (m *Metrics) IncrementLoginFailCount(num int)

func (*Metrics) IncrementLogoutCount

func (m *Metrics) IncrementLogoutCount(num int)

func (*Metrics) ObserveBlockCount

func (m *Metrics) ObserveBlockCount(blockType string, count int64)

func (*Metrics) ObserveBoardCount

func (m *Metrics) ObserveBoardCount(count int64)

func (*Metrics) ObserveTeamCount

func (m *Metrics) ObserveTeamCount(count int64)

type Service

type Service struct {
	*http.Server
}

Service prometheus to run the server.

func NewMetricsServer

func NewMetricsServer(address string, metricsService *Metrics, logger mlog.LoggerIFace) *Service

NewMetricsServer factory method to create a new prometheus server.

func (*Service) Run

func (h *Service) Run() error

Run will start the prometheus server.

func (*Service) Shutdown

func (h *Service) Shutdown() error

Shutdown will shutdown the prometheus server.