unaggregated

Documentation

Index

• type BatchTimer
  • func (t *BatchTimer) FromProto(pb metricpb.BatchTimer)
  • func (t BatchTimer) ToProto(pb *metricpb.BatchTimer)
  • func (t BatchTimer) ToUnion() MetricUnion
• type BatchTimerWithMetadatas
  • func (bm *BatchTimerWithMetadatas) FromProto(pb *metricpb.BatchTimerWithMetadatas) error
  • func (bm BatchTimerWithMetadatas) ToProto(pb *metricpb.BatchTimerWithMetadatas) error
• type BatchTimerWithPoliciesList
• type Counter
  • func (c *Counter) FromProto(pb metricpb.Counter)
  • func (c Counter) ToProto(pb *metricpb.Counter)
  • func (c Counter) ToUnion() MetricUnion
• type CounterWithMetadatas
  • func (cm *CounterWithMetadatas) FromProto(pb *metricpb.CounterWithMetadatas) error
  • func (cm CounterWithMetadatas) ToProto(pb *metricpb.CounterWithMetadatas) error
• type CounterWithPoliciesList
• type Gauge
  • func (g *Gauge) FromProto(pb metricpb.Gauge)
  • func (g Gauge) ToProto(pb *metricpb.Gauge)
  • func (g Gauge) ToUnion() MetricUnion
• type GaugeWithMetadatas
  • func (gm *GaugeWithMetadatas) FromProto(pb *metricpb.GaugeWithMetadatas) error
  • func (gm GaugeWithMetadatas) ToProto(pb *metricpb.GaugeWithMetadatas) error
• type GaugeWithPoliciesList
• type MetricUnion
  • func (m *MetricUnion) BatchTimer() BatchTimer
  • func (m *MetricUnion) Counter() Counter
  • func (m *MetricUnion) Gauge() Gauge
  • func (m *MetricUnion) Reset()
  • func (m *MetricUnion) String() string

Types

type BatchTimer

type BatchTimer struct {
	ID              id.RawID
	Values          []float64
	Annotation      []byte
	ClientTimeNanos xtime.UnixNano
}

BatchTimer is a timer containing the timer ID and a list of timer values.

func (*BatchTimer) FromProto

func (t *BatchTimer) FromProto(pb metricpb.BatchTimer)

FromProto converts the protobuf message to a batch timer in place.

func (BatchTimer) ToProto

func (t BatchTimer) ToProto(pb *metricpb.BatchTimer)

ToProto converts the batch timer to a protobuf message in place.

func (BatchTimer) ToUnion

func (t BatchTimer) ToUnion() MetricUnion

ToUnion converts the batch timer to a metric union.

type BatchTimerWithMetadatas

type BatchTimerWithMetadatas struct {
	metadata.StagedMetadatas
	BatchTimer
}

BatchTimerWithMetadatas is a batch timer with applicable metadatas.

func (*BatchTimerWithMetadatas) FromProto

func (bm *BatchTimerWithMetadatas) FromProto(pb *metricpb.BatchTimerWithMetadatas) error

FromProto converts the protobuf message to a batch timer with metadatas in place.

func (BatchTimerWithMetadatas) ToProto

func (bm BatchTimerWithMetadatas) ToProto(pb *metricpb.BatchTimerWithMetadatas) error

ToProto converts the batch timer with metadatas to a protobuf message in place.

type BatchTimerWithPoliciesList

type BatchTimerWithPoliciesList struct {
	policy.PoliciesList
	BatchTimer
}

BatchTimerWithPoliciesList is a batch timer with applicable policies list.

type Counter

type Counter struct {
	ID              id.RawID
	Annotation      []byte
	Value           int64
	ClientTimeNanos xtime.UnixNano
}

Counter is a counter containing the counter ID and the counter value.

func (*Counter) FromProto

func (c *Counter) FromProto(pb metricpb.Counter)

FromProto converts the protobuf message to a counter in place.

func (Counter) ToProto

func (c Counter) ToProto(pb *metricpb.Counter)

ToProto converts the counter to a protobuf message in place.

func (Counter) ToUnion

func (c Counter) ToUnion() MetricUnion

ToUnion converts the counter to a metric union.

type CounterWithMetadatas

type CounterWithMetadatas struct {
	metadata.StagedMetadatas
	Counter
}

CounterWithMetadatas is a counter with applicable metadatas.

func (*CounterWithMetadatas) FromProto

func (cm *CounterWithMetadatas) FromProto(pb *metricpb.CounterWithMetadatas) error

FromProto converts the protobuf message to a counter with metadatas in place.

func (CounterWithMetadatas) ToProto

func (cm CounterWithMetadatas) ToProto(pb *metricpb.CounterWithMetadatas) error

ToProto converts the counter with metadatas to a protobuf message in place.

type CounterWithPoliciesList

type CounterWithPoliciesList struct {
	policy.PoliciesList
	Counter
}

CounterWithPoliciesList is a counter with applicable policies list.

type Gauge

type Gauge struct {
	ID              id.RawID
	Annotation      []byte
	Value           float64
	ClientTimeNanos xtime.UnixNano
}

Gauge is a gauge containing the gauge ID and the value at certain time.

func (*Gauge) FromProto

func (g *Gauge) FromProto(pb metricpb.Gauge)

FromProto converts the protobuf message to a gauge in place.

func (Gauge) ToProto

func (g Gauge) ToProto(pb *metricpb.Gauge)

ToProto converts the gauge to a protobuf message in place.

func (Gauge) ToUnion

func (g Gauge) ToUnion() MetricUnion

ToUnion converts the gauge to a metric union.

type GaugeWithMetadatas

type GaugeWithMetadatas struct {
	metadata.StagedMetadatas
	Gauge
}

GaugeWithMetadatas is a gauge with applicable metadatas.

func (*GaugeWithMetadatas) FromProto

func (gm *GaugeWithMetadatas) FromProto(pb *metricpb.GaugeWithMetadatas) error

FromProto converts the protobuf message to a gauge with metadatas in place.

func (GaugeWithMetadatas) ToProto

func (gm GaugeWithMetadatas) ToProto(pb *metricpb.GaugeWithMetadatas) error

ToProto converts the gauge with metadatas to a protobuf message in place.

type GaugeWithPoliciesList

type GaugeWithPoliciesList struct {
	policy.PoliciesList
	Gauge
}

GaugeWithPoliciesList is a gauge with applicable policies list.

type MetricUnion

type MetricUnion struct {
	TimerValPool    pool.FloatsPool
	Annotation      []byte
	ID              id.RawID
	BatchTimerVal   []float64
	CounterVal      int64
	GaugeVal        float64
	Type            metric.Type
	ClientTimeNanos xtime.UnixNano
}

MetricUnion is a union of different types of metrics, only one of which is valid at any given time. The actual type of the metric depends on the type field, which determines which value field is valid. Note that if the timer values are allocated from a pool, the TimerValPool should be set to the originating pool, and the caller is responsible for returning the timer values to the pool.

func (*MetricUnion) BatchTimer

func (m *MetricUnion) BatchTimer() BatchTimer

BatchTimer returns the batch timer metric.

func (*MetricUnion) Counter

func (m *MetricUnion) Counter() Counter

Counter returns the counter metric.

func (*MetricUnion) Gauge

func (m *MetricUnion) Gauge() Gauge

Gauge returns the gauge metric.

func (*MetricUnion) Reset

func (m *MetricUnion) Reset()

Reset resets the metric union.

func (*MetricUnion) String

func (m *MetricUnion) String() string

String is the string representation of a metric union.