pmetric

Documentation

Index

• Constants
• Variables
• type Buckets
• type Exemplar
• type ExemplarSlice
• type ExponentialHistogram
• type ExponentialHistogramDataPoint
• type ExponentialHistogramDataPointSlice
• type Gauge
• type Histogram
• type HistogramDataPoint
• type HistogramDataPointSlice
• type Marshaler
  • func NewJSONMarshaler() Marshaler
  • func NewProtoMarshaler() Marshaler
• type Metric
• type MetricAggregationTemporality
• type MetricDataPointFlag
• type MetricDataPointFlags
• type MetricDataType
• type MetricSlice
• type MetricValueType
• type Metrics
• type NumberDataPoint
• type NumberDataPointSlice
• type ResourceMetrics
• type ResourceMetricsSlice
• type ScopeMetrics
• type ScopeMetricsSlice
• type Sizer
• type Sum
• type Summary
• type SummaryDataPoint
• type SummaryDataPointSlice
• type Unmarshaler
  • func NewJSONUnmarshaler() Unmarshaler
  • func NewProtoUnmarshaler() Unmarshaler
• type ValueAtQuantile
• type ValueAtQuantileSlice

Constants

const (
	MetricDataTypeNone                 = internal.MetricDataTypeNone
	MetricDataTypeGauge                = internal.MetricDataTypeGauge
	MetricDataTypeSum                  = internal.MetricDataTypeSum
	MetricDataTypeHistogram            = internal.MetricDataTypeHistogram
	MetricDataTypeExponentialHistogram = internal.MetricDataTypeExponentialHistogram
	MetricDataTypeSummary              = internal.MetricDataTypeSummary
)

const (
	MetricAggregationTemporalityUnspecified = internal.MetricAggregationTemporalityUnspecified
	MetricAggregationTemporalityDelta       = internal.MetricAggregationTemporalityDelta
	MetricAggregationTemporalityCumulative  = internal.MetricAggregationTemporalityCumulative
)

const (
	MetricValueTypeNone   = internal.MetricValueTypeNone
	MetricValueTypeInt    = internal.MetricValueTypeInt
	MetricValueTypeDouble = internal.MetricValueTypeDouble
)

const (
	MetricDataPointFlagNoRecordedValue = internal.MetricDataPointFlagNoRecordedValue
)

const (
	MetricDataPointFlagsNone = internal.MetricDataPointFlagsNone
)

Variables

var NewBuckets = internal.NewBuckets

NewBuckets is an alias for a function to create a new empty Buckets.

var NewExemplar = internal.NewExemplar

NewExemplar is an alias for a function to create a new empty Exemplar.

var NewExemplarSlice = internal.NewExemplarSlice

NewExemplarSlice is an alias for a function to create ExemplarSlice.

var NewExponentialHistogram = internal.NewExponentialHistogram

NewExponentialHistogram is an alias for a function to create a new empty ExponentialHistogram.

var NewExponentialHistogramDataPoint = internal.NewExponentialHistogramDataPoint

NewExponentialHistogramDataPoint is an alias for a function to create a new empty ExponentialHistogramDataPoint.

var NewExponentialHistogramDataPointSlice = internal.NewExponentialHistogramDataPointSlice

NewExponentialHistogramDataPointSlice is an alias for a function to create ExponentialHistogramDataPointSlice.

var NewGauge = internal.NewGauge

NewGauge is an alias for a function to create a new empty Gauge.

var NewHistogram = internal.NewHistogram

NewHistogram is an alias for a function to create a new empty Histogram.

var NewHistogramDataPoint = internal.NewHistogramDataPoint

NewHistogramDataPoint is an alias for a function to create a new empty HistogramDataPoint.

var NewHistogramDataPointSlice = internal.NewHistogramDataPointSlice

NewHistogramDataPointSlice is an alias for a function to create HistogramDataPointSlice.

var NewMetric = internal.NewMetric

NewMetric is an alias for a function to create a new empty Metric.

var NewMetricDataPointFlags = internal.NewMetricDataPointFlags

NewMetricDataPointFlags is an alias for a function to create new MetricDataPointFlags.

