prom

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

type BasePoolOpts struct {
	// Maximum number of connections.
	// Set to zero or negative value to use default value.
	MaxPoolSize int `json:"max_size"`

	// Minimum number of idle connections. Default value is 1.
	MinPoolSize int `json:"min_size"`

	// Maximum amount of time a connection may be reused.
	// Set to zero or negative value to use default value.
	ConnLifetime time.Duration `json:"conn_lifetime"`
}

type CmdExecInfo struct {
	// Id is the command's unique id.
	Id string `json:"id"`

	// BeginTime is the timestamp when the command started execution.
	BeginTime time.Time `json:"tbegin"`

	// EndTime is the timestamp when the command finished execution.
	EndTime time.Time `json:"tend"`

	// CmdName is name of the command.
	CmdName string `json:"cname"`

	// CmdRequest captures the command's arguments/input.
	CmdRequest interface{} `json:"creq"`

	// CmdResponse captures the command's output.
	CmdResponse interface{} `json:"cres"`

	// CmdMeta captures other metadata of the command.
	CmdMeta interface{} `json:"meta"`

	// Result is the output status upon command execution.
	Result interface{} `json:"result"`

	// Cost is the associated execution cost.
	Cost float64 `json:"cost"`

	// Error captures the execution error, if any.
	Error error `json:"error"`
}

type IBaseConnection interface {
	// PoolOpts returns the pooling options attached to this connection.
	PoolOpts() IBasePoolOpts

	// MetricsLogger returns the metrics logger attached to this connection.
	MetricsLogger() IMetricsLogger

	// RegisterMetricsLogger attaches a metrics logger to this connection.
	// This function returns the connection itself for chaining.
	RegisterMetricsLogger(logger IMetricsLogger) IBaseConnection

	// NewCmdExecInfo is the convenient function to create a new CmdExecInfo instance.
	// The returned CmdExecInfo should have  its 'id' and 'begin-time' fields initialized.
	NewCmdExecInfo() *CmdExecInfo

	// LogMetrics is the convenient function to put the CmdExecInfo to the metrics log.
	// This function is silently no-op if the input iis nil or there is no associated metrics logger.
	LogMetrics(category string, cmd *CmdExecInfo) error

	// Metrics is the convenient function to capture the snapshot of command execution metrics.
	// This function is silently no-op if there is no associated metrics logger.
	Metrics(category string, opts ...MetricsOpts) (*Metrics, error)
}

type IBasePoolOpts interface {
}

type IMetricsLogger interface {
	// Put stores a CmdExecInfo instance.
	Put(category string, cmd *CmdExecInfo) error

	// Metrics returns the snapshot of command execution metrics.
	Metrics(category string, opts ...MetricsOpts) (*Metrics, error)
}

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

type Metrics struct {
	// Name of the category the metrics belong to.
	Category string `json:"cat"`

	// Total number of executed commands since the last reset.
	TotalNumCmds int64 `json:"total"`

	// It might not be practical to store all executed commands to calculate metrics with 100% accuracy. Most of the
	// time, stats of latest executed command is more important. This is the number of last executed commands used
	// to calculate the metrics.
	ReservoirNumCmds int64 `json:"window"`

	// The statistics minimum value of command execution cost.
	MinCost float64 `json:"min"`

	// The statistics maximum value of command execution cost.
	MaxCost float64 `json:"max"`

	// The statistics mean value of command execution cost.
	MeanCost float64 `json:"avg"`

	// The statistics p99 value of command execution cost.
	P99Cost float64 `json:"p99"`

	// The statistics p95 value of command execution cost.
	P95Cost float64 `json:"p95"`

	// The statistics p90 value of command execution cost.
	P90Cost float64 `json:"p90"`

	// The statistics p75 value of command execution cost.
	P75Cost float64 `json:"p75"`

	// The statistics p50 value of command execution cost.
	P50Cost float64 `json:"p50"`

	// Last N executed commands.
	LastNCmds []*CmdExecInfo `json:"last"`
}

type MetricsOpts struct {
	// This option specifies the number of last commands to be returned along with the metrics.
	ReturnLatestCommands int
}