metrics

Documentation

Overview

Package metrics handles the aggregated stats that can be reported to a metrics exporter for bot monitoring. This only contains functionality for initializing and managing the stats themselves - the user is expected to set up an OpenCensus exporter.

Index

• type Recorder
  • func NewRecorder() (*Recorder, error)
  • func (r *Recorder) RecordConnectedServers(count int64)
  • func (r *Recorder) RecordRunningPoms(count int64)
  • func (r *Recorder) RecordStartPom()

Types

type Recorder

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

Recorder is our backend-independent metrics recorder. This should be created with NewRecorder().

func NewRecorder

func NewRecorder() (*Recorder, error)

NewRecorder creates a Recorder with its metrics initialized.

func (*Recorder) RecordConnectedServers

func (r *Recorder) RecordConnectedServers(count int64)

RecordConnectedServers records the number of currently connected servers (guilds).

func (*Recorder) RecordRunningPoms

func (r *Recorder) RecordRunningPoms(count int64)

RecordRunningPoms records the number of currently running pomodoros.

func (*Recorder) RecordStartPom

func (r *Recorder) RecordStartPom()

RecordStartPom records the start of a pomodoro.