var NewMetricSlice = internal.NewMetricSlice

NewMetricSlice is an alias for a function to create MetricSlice.

var NewMetrics = internal.NewMetrics

NewMetrics is an alias for a function to create new Metrics.

var NewNumberDataPoint = internal.NewNumberDataPoint

NewNumberDataPoint is an alias for a function to create a new empty NumberDataPoint.

var NewNumberDataPointSlice = internal.NewNumberDataPointSlice

NewNumberDataPointSlice is an alias for a function to create NumberDataPointSlice.

var NewResourceMetrics = internal.NewResourceMetrics

NewResourceMetrics is an alias for a function to create a new empty ResourceMetrics.

var NewResourceMetricsSlice = internal.NewResourceMetricsSlice

NewResourceMetricsSlice is an alias for a function to create ResourceMetricsSlice.

var NewScopeMetrics = internal.NewScopeMetrics

NewScopeMetrics is an alias for a function to create a new empty ScopeMetrics.

var NewScopeMetricsSlice = internal.NewScopeMetricsSlice

NewScopeMetricsSlice is an alias for a function to create ScopeMetricsSlice.

var NewSum = internal.NewSum

NewSum is an alias for a function to create a new empty Sum.

var NewSummary = internal.NewSummary

NewSummary is an alias for a function to create a new empty Summary.

var NewSummaryDataPoint = internal.NewSummaryDataPoint

NewSummaryDataPoint is an alias for a function to create a new empty SummaryDataPoint.

var NewSummaryDataPointSlice = internal.NewSummaryDataPointSlice

NewSummaryDataPointSlice is an alias for a function to create SummaryDataPointSlice.

var NewValueAtQuantile = internal.NewValueAtQuantile

NewValueAtQuantile is an alias for a function to create a new empty ValueAtQuantile.

var NewValueAtQuantileSlice = internal.NewValueAtQuantileSlice

NewValueAtQuantileSlice is an alias for a function to create ValueAtQuantileSlice.

Types

type Buckets

type Buckets = internal.Buckets

Buckets is an alias for internal.Buckets struct.

type Exemplar

type Exemplar = internal.Exemplar

Exemplar is an alias for internal.Exemplar struct.

type ExemplarSlice

type ExemplarSlice = internal.ExemplarSlice

ExemplarSlice is an alias for internal.ExemplarSlice struct.

type ExponentialHistogram

type ExponentialHistogram = internal.ExponentialHistogram

ExponentialHistogram is an alias for internal.ExponentialHistogram struct.

type ExponentialHistogramDataPoint

type ExponentialHistogramDataPoint = internal.ExponentialHistogramDataPoint

ExponentialHistogramDataPoint is an alias for internal.ExponentialHistogramDataPoint struct.

type ExponentialHistogramDataPointSlice

type ExponentialHistogramDataPointSlice = internal.ExponentialHistogramDataPointSlice

ExponentialHistogramDataPointSlice is an alias for internal.ExponentialHistogramDataPointSlice struct.

type Gauge

type Gauge = internal.Gauge

Gauge is an alias for internal.Gauge struct.

type Histogram

type Histogram = internal.Histogram

Histogram is an alias for internal.Histogram struct.

type HistogramDataPoint

type HistogramDataPoint = internal.HistogramDataPoint

HistogramDataPoint is an alias for internal.HistogramDataPoint struct.

type HistogramDataPointSlice

type HistogramDataPointSlice = internal.HistogramDataPointSlice

HistogramDataPointSlice is an alias for internal.HistogramDataPointSlice struct.

type Marshaler

type Marshaler interface {
	// MarshalMetrics the given pmetric.Metrics into bytes.
	// If the error is not nil, the returned bytes slice cannot be used.
	MarshalMetrics(md Metrics) ([]byte, error)
}

Marshaler marshals pmetric.Metrics into bytes.

func NewJSONMarshaler

func NewJSONMarshaler() Marshaler

NewJSONMarshaler returns a model.Marshaler. Marshals to OTLP json bytes.

func NewProtoMarshaler

func NewProtoMarshaler() Marshaler

