metrics

Documentation

Overview

A module for defining a metric schema and auxiliary functions for interacting with it.

Index

• type MetricType
  • func (mt MetricType) IsValid() bool
• type Metrics
  • func NewMetric(metricType, metricName, metricValue string) (*Metrics, error)
  • func (m *Metrics) GetValue() (val string)
  • func (m *Metrics) UnmarshalJSON(data []byte) error
  • func (m *Metrics) ValidateType() error
  • func (m *Metrics) ValidateValue() error

Types

type MetricType

type MetricType string

const (
	Gauge   MetricType = "gauge"
	Counter MetricType = "counter"
)

func (MetricType) IsValid

func (mt MetricType) IsValid() bool

type Metrics

type Metrics struct {
	ID    string     `json:"id" db:"name"`                         // имя метрики
	MType MetricType `json:"type" db:"m_type"`                     // параметр, принимающий значение gauge или counter
	Delta *int64     `json:"delta,omitempty" db:"delta,omitempty"` // значение метрики в случае передачи counter
	Value *float64   `json:"value,omitempty" db:"value,omitempty"` // значение метрики в случае передачи gauge
}

Metrics a structure for storing information about metrics.

func NewMetric

func NewMetric(metricType, metricName, metricValue string) (*Metrics, error)

func (*Metrics) GetValue

func (m *Metrics) GetValue() (val string)

func (*Metrics) UnmarshalJSON

func (m *Metrics) UnmarshalJSON(data []byte) error

UnmarshalJSON overriding the standard method to cast to the MetricType type.

func (*Metrics) ValidateType

func (m *Metrics) ValidateType() error

ValidateType checks the validity of the metric type.

func (*Metrics) ValidateValue

func (m *Metrics) ValidateValue() error

ValidateValue checks the value depending on the type of metric.