aggregated

Documentation

Index

• type ChunkedMetric
• type ChunkedMetricWithStoragePolicy
• type ForwardedMetric
  • func (m *ForwardedMetric) FromProto(pb metricpb.ForwardedMetric) error
  • func (m ForwardedMetric) String() string
  • func (m ForwardedMetric) ToProto(pb *metricpb.ForwardedMetric) error
• type ForwardedMetricWithMetadata
  • func (fm *ForwardedMetricWithMetadata) FromProto(pb *metricpb.ForwardedMetricWithMetadata) error
  • func (fm ForwardedMetricWithMetadata) ToProto(pb *metricpb.ForwardedMetricWithMetadata) error
• type Metric
  • func (m *Metric) FromProto(pb metricpb.TimedMetric) error
  • func (m Metric) String() string
  • func (m Metric) ToProto(pb *metricpb.TimedMetric) error
• type MetricWithStoragePolicy
  • func (m *MetricWithStoragePolicy) FromProto(pb metricpb.TimedMetricWithStoragePolicy) error
  • func (m MetricWithStoragePolicy) String() string
  • func (m MetricWithStoragePolicy) ToProto(pb *metricpb.TimedMetricWithStoragePolicy) error
• type RawMetric
• type TimedMetricWithMetadata
  • func (tm *TimedMetricWithMetadata) FromProto(pb *metricpb.TimedMetricWithMetadata) error
  • func (tm TimedMetricWithMetadata) ToProto(pb *metricpb.TimedMetricWithMetadata) error

Types

type ChunkedMetric

type ChunkedMetric struct {
	id.ChunkedID
	TimeNanos int64
	Value     float64
}

ChunkedMetric is a metric with a chunked ID.

type ChunkedMetricWithStoragePolicy

type ChunkedMetricWithStoragePolicy struct {
	ChunkedMetric
	policy.StoragePolicy
}

ChunkedMetricWithStoragePolicy is a chunked metric with applicable storage policy.

type ForwardedMetric

type ForwardedMetric struct {
	Type      metric.Type
	ID        id.RawID
	TimeNanos int64
	Values    []float64
}

ForwardedMetric is a forwarded metric.

func (*ForwardedMetric) FromProto

func (m *ForwardedMetric) FromProto(pb metricpb.ForwardedMetric) error

FromProto converts the protobuf message to a forwarded metric in place.

func (ForwardedMetric) String

func (m ForwardedMetric) String() string

String is a string representation of the forwarded metric.

func (ForwardedMetric) ToProto

func (m ForwardedMetric) ToProto(pb *metricpb.ForwardedMetric) error

ToProto converts the forwarded metric to a protobuf message in place.

type ForwardedMetricWithMetadata

type ForwardedMetricWithMetadata struct {
	ForwardedMetric
	metadata.ForwardMetadata
}

ForwardedMetricWithMetadata is a forwarded metric with metadata.

func (*ForwardedMetricWithMetadata) FromProto

func (fm *ForwardedMetricWithMetadata) FromProto(pb *metricpb.ForwardedMetricWithMetadata) error

FromProto converts the protobuf message to a forwarded metric with metadata in place.

func (ForwardedMetricWithMetadata) ToProto

func (fm ForwardedMetricWithMetadata) ToProto(pb *metricpb.ForwardedMetricWithMetadata) error

ToProto converts the forwarded metric with metadata to a protobuf message in place.

type Metric

type Metric struct {
	Type      metric.Type
	ID        id.RawID
	TimeNanos int64
	Value     float64
}

Metric is a metric, which is essentially a named value at certain time.

func (*Metric) FromProto

func (m *Metric) FromProto(pb metricpb.TimedMetric) error

FromProto converts the protobuf message to a metric in place.

func (Metric) String

func (m Metric) String() string

String is the string representation of a metric.

func (Metric) ToProto

func (m Metric) ToProto(pb *metricpb.TimedMetric) error

ToProto converts the metric to a protobuf message in place.

type MetricWithStoragePolicy

type MetricWithStoragePolicy struct {
	Metric
	policy.StoragePolicy
}

MetricWithStoragePolicy is a metric with applicable storage policy.

func (*MetricWithStoragePolicy) FromProto

func (m *MetricWithStoragePolicy) FromProto(pb metricpb.TimedMetricWithStoragePolicy) error

FromProto converts the protobuf message to a chunked metric with storage policy in place.

func (MetricWithStoragePolicy) String

func (m MetricWithStoragePolicy) String() string

String is the string representation of a metric with storage policy.

func (MetricWithStoragePolicy) ToProto

func (m MetricWithStoragePolicy) ToProto(pb *metricpb.TimedMetricWithStoragePolicy) error

ToProto converts the chunked metric with storage policy to a protobuf message in place.

type RawMetric

type RawMetric interface {
	// ID is the metric identifier.
	ID() (id.RawID, error)

	// TimeNanos is the metric timestamp in nanoseconds.
	TimeNanos() (int64, error)

	// Value is the metric value.
	Value() (float64, error)

	// Metric is the metric object represented by the raw metric.
	Metric() (Metric, error)

	// Bytes are the bytes backing this raw metric.
	Bytes() []byte

	// Reset resets the raw data.
	Reset(data []byte)
}

RawMetric is a metric in its raw form (e.g., encoded bytes associated with a metric object).

type TimedMetricWithMetadata

type TimedMetricWithMetadata struct {
	Metric
	metadata.TimedMetadata
}

TimedMetricWithMetadata is a timed metric with metadata.

func (*TimedMetricWithMetadata) FromProto

func (tm *TimedMetricWithMetadata) FromProto(pb *metricpb.TimedMetricWithMetadata) error

FromProto converts the protobuf message to a timed metric with metadata in place.

func (TimedMetricWithMetadata) ToProto

func (tm TimedMetricWithMetadata) ToProto(pb *metricpb.TimedMetricWithMetadata) error

ToProto converts the timed metric with metadata to a protobuf message in place.