NewProtoMarshaler returns a Marshaler. Marshals to OTLP binary protobuf bytes.

type Metric

type Metric = internal.Metric

Metric is an alias for internal.Metric struct.

type MetricAggregationTemporality

type MetricAggregationTemporality = internal.MetricAggregationTemporality

MetricAggregationTemporality is an alias for internal.MetricAggregationTemporality type.

type MetricDataPointFlag

type MetricDataPointFlag = internal.MetricDataPointFlag

MetricDataPointFlag is an alias for internal.MetricDataPointFlag type.

type MetricDataPointFlags

type MetricDataPointFlags = internal.MetricDataPointFlags

MetricDataPointFlags is an alias for internal.MetricDataPointFlags type.

type MetricDataType

type MetricDataType = internal.MetricDataType

MetricDataType is an alias for internal.MetricDataType type.

type MetricSlice

type MetricSlice = internal.MetricSlice

MetricSlice is an alias for internal.MetricSlice struct.

type MetricValueType

type MetricValueType = internal.MetricValueType

MetricValueType is an alias for internal.MetricValueType type.

type Metrics

type Metrics = internal.Metrics

Metrics is an alias for internal.Metrics structure.

type NumberDataPoint

type NumberDataPoint = internal.NumberDataPoint

NumberDataPoint is an alias for internal.NumberDataPoint struct.

type NumberDataPointSlice

type NumberDataPointSlice = internal.NumberDataPointSlice

NumberDataPointSlice is an alias for internal.NumberDataPointSlice struct.

type ResourceMetrics

type ResourceMetrics = internal.ResourceMetrics

ResourceMetrics is an alias for internal.ResourceMetrics struct.

type ResourceMetricsSlice

type ResourceMetricsSlice = internal.ResourceMetricsSlice

ResourceMetricsSlice is an alias for internal.ResourceMetricsSlice struct.

type ScopeMetrics

type ScopeMetrics = internal.ScopeMetrics

ScopeMetrics is an alias for internal.ScopeMetrics struct.

type ScopeMetricsSlice

type ScopeMetricsSlice = internal.ScopeMetricsSlice

ScopeMetricsSlice is an alias for internal.ScopeMetricsSlice struct.

type Sizer

type Sizer interface {
	// MetricsSize returns the size in bytes of a marshaled Metrics.
	MetricsSize(md Metrics) int
}

Sizer is an optional interface implemented by the Marshaler, that calculates the size of a marshaled Metrics.

type Sum

type Sum = internal.Sum

Sum is an alias for internal.Sum struct.

type Summary

type Summary = internal.Summary

Summary is an alias for internal.Summary struct.

type SummaryDataPoint

type SummaryDataPoint = internal.SummaryDataPoint

SummaryDataPoint is an alias for internal.SummaryDataPoint struct.

type SummaryDataPointSlice

type SummaryDataPointSlice = internal.SummaryDataPointSlice

SummaryDataPointSlice is an alias for internal.SummaryDataPointSlice struct.

type Unmarshaler

type Unmarshaler interface {
	// UnmarshalMetrics the given bytes into pmetric.Metrics.
	// If the error is not nil, the returned pmetric.Metrics cannot be used.
	UnmarshalMetrics(buf []byte) (Metrics, error)
}

Unmarshaler unmarshalls bytes into pmetric.Metrics.

func NewJSONUnmarshaler

func NewJSONUnmarshaler() Unmarshaler

NewJSONUnmarshaler returns a model.Unmarshaler. Unmarshals from OTLP json bytes.

func NewProtoUnmarshaler

func NewProtoUnmarshaler() Unmarshaler

NewProtoUnmarshaler returns a model.Unmarshaler. Unmarshals from OTLP binary protobuf bytes.

type ValueAtQuantile

type ValueAtQuantile = internal.ValueAtQuantile

ValueAtQuantile is an alias for internal.ValueAtQuantile struct.

type ValueAtQuantileSlice

type ValueAtQuantileSlice = internal.ValueAtQuantileSlice

ValueAtQuantileSlice is an alias for internal.ValueAtQuantileSlice struct.