pmetric

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 20, 2024 License: Apache-2.0 Imports: 11 Imported by: 416

Documentation

Index

Constants

View Source
const (
	// AggregationTemporalityUnspecified is the default AggregationTemporality, it MUST NOT be used.
	AggregationTemporalityUnspecified = AggregationTemporality(otlpmetrics.AggregationTemporality_AGGREGATION_TEMPORALITY_UNSPECIFIED)
	// AggregationTemporalityDelta is a AggregationTemporality for a metric aggregator which reports changes since last report time.
	AggregationTemporalityDelta = AggregationTemporality(otlpmetrics.AggregationTemporality_AGGREGATION_TEMPORALITY_DELTA)
	// AggregationTemporalityCumulative is a AggregationTemporality for a metric aggregator which reports changes since a fixed start time.
	AggregationTemporalityCumulative = AggregationTemporality(otlpmetrics.AggregationTemporality_AGGREGATION_TEMPORALITY_CUMULATIVE)
)

Variables

View Source
var DefaultDataPointFlags = DataPointFlags(0)

Functions

This section is empty.

Types

type AggregationTemporality added in v0.62.0

type AggregationTemporality int32

AggregationTemporality defines how a metric aggregator reports aggregated values. It describes how those values relate to the time interval over which they are aggregated.

func (AggregationTemporality) String added in v0.62.0

func (at AggregationTemporality) String() string

String returns the string representation of the AggregationTemporality.

type DataPointFlags added in v0.62.0

type DataPointFlags uint32

DataPointFlags defines how a metric aggregator reports aggregated values. It describes how those values relate to the time interval over which they are aggregated.

func (DataPointFlags) NoRecordedValue added in v0.62.0

func (ms DataPointFlags) NoRecordedValue() bool

NoRecordedValue returns true if the DataPointFlags contains the NoRecordedValue flag.

func (DataPointFlags) WithNoRecordedValue added in v0.62.0

func (ms DataPointFlags) WithNoRecordedValue(b bool) DataPointFlags

WithNoRecordedValue returns a new DataPointFlags, with the NoRecordedValue flag set to the given value.

type Exemplar

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

Exemplar is a sample input double measurement.

Exemplars also hold information about the environment when the measurement was recorded, for example the span and trace ID of the active span when the exemplar was recorded.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewExemplar function to create new instances. Important: zero-initialized instance is not valid for use.

func NewExemplar

func NewExemplar() Exemplar

NewExemplar creates a new empty Exemplar.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (Exemplar) CopyTo added in v0.59.0

func (ms Exemplar) CopyTo(dest Exemplar)

CopyTo copies all properties from the current struct overriding the destination.

func (Exemplar) DoubleValue added in v0.61.0

func (ms Exemplar) DoubleValue() float64

DoubleValue returns the double associated with this Exemplar.

func (Exemplar) FilteredAttributes added in v0.59.0

func (ms Exemplar) FilteredAttributes() pcommon.Map

FilteredAttributes returns the FilteredAttributes associated with this Exemplar.

func (Exemplar) IntValue added in v0.61.0

func (ms Exemplar) IntValue() int64

IntValue returns the int associated with this Exemplar.

func (Exemplar) MoveTo added in v0.59.0

func (ms Exemplar) MoveTo(dest Exemplar)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (Exemplar) SetDoubleValue added in v0.61.0

func (ms Exemplar) SetDoubleValue(v float64)

SetDoubleValue replaces the double associated with this Exemplar.

func (Exemplar) SetIntValue added in v0.61.0

func (ms Exemplar) SetIntValue(v int64)

SetIntValue replaces the int associated with this Exemplar.

func (Exemplar) SetSpanID added in v0.59.0

func (ms Exemplar) SetSpanID(v pcommon.SpanID)

SetSpanID replaces the spanid associated with this Exemplar.

func (Exemplar) SetTimestamp added in v0.59.0

func (ms Exemplar) SetTimestamp(v pcommon.Timestamp)

SetTimestamp replaces the timestamp associated with this Exemplar.

func (Exemplar) SetTraceID added in v0.59.0

func (ms Exemplar) SetTraceID(v pcommon.TraceID)

SetTraceID replaces the traceid associated with this Exemplar.

func (Exemplar) SpanID added in v0.59.0

func (ms Exemplar) SpanID() pcommon.SpanID

SpanID returns the spanid associated with this Exemplar.

func (Exemplar) Timestamp added in v0.59.0

func (ms Exemplar) Timestamp() pcommon.Timestamp

Timestamp returns the timestamp associated with this Exemplar.

func (Exemplar) TraceID added in v0.59.0

func (ms Exemplar) TraceID() pcommon.TraceID

TraceID returns the traceid associated with this Exemplar.

func (Exemplar) ValueType added in v0.59.0

func (ms Exemplar) ValueType() ExemplarValueType

ValueType returns the type of the value for this Exemplar. Calling this function on zero-initialized Exemplar will cause a panic.

type ExemplarSlice

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

ExemplarSlice logically represents a slice of Exemplar.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewExemplarSlice function to create new instances. Important: zero-initialized instance is not valid for use.

func NewExemplarSlice

func NewExemplarSlice() ExemplarSlice

NewExemplarSlice creates a ExemplarSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

func (ExemplarSlice) AppendEmpty added in v0.59.0

func (es ExemplarSlice) AppendEmpty() Exemplar

AppendEmpty will append to the end of the slice an empty Exemplar. It returns the newly added Exemplar.

func (ExemplarSlice) At added in v0.59.0

func (es ExemplarSlice) At(i int) Exemplar

At returns the element at the given index.

This function is used mostly for iterating over all the values in the slice:

for i := 0; i < es.Len(); i++ {
    e := es.At(i)
    ... // Do something with the element
}

func (ExemplarSlice) CopyTo added in v0.59.0

func (es ExemplarSlice) CopyTo(dest ExemplarSlice)

CopyTo copies all elements from the current slice overriding the destination.

func (ExemplarSlice) EnsureCapacity added in v0.59.0

func (es ExemplarSlice) EnsureCapacity(newCap int)

EnsureCapacity is an operation that ensures the slice has at least the specified capacity. 1. If the newCap <= cap then no change in capacity. 2. If the newCap > cap then the slice capacity will be expanded to equal newCap.

Here is how a new ExemplarSlice can be initialized:

es := NewExemplarSlice()
es.EnsureCapacity(4)
for i := 0; i < 4; i++ {
    e := es.AppendEmpty()
    // Here should set all the values for e.
}

func (ExemplarSlice) Len added in v0.59.0

func (es ExemplarSlice) Len() int

Len returns the number of elements in the slice.

Returns "0" for a newly instance created with "NewExemplarSlice()".

func (ExemplarSlice) MoveAndAppendTo added in v0.59.0

func (es ExemplarSlice) MoveAndAppendTo(dest ExemplarSlice)

MoveAndAppendTo moves all elements from the current slice and appends them to the dest. The current slice will be cleared.

func (ExemplarSlice) RemoveIf added in v0.59.0

func (es ExemplarSlice) RemoveIf(f func(Exemplar) bool)

RemoveIf calls f sequentially for each element present in the slice. If f returns true, the element is removed from the slice.

type ExemplarValueType added in v0.50.0

type ExemplarValueType int32

ExemplarValueType specifies the type of Exemplar measurement value.

const (
	// ExemplarValueTypeEmpty means that exemplar value is unset.
	ExemplarValueTypeEmpty ExemplarValueType = iota
	ExemplarValueTypeInt
	ExemplarValueTypeDouble
)

func (ExemplarValueType) String added in v0.59.0

func (nt ExemplarValueType) String() string

String returns the string representation of the ExemplarValueType.

type ExponentialHistogram

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

ExponentialHistogram represents the type of a metric that is calculated by aggregating as a ExponentialHistogram of all reported double measurements over a time interval.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewExponentialHistogram function to create new instances. Important: zero-initialized instance is not valid for use.

func NewExponentialHistogram

func NewExponentialHistogram() ExponentialHistogram

NewExponentialHistogram creates a new empty ExponentialHistogram.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (ExponentialHistogram) AggregationTemporality added in v0.59.0

func (ms ExponentialHistogram) AggregationTemporality() AggregationTemporality

AggregationTemporality returns the aggregationtemporality associated with this ExponentialHistogram.

func (ExponentialHistogram) CopyTo added in v0.59.0

CopyTo copies all properties from the current struct overriding the destination.

func (ExponentialHistogram) DataPoints added in v0.59.0

DataPoints returns the DataPoints associated with this ExponentialHistogram.

func (ExponentialHistogram) MoveTo added in v0.59.0

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (ExponentialHistogram) SetAggregationTemporality added in v0.59.0

func (ms ExponentialHistogram) SetAggregationTemporality(v AggregationTemporality)

SetAggregationTemporality replaces the aggregationtemporality associated with this ExponentialHistogram.

type ExponentialHistogramDataPoint

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

ExponentialHistogramDataPoint is a single data point in a timeseries that describes the time-varying values of a ExponentialHistogram of double values. A ExponentialHistogram contains summary statistics for a population of values, it may optionally contain the distribution of those values across a set of buckets.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewExponentialHistogramDataPoint function to create new instances. Important: zero-initialized instance is not valid for use.

func NewExponentialHistogramDataPoint

func NewExponentialHistogramDataPoint() ExponentialHistogramDataPoint

NewExponentialHistogramDataPoint creates a new empty ExponentialHistogramDataPoint.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (ExponentialHistogramDataPoint) Attributes added in v0.59.0

func (ms ExponentialHistogramDataPoint) Attributes() pcommon.Map

Attributes returns the Attributes associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) CopyTo added in v0.59.0

CopyTo copies all properties from the current struct overriding the destination.

func (ExponentialHistogramDataPoint) Count added in v0.59.0

Count returns the count associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) Exemplars added in v0.59.0

Exemplars returns the Exemplars associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) Flags added in v0.59.0

Flags returns the flags associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) HasMax added in v0.59.0

func (ms ExponentialHistogramDataPoint) HasMax() bool

HasMax returns true if the ExponentialHistogramDataPoint contains a Max value, false otherwise.

func (ExponentialHistogramDataPoint) HasMin added in v0.59.0

func (ms ExponentialHistogramDataPoint) HasMin() bool

HasMin returns true if the ExponentialHistogramDataPoint contains a Min value, false otherwise.

func (ExponentialHistogramDataPoint) HasSum added in v0.59.0

func (ms ExponentialHistogramDataPoint) HasSum() bool

HasSum returns true if the ExponentialHistogramDataPoint contains a Sum value, false otherwise.

func (ExponentialHistogramDataPoint) Max added in v0.59.0

Max returns the max associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) Min added in v0.59.0

Min returns the min associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) MoveTo added in v0.59.0

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (ExponentialHistogramDataPoint) Negative added in v0.59.0

Negative returns the negative associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) Positive added in v0.59.0

Positive returns the positive associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) RemoveMax added in v1.0.0

func (ms ExponentialHistogramDataPoint) RemoveMax()

RemoveMax removes the max associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) RemoveMin added in v1.0.0

func (ms ExponentialHistogramDataPoint) RemoveMin()

RemoveMin removes the min associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) RemoveSum added in v1.0.0

func (ms ExponentialHistogramDataPoint) RemoveSum()

RemoveSum removes the sum associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) Scale added in v0.59.0

Scale returns the scale associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) SetCount added in v0.59.0

func (ms ExponentialHistogramDataPoint) SetCount(v uint64)

SetCount replaces the count associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) SetFlags added in v0.60.0

SetFlags replaces the flags associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) SetMax added in v0.59.0

SetMax replaces the max associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) SetMin added in v0.59.0

SetMin replaces the min associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) SetScale added in v0.59.0

func (ms ExponentialHistogramDataPoint) SetScale(v int32)

SetScale replaces the scale associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) SetStartTimestamp added in v0.59.0

func (ms ExponentialHistogramDataPoint) SetStartTimestamp(v pcommon.Timestamp)

SetStartTimestamp replaces the starttimestamp associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) SetSum added in v0.59.0

SetSum replaces the sum associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) SetTimestamp added in v0.59.0

func (ms ExponentialHistogramDataPoint) SetTimestamp(v pcommon.Timestamp)

SetTimestamp replaces the timestamp associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) SetZeroCount added in v0.59.0

func (ms ExponentialHistogramDataPoint) SetZeroCount(v uint64)

SetZeroCount replaces the zerocount associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) SetZeroThreshold added in v1.0.0

func (ms ExponentialHistogramDataPoint) SetZeroThreshold(v float64)

SetZeroThreshold replaces the zerothreshold associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) StartTimestamp added in v0.59.0

func (ms ExponentialHistogramDataPoint) StartTimestamp() pcommon.Timestamp

StartTimestamp returns the starttimestamp associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) Sum added in v0.59.0

Sum returns the sum associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) Timestamp added in v0.59.0

Timestamp returns the timestamp associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) ZeroCount added in v0.59.0

func (ms ExponentialHistogramDataPoint) ZeroCount() uint64

ZeroCount returns the zerocount associated with this ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPoint) ZeroThreshold added in v1.0.0

func (ms ExponentialHistogramDataPoint) ZeroThreshold() float64

ZeroThreshold returns the zerothreshold associated with this ExponentialHistogramDataPoint.

type ExponentialHistogramDataPointBuckets added in v0.62.0

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

ExponentialHistogramDataPointBuckets are a set of bucket counts, encoded in a contiguous array of counts.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewExponentialHistogramDataPointBuckets function to create new instances. Important: zero-initialized instance is not valid for use.

func NewExponentialHistogramDataPointBuckets added in v0.62.0

func NewExponentialHistogramDataPointBuckets() ExponentialHistogramDataPointBuckets

NewExponentialHistogramDataPointBuckets creates a new empty ExponentialHistogramDataPointBuckets.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (ExponentialHistogramDataPointBuckets) BucketCounts added in v0.62.0

BucketCounts returns the bucketcounts associated with this ExponentialHistogramDataPointBuckets.

func (ExponentialHistogramDataPointBuckets) CopyTo added in v0.62.0

CopyTo copies all properties from the current struct overriding the destination.

func (ExponentialHistogramDataPointBuckets) MoveTo added in v0.62.0

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (ExponentialHistogramDataPointBuckets) Offset added in v0.62.0

Offset returns the offset associated with this ExponentialHistogramDataPointBuckets.

func (ExponentialHistogramDataPointBuckets) SetOffset added in v0.62.0

SetOffset replaces the offset associated with this ExponentialHistogramDataPointBuckets.

type ExponentialHistogramDataPointSlice

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

ExponentialHistogramDataPointSlice logically represents a slice of ExponentialHistogramDataPoint.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewExponentialHistogramDataPointSlice function to create new instances. Important: zero-initialized instance is not valid for use.

func NewExponentialHistogramDataPointSlice

func NewExponentialHistogramDataPointSlice() ExponentialHistogramDataPointSlice

NewExponentialHistogramDataPointSlice creates a ExponentialHistogramDataPointSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

func (ExponentialHistogramDataPointSlice) AppendEmpty added in v0.59.0

AppendEmpty will append to the end of the slice an empty ExponentialHistogramDataPoint. It returns the newly added ExponentialHistogramDataPoint.

func (ExponentialHistogramDataPointSlice) At added in v0.59.0

At returns the element at the given index.

This function is used mostly for iterating over all the values in the slice:

for i := 0; i < es.Len(); i++ {
    e := es.At(i)
    ... // Do something with the element
}

func (ExponentialHistogramDataPointSlice) CopyTo added in v0.59.0

CopyTo copies all elements from the current slice overriding the destination.

func (ExponentialHistogramDataPointSlice) EnsureCapacity added in v0.59.0

func (es ExponentialHistogramDataPointSlice) EnsureCapacity(newCap int)

EnsureCapacity is an operation that ensures the slice has at least the specified capacity. 1. If the newCap <= cap then no change in capacity. 2. If the newCap > cap then the slice capacity will be expanded to equal newCap.

Here is how a new ExponentialHistogramDataPointSlice can be initialized:

es := NewExponentialHistogramDataPointSlice()
es.EnsureCapacity(4)
for i := 0; i < 4; i++ {
    e := es.AppendEmpty()
    // Here should set all the values for e.
}

func (ExponentialHistogramDataPointSlice) Len added in v0.59.0

Len returns the number of elements in the slice.

Returns "0" for a newly instance created with "NewExponentialHistogramDataPointSlice()".

func (ExponentialHistogramDataPointSlice) MoveAndAppendTo added in v0.59.0

MoveAndAppendTo moves all elements from the current slice and appends them to the dest. The current slice will be cleared.

func (ExponentialHistogramDataPointSlice) RemoveIf added in v0.59.0

RemoveIf calls f sequentially for each element present in the slice. If f returns true, the element is removed from the slice.

func (ExponentialHistogramDataPointSlice) Sort added in v0.59.0

Sort sorts the ExponentialHistogramDataPoint elements within ExponentialHistogramDataPointSlice given the provided less function so that two instances of ExponentialHistogramDataPointSlice can be compared.

type Gauge

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

Gauge represents the type of a numeric metric that always exports the "current value" for every data point.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewGauge function to create new instances. Important: zero-initialized instance is not valid for use.

func NewGauge

func NewGauge() Gauge

NewGauge creates a new empty Gauge.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (Gauge) CopyTo added in v0.59.0

func (ms Gauge) CopyTo(dest Gauge)

CopyTo copies all properties from the current struct overriding the destination.

func (Gauge) DataPoints added in v0.59.0

func (ms Gauge) DataPoints() NumberDataPointSlice

DataPoints returns the DataPoints associated with this Gauge.

func (Gauge) MoveTo added in v0.59.0

func (ms Gauge) MoveTo(dest Gauge)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

type Histogram

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

Histogram represents the type of a metric that is calculated by aggregating as a Histogram of all reported measurements over a time interval.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewHistogram function to create new instances. Important: zero-initialized instance is not valid for use.

func NewHistogram

func NewHistogram() Histogram

NewHistogram creates a new empty Histogram.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (Histogram) AggregationTemporality added in v0.59.0

func (ms Histogram) AggregationTemporality() AggregationTemporality

AggregationTemporality returns the aggregationtemporality associated with this Histogram.

func (Histogram) CopyTo added in v0.59.0

func (ms Histogram) CopyTo(dest Histogram)

CopyTo copies all properties from the current struct overriding the destination.

func (Histogram) DataPoints added in v0.59.0

func (ms Histogram) DataPoints() HistogramDataPointSlice

DataPoints returns the DataPoints associated with this Histogram.

func (Histogram) MoveTo added in v0.59.0

func (ms Histogram) MoveTo(dest Histogram)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (Histogram) SetAggregationTemporality added in v0.59.0

func (ms Histogram) SetAggregationTemporality(v AggregationTemporality)

SetAggregationTemporality replaces the aggregationtemporality associated with this Histogram.

type HistogramDataPoint

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

HistogramDataPoint is a single data point in a timeseries that describes the time-varying values of a Histogram of values.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewHistogramDataPoint function to create new instances. Important: zero-initialized instance is not valid for use.

func NewHistogramDataPoint

func NewHistogramDataPoint() HistogramDataPoint

NewHistogramDataPoint creates a new empty HistogramDataPoint.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (HistogramDataPoint) Attributes added in v0.59.0

func (ms HistogramDataPoint) Attributes() pcommon.Map

Attributes returns the Attributes associated with this HistogramDataPoint.

func (HistogramDataPoint) BucketCounts added in v0.59.0

func (ms HistogramDataPoint) BucketCounts() pcommon.UInt64Slice

BucketCounts returns the bucketcounts associated with this HistogramDataPoint.

func (HistogramDataPoint) CopyTo added in v0.59.0

func (ms HistogramDataPoint) CopyTo(dest HistogramDataPoint)

CopyTo copies all properties from the current struct overriding the destination.

func (HistogramDataPoint) Count added in v0.59.0

func (ms HistogramDataPoint) Count() uint64

Count returns the count associated with this HistogramDataPoint.

func (HistogramDataPoint) Exemplars added in v0.59.0

func (ms HistogramDataPoint) Exemplars() ExemplarSlice

Exemplars returns the Exemplars associated with this HistogramDataPoint.

func (HistogramDataPoint) ExplicitBounds added in v0.59.0

func (ms HistogramDataPoint) ExplicitBounds() pcommon.Float64Slice

ExplicitBounds returns the explicitbounds associated with this HistogramDataPoint.

func (HistogramDataPoint) Flags added in v0.59.0

Flags returns the flags associated with this HistogramDataPoint.

func (HistogramDataPoint) HasMax added in v0.59.0

func (ms HistogramDataPoint) HasMax() bool

HasMax returns true if the HistogramDataPoint contains a Max value, false otherwise.

func (HistogramDataPoint) HasMin added in v0.59.0

func (ms HistogramDataPoint) HasMin() bool

HasMin returns true if the HistogramDataPoint contains a Min value, false otherwise.

func (HistogramDataPoint) HasSum added in v0.59.0

func (ms HistogramDataPoint) HasSum() bool

HasSum returns true if the HistogramDataPoint contains a Sum value, false otherwise.

func (HistogramDataPoint) Max added in v0.59.0

func (ms HistogramDataPoint) Max() float64

Max returns the max associated with this HistogramDataPoint.

func (HistogramDataPoint) Min added in v0.59.0

func (ms HistogramDataPoint) Min() float64

Min returns the min associated with this HistogramDataPoint.

func (HistogramDataPoint) MoveTo added in v0.59.0

func (ms HistogramDataPoint) MoveTo(dest HistogramDataPoint)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (HistogramDataPoint) RemoveMax added in v1.0.0

func (ms HistogramDataPoint) RemoveMax()

RemoveMax removes the max associated with this HistogramDataPoint.

func (HistogramDataPoint) RemoveMin added in v1.0.0

func (ms HistogramDataPoint) RemoveMin()

RemoveMin removes the min associated with this HistogramDataPoint.

func (HistogramDataPoint) RemoveSum added in v1.0.0

func (ms HistogramDataPoint) RemoveSum()

RemoveSum removes the sum associated with this HistogramDataPoint.

func (HistogramDataPoint) SetCount added in v0.59.0

func (ms HistogramDataPoint) SetCount(v uint64)

SetCount replaces the count associated with this HistogramDataPoint.

func (HistogramDataPoint) SetFlags added in v0.60.0

func (ms HistogramDataPoint) SetFlags(v DataPointFlags)

SetFlags replaces the flags associated with this HistogramDataPoint.

func (HistogramDataPoint) SetMax added in v0.59.0

func (ms HistogramDataPoint) SetMax(v float64)

SetMax replaces the max associated with this HistogramDataPoint.

func (HistogramDataPoint) SetMin added in v0.59.0

func (ms HistogramDataPoint) SetMin(v float64)

SetMin replaces the min associated with this HistogramDataPoint.

func (HistogramDataPoint) SetStartTimestamp added in v0.59.0

func (ms HistogramDataPoint) SetStartTimestamp(v pcommon.Timestamp)

SetStartTimestamp replaces the starttimestamp associated with this HistogramDataPoint.

func (HistogramDataPoint) SetSum added in v0.59.0

func (ms HistogramDataPoint) SetSum(v float64)

SetSum replaces the sum associated with this HistogramDataPoint.

func (HistogramDataPoint) SetTimestamp added in v0.59.0

func (ms HistogramDataPoint) SetTimestamp(v pcommon.Timestamp)

SetTimestamp replaces the timestamp associated with this HistogramDataPoint.

func (HistogramDataPoint) StartTimestamp added in v0.59.0

func (ms HistogramDataPoint) StartTimestamp() pcommon.Timestamp

StartTimestamp returns the starttimestamp associated with this HistogramDataPoint.

func (HistogramDataPoint) Sum added in v0.59.0

func (ms HistogramDataPoint) Sum() float64

Sum returns the sum associated with this HistogramDataPoint.

func (HistogramDataPoint) Timestamp added in v0.59.0

func (ms HistogramDataPoint) Timestamp() pcommon.Timestamp

Timestamp returns the timestamp associated with this HistogramDataPoint.

type HistogramDataPointSlice

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

HistogramDataPointSlice logically represents a slice of HistogramDataPoint.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewHistogramDataPointSlice function to create new instances. Important: zero-initialized instance is not valid for use.

func NewHistogramDataPointSlice

func NewHistogramDataPointSlice() HistogramDataPointSlice

NewHistogramDataPointSlice creates a HistogramDataPointSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

func (HistogramDataPointSlice) AppendEmpty added in v0.59.0

AppendEmpty will append to the end of the slice an empty HistogramDataPoint. It returns the newly added HistogramDataPoint.

func (HistogramDataPointSlice) At added in v0.59.0

At returns the element at the given index.

This function is used mostly for iterating over all the values in the slice:

for i := 0; i < es.Len(); i++ {
    e := es.At(i)
    ... // Do something with the element
}

func (HistogramDataPointSlice) CopyTo added in v0.59.0

CopyTo copies all elements from the current slice overriding the destination.

func (HistogramDataPointSlice) EnsureCapacity added in v0.59.0

func (es HistogramDataPointSlice) EnsureCapacity(newCap int)

EnsureCapacity is an operation that ensures the slice has at least the specified capacity. 1. If the newCap <= cap then no change in capacity. 2. If the newCap > cap then the slice capacity will be expanded to equal newCap.

Here is how a new HistogramDataPointSlice can be initialized:

es := NewHistogramDataPointSlice()
es.EnsureCapacity(4)
for i := 0; i < 4; i++ {
    e := es.AppendEmpty()
    // Here should set all the values for e.
}

func (HistogramDataPointSlice) Len added in v0.59.0

func (es HistogramDataPointSlice) Len() int

Len returns the number of elements in the slice.

Returns "0" for a newly instance created with "NewHistogramDataPointSlice()".

func (HistogramDataPointSlice) MoveAndAppendTo added in v0.59.0

func (es HistogramDataPointSlice) MoveAndAppendTo(dest HistogramDataPointSlice)

MoveAndAppendTo moves all elements from the current slice and appends them to the dest. The current slice will be cleared.

func (HistogramDataPointSlice) RemoveIf added in v0.59.0

func (es HistogramDataPointSlice) RemoveIf(f func(HistogramDataPoint) bool)

RemoveIf calls f sequentially for each element present in the slice. If f returns true, the element is removed from the slice.

func (HistogramDataPointSlice) Sort added in v0.59.0

func (es HistogramDataPointSlice) Sort(less func(a, b HistogramDataPoint) bool)

Sort sorts the HistogramDataPoint elements within HistogramDataPointSlice given the provided less function so that two instances of HistogramDataPointSlice can be compared.

type JSONMarshaler added in v0.63.0

type JSONMarshaler struct{}

JSONMarshaler marshals pdata.Metrics to JSON bytes using the OTLP/JSON format.

func (*JSONMarshaler) MarshalMetrics added in v0.63.0

func (*JSONMarshaler) MarshalMetrics(md Metrics) ([]byte, error)

MarshalMetrics to the OTLP/JSON format.

type JSONUnmarshaler added in v0.63.0

type JSONUnmarshaler struct{}

JSONUnmarshaler unmarshals OTLP/JSON formatted-bytes to pdata.Metrics.

func (*JSONUnmarshaler) UnmarshalMetrics added in v0.63.0

func (*JSONUnmarshaler) UnmarshalMetrics(buf []byte) (Metrics, error)

UnmarshalMetrics from OTLP/JSON format into pdata.Metrics.

type MarshalSizer added in v0.60.0

type MarshalSizer interface {
	Marshaler
	Sizer
}

MarshalSizer is the interface that groups the basic Marshal and Size methods

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.

type Metric

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

Metric represents one metric as a collection of datapoints. See Metric definition in OTLP: https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/metrics/v1/metrics.proto

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewMetric function to create new instances. Important: zero-initialized instance is not valid for use.

func NewMetric

func NewMetric() Metric

NewMetric creates a new empty Metric.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (Metric) CopyTo added in v0.59.0

func (ms Metric) CopyTo(dest Metric)

CopyTo copies all properties from the current struct overriding the destination.

func (Metric) Description added in v0.59.0

func (ms Metric) Description() string

Description returns the description associated with this Metric.

func (Metric) ExponentialHistogram added in v0.59.0

func (ms Metric) ExponentialHistogram() ExponentialHistogram

ExponentialHistogram returns the exponentialhistogram associated with this Metric.

Calling this function when Type() != MetricTypeExponentialHistogram returns an invalid zero-initialized instance of ExponentialHistogram. Note that using such ExponentialHistogram instance can cause panic.

Calling this function on zero-initialized Metric will cause a panic.

func (Metric) Gauge added in v0.59.0

func (ms Metric) Gauge() Gauge

Gauge returns the gauge associated with this Metric.

Calling this function when Type() != MetricTypeGauge returns an invalid zero-initialized instance of Gauge. Note that using such Gauge instance can cause panic.

Calling this function on zero-initialized Metric will cause a panic.

func (Metric) Histogram added in v0.59.0

func (ms Metric) Histogram() Histogram

Histogram returns the histogram associated with this Metric.

Calling this function when Type() != MetricTypeHistogram returns an invalid zero-initialized instance of Histogram. Note that using such Histogram instance can cause panic.

Calling this function on zero-initialized Metric will cause a panic.

func (Metric) MoveTo added in v0.59.0

func (ms Metric) MoveTo(dest Metric)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (Metric) Name added in v0.59.0

func (ms Metric) Name() string

Name returns the name associated with this Metric.

func (Metric) SetDescription added in v0.59.0

func (ms Metric) SetDescription(v string)

SetDescription replaces the description associated with this Metric.

func (Metric) SetEmptyExponentialHistogram added in v0.60.0

func (ms Metric) SetEmptyExponentialHistogram() ExponentialHistogram

SetEmptyExponentialHistogram sets an empty exponentialhistogram to this Metric.

After this, Type() function will return MetricTypeExponentialHistogram".

Calling this function on zero-initialized Metric will cause a panic.

func (Metric) SetEmptyGauge added in v0.60.0

func (ms Metric) SetEmptyGauge() Gauge

SetEmptyGauge sets an empty gauge to this Metric.

After this, Type() function will return MetricTypeGauge".

Calling this function on zero-initialized Metric will cause a panic.

func (Metric) SetEmptyHistogram added in v0.60.0

func (ms Metric) SetEmptyHistogram() Histogram

SetEmptyHistogram sets an empty histogram to this Metric.

After this, Type() function will return MetricTypeHistogram".

Calling this function on zero-initialized Metric will cause a panic.

func (Metric) SetEmptySum added in v0.60.0

func (ms Metric) SetEmptySum() Sum

SetEmptySum sets an empty sum to this Metric.

After this, Type() function will return MetricTypeSum".

Calling this function on zero-initialized Metric will cause a panic.

func (Metric) SetEmptySummary added in v0.60.0

func (ms Metric) SetEmptySummary() Summary

SetEmptySummary sets an empty summary to this Metric.

After this, Type() function will return MetricTypeSummary".

Calling this function on zero-initialized Metric will cause a panic.

func (Metric) SetName added in v0.59.0

func (ms Metric) SetName(v string)

SetName replaces the name associated with this Metric.

func (Metric) SetUnit added in v0.59.0

func (ms Metric) SetUnit(v string)

SetUnit replaces the unit associated with this Metric.

func (Metric) Sum added in v0.59.0

func (ms Metric) Sum() Sum

Sum returns the sum associated with this Metric.

Calling this function when Type() != MetricTypeSum returns an invalid zero-initialized instance of Sum. Note that using such Sum instance can cause panic.

Calling this function on zero-initialized Metric will cause a panic.

func (Metric) Summary added in v0.59.0

func (ms Metric) Summary() Summary

Summary returns the summary associated with this Metric.

Calling this function when Type() != MetricTypeSummary returns an invalid zero-initialized instance of Summary. Note that using such Summary instance can cause panic.

Calling this function on zero-initialized Metric will cause a panic.

func (Metric) Type added in v0.61.0

func (ms Metric) Type() MetricType

Type returns the type of the data for this Metric. Calling this function on zero-initialized Metric will cause a panic.

func (Metric) Unit added in v0.59.0

func (ms Metric) Unit() string

Unit returns the unit associated with this Metric.

type MetricSlice

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

MetricSlice logically represents a slice of Metric.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewMetricSlice function to create new instances. Important: zero-initialized instance is not valid for use.

func NewMetricSlice

func NewMetricSlice() MetricSlice

NewMetricSlice creates a MetricSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

func (MetricSlice) AppendEmpty added in v0.59.0

func (es MetricSlice) AppendEmpty() Metric

AppendEmpty will append to the end of the slice an empty Metric. It returns the newly added Metric.

func (MetricSlice) At added in v0.59.0

func (es MetricSlice) At(i int) Metric

At returns the element at the given index.

This function is used mostly for iterating over all the values in the slice:

for i := 0; i < es.Len(); i++ {
    e := es.At(i)
    ... // Do something with the element
}

func (MetricSlice) CopyTo added in v0.59.0

func (es MetricSlice) CopyTo(dest MetricSlice)

CopyTo copies all elements from the current slice overriding the destination.

func (MetricSlice) EnsureCapacity added in v0.59.0

func (es MetricSlice) EnsureCapacity(newCap int)

EnsureCapacity is an operation that ensures the slice has at least the specified capacity. 1. If the newCap <= cap then no change in capacity. 2. If the newCap > cap then the slice capacity will be expanded to equal newCap.

Here is how a new MetricSlice can be initialized:

es := NewMetricSlice()
es.EnsureCapacity(4)
for i := 0; i < 4; i++ {
    e := es.AppendEmpty()
    // Here should set all the values for e.
}

func (MetricSlice) Len added in v0.59.0

func (es MetricSlice) Len() int

Len returns the number of elements in the slice.

Returns "0" for a newly instance created with "NewMetricSlice()".

func (MetricSlice) MoveAndAppendTo added in v0.59.0

func (es MetricSlice) MoveAndAppendTo(dest MetricSlice)

MoveAndAppendTo moves all elements from the current slice and appends them to the dest. The current slice will be cleared.

func (MetricSlice) RemoveIf added in v0.59.0

func (es MetricSlice) RemoveIf(f func(Metric) bool)

RemoveIf calls f sequentially for each element present in the slice. If f returns true, the element is removed from the slice.

func (MetricSlice) Sort added in v0.59.0

func (es MetricSlice) Sort(less func(a, b Metric) bool)

Sort sorts the Metric elements within MetricSlice given the provided less function so that two instances of MetricSlice can be compared.

type MetricType added in v0.61.0

type MetricType int32

MetricType specifies the type of data in a Metric.

const (
	// MetricTypeEmpty means that metric type is unset.
	MetricTypeEmpty MetricType = iota
	MetricTypeGauge
	MetricTypeSum
	MetricTypeHistogram
	MetricTypeExponentialHistogram
	MetricTypeSummary
)

func (MetricType) String added in v0.61.0

func (mdt MetricType) String() string

String returns the string representation of the MetricType.

type Metrics

type Metrics internal.Metrics

Metrics is the top-level struct that is propagated through the metrics pipeline. Use NewMetrics to create new instance, zero-initialized instance is not valid for use.

func NewMetrics

func NewMetrics() Metrics

NewMetrics creates a new Metrics struct.

func (Metrics) CopyTo added in v0.61.0

func (ms Metrics) CopyTo(dest Metrics)

CopyTo copies the Metrics instance overriding the destination.

func (Metrics) DataPointCount added in v0.59.0

func (ms Metrics) DataPointCount() (dataPointCount int)

DataPointCount calculates the total number of data points.

func (Metrics) IsReadOnly added in v1.0.0

func (ms Metrics) IsReadOnly() bool

IsReadOnly returns true if this Metrics instance is read-only.

func (Metrics) MarkReadOnly added in v1.0.0

func (ms Metrics) MarkReadOnly()

MarkReadOnly marks the Metrics as shared so that no further modifications can be done on it.

func (Metrics) MetricCount added in v0.59.0

func (ms Metrics) MetricCount() int

MetricCount calculates the total number of metrics.

func (Metrics) ResourceMetrics added in v0.59.0

func (ms Metrics) ResourceMetrics() ResourceMetricsSlice

ResourceMetrics returns the ResourceMetricsSlice associated with this Metrics.

type NumberDataPoint

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

NumberDataPoint is a single data point in a timeseries that describes the time-varying value of a number metric.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewNumberDataPoint function to create new instances. Important: zero-initialized instance is not valid for use.

func NewNumberDataPoint

func NewNumberDataPoint() NumberDataPoint

NewNumberDataPoint creates a new empty NumberDataPoint.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (NumberDataPoint) Attributes added in v0.59.0

func (ms NumberDataPoint) Attributes() pcommon.Map

Attributes returns the Attributes associated with this NumberDataPoint.

func (NumberDataPoint) CopyTo added in v0.59.0

func (ms NumberDataPoint) CopyTo(dest NumberDataPoint)

CopyTo copies all properties from the current struct overriding the destination.

func (NumberDataPoint) DoubleValue added in v0.61.0

func (ms NumberDataPoint) DoubleValue() float64

DoubleValue returns the double associated with this NumberDataPoint.

func (NumberDataPoint) Exemplars added in v0.59.0

func (ms NumberDataPoint) Exemplars() ExemplarSlice

Exemplars returns the Exemplars associated with this NumberDataPoint.

func (NumberDataPoint) Flags added in v0.59.0

func (ms NumberDataPoint) Flags() DataPointFlags

Flags returns the flags associated with this NumberDataPoint.

func (NumberDataPoint) IntValue added in v0.61.0

func (ms NumberDataPoint) IntValue() int64

IntValue returns the int associated with this NumberDataPoint.

func (NumberDataPoint) MoveTo added in v0.59.0

func (ms NumberDataPoint) MoveTo(dest NumberDataPoint)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (NumberDataPoint) SetDoubleValue added in v0.61.0

func (ms NumberDataPoint) SetDoubleValue(v float64)

SetDoubleValue replaces the double associated with this NumberDataPoint.

func (NumberDataPoint) SetFlags added in v0.60.0

func (ms NumberDataPoint) SetFlags(v DataPointFlags)

SetFlags replaces the flags associated with this NumberDataPoint.

func (NumberDataPoint) SetIntValue added in v0.61.0

func (ms NumberDataPoint) SetIntValue(v int64)

SetIntValue replaces the int associated with this NumberDataPoint.

func (NumberDataPoint) SetStartTimestamp added in v0.59.0

func (ms NumberDataPoint) SetStartTimestamp(v pcommon.Timestamp)

SetStartTimestamp replaces the starttimestamp associated with this NumberDataPoint.

func (NumberDataPoint) SetTimestamp added in v0.59.0

func (ms NumberDataPoint) SetTimestamp(v pcommon.Timestamp)

SetTimestamp replaces the timestamp associated with this NumberDataPoint.

func (NumberDataPoint) StartTimestamp added in v0.59.0

func (ms NumberDataPoint) StartTimestamp() pcommon.Timestamp

StartTimestamp returns the starttimestamp associated with this NumberDataPoint.

func (NumberDataPoint) Timestamp added in v0.59.0

func (ms NumberDataPoint) Timestamp() pcommon.Timestamp

Timestamp returns the timestamp associated with this NumberDataPoint.

func (NumberDataPoint) ValueType added in v0.59.0

ValueType returns the type of the value for this NumberDataPoint. Calling this function on zero-initialized NumberDataPoint will cause a panic.

type NumberDataPointSlice

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

NumberDataPointSlice logically represents a slice of NumberDataPoint.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewNumberDataPointSlice function to create new instances. Important: zero-initialized instance is not valid for use.

func NewNumberDataPointSlice

func NewNumberDataPointSlice() NumberDataPointSlice

NewNumberDataPointSlice creates a NumberDataPointSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

func (NumberDataPointSlice) AppendEmpty added in v0.59.0

func (es NumberDataPointSlice) AppendEmpty() NumberDataPoint

AppendEmpty will append to the end of the slice an empty NumberDataPoint. It returns the newly added NumberDataPoint.

func (NumberDataPointSlice) At added in v0.59.0

At returns the element at the given index.

This function is used mostly for iterating over all the values in the slice:

for i := 0; i < es.Len(); i++ {
    e := es.At(i)
    ... // Do something with the element
}

func (NumberDataPointSlice) CopyTo added in v0.59.0

CopyTo copies all elements from the current slice overriding the destination.

func (NumberDataPointSlice) EnsureCapacity added in v0.59.0

func (es NumberDataPointSlice) EnsureCapacity(newCap int)

EnsureCapacity is an operation that ensures the slice has at least the specified capacity. 1. If the newCap <= cap then no change in capacity. 2. If the newCap > cap then the slice capacity will be expanded to equal newCap.

Here is how a new NumberDataPointSlice can be initialized:

es := NewNumberDataPointSlice()
es.EnsureCapacity(4)
for i := 0; i < 4; i++ {
    e := es.AppendEmpty()
    // Here should set all the values for e.
}

func (NumberDataPointSlice) Len added in v0.59.0

func (es NumberDataPointSlice) Len() int

Len returns the number of elements in the slice.

Returns "0" for a newly instance created with "NewNumberDataPointSlice()".

func (NumberDataPointSlice) MoveAndAppendTo added in v0.59.0

func (es NumberDataPointSlice) MoveAndAppendTo(dest NumberDataPointSlice)

MoveAndAppendTo moves all elements from the current slice and appends them to the dest. The current slice will be cleared.

func (NumberDataPointSlice) RemoveIf added in v0.59.0

func (es NumberDataPointSlice) RemoveIf(f func(NumberDataPoint) bool)

RemoveIf calls f sequentially for each element present in the slice. If f returns true, the element is removed from the slice.

func (NumberDataPointSlice) Sort added in v0.59.0

func (es NumberDataPointSlice) Sort(less func(a, b NumberDataPoint) bool)

Sort sorts the NumberDataPoint elements within NumberDataPointSlice given the provided less function so that two instances of NumberDataPointSlice can be compared.

type NumberDataPointValueType added in v0.50.0

type NumberDataPointValueType int32

NumberDataPointValueType specifies the type of NumberDataPoint value.

const (
	// NumberDataPointValueTypeEmpty means that data point value is unset.
	NumberDataPointValueTypeEmpty NumberDataPointValueType = iota
	NumberDataPointValueTypeInt
	NumberDataPointValueTypeDouble
)

func (NumberDataPointValueType) String added in v0.59.0

func (nt NumberDataPointValueType) String() string

String returns the string representation of the NumberDataPointValueType.

type ProtoMarshaler added in v0.63.0

type ProtoMarshaler struct{}

func (*ProtoMarshaler) MarshalMetrics added in v0.63.0

func (e *ProtoMarshaler) MarshalMetrics(md Metrics) ([]byte, error)

func (*ProtoMarshaler) MetricsSize added in v0.63.0

func (e *ProtoMarshaler) MetricsSize(md Metrics) int

type ProtoUnmarshaler added in v0.63.0

type ProtoUnmarshaler struct{}

func (*ProtoUnmarshaler) UnmarshalMetrics added in v0.63.0

func (d *ProtoUnmarshaler) UnmarshalMetrics(buf []byte) (Metrics, error)

type ResourceMetrics

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

ResourceMetrics is a collection of metrics from a Resource.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewResourceMetrics function to create new instances. Important: zero-initialized instance is not valid for use.

func NewResourceMetrics

func NewResourceMetrics() ResourceMetrics

NewResourceMetrics creates a new empty ResourceMetrics.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (ResourceMetrics) CopyTo added in v0.59.0

func (ms ResourceMetrics) CopyTo(dest ResourceMetrics)

CopyTo copies all properties from the current struct overriding the destination.

func (ResourceMetrics) MoveTo added in v0.59.0

func (ms ResourceMetrics) MoveTo(dest ResourceMetrics)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (ResourceMetrics) Resource added in v0.59.0

func (ms ResourceMetrics) Resource() pcommon.Resource

Resource returns the resource associated with this ResourceMetrics.

func (ResourceMetrics) SchemaUrl added in v0.59.0

func (ms ResourceMetrics) SchemaUrl() string

SchemaUrl returns the schemaurl associated with this ResourceMetrics.

func (ResourceMetrics) ScopeMetrics added in v0.59.0

func (ms ResourceMetrics) ScopeMetrics() ScopeMetricsSlice

ScopeMetrics returns the ScopeMetrics associated with this ResourceMetrics.

func (ResourceMetrics) SetSchemaUrl added in v0.59.0

func (ms ResourceMetrics) SetSchemaUrl(v string)

SetSchemaUrl replaces the schemaurl associated with this ResourceMetrics.

type ResourceMetricsSlice

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

ResourceMetricsSlice logically represents a slice of ResourceMetrics.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewResourceMetricsSlice function to create new instances. Important: zero-initialized instance is not valid for use.

func NewResourceMetricsSlice

func NewResourceMetricsSlice() ResourceMetricsSlice

NewResourceMetricsSlice creates a ResourceMetricsSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

func (ResourceMetricsSlice) AppendEmpty added in v0.59.0

func (es ResourceMetricsSlice) AppendEmpty() ResourceMetrics

AppendEmpty will append to the end of the slice an empty ResourceMetrics. It returns the newly added ResourceMetrics.

func (ResourceMetricsSlice) At added in v0.59.0

At returns the element at the given index.

This function is used mostly for iterating over all the values in the slice:

for i := 0; i < es.Len(); i++ {
    e := es.At(i)
    ... // Do something with the element
}

func (ResourceMetricsSlice) CopyTo added in v0.59.0

CopyTo copies all elements from the current slice overriding the destination.

func (ResourceMetricsSlice) EnsureCapacity added in v0.59.0

func (es ResourceMetricsSlice) EnsureCapacity(newCap int)

EnsureCapacity is an operation that ensures the slice has at least the specified capacity. 1. If the newCap <= cap then no change in capacity. 2. If the newCap > cap then the slice capacity will be expanded to equal newCap.

Here is how a new ResourceMetricsSlice can be initialized:

es := NewResourceMetricsSlice()
es.EnsureCapacity(4)
for i := 0; i < 4; i++ {
    e := es.AppendEmpty()
    // Here should set all the values for e.
}

func (ResourceMetricsSlice) Len added in v0.59.0

func (es ResourceMetricsSlice) Len() int

Len returns the number of elements in the slice.

Returns "0" for a newly instance created with "NewResourceMetricsSlice()".

func (ResourceMetricsSlice) MoveAndAppendTo added in v0.59.0

func (es ResourceMetricsSlice) MoveAndAppendTo(dest ResourceMetricsSlice)

MoveAndAppendTo moves all elements from the current slice and appends them to the dest. The current slice will be cleared.

func (ResourceMetricsSlice) RemoveIf added in v0.59.0

func (es ResourceMetricsSlice) RemoveIf(f func(ResourceMetrics) bool)

RemoveIf calls f sequentially for each element present in the slice. If f returns true, the element is removed from the slice.

func (ResourceMetricsSlice) Sort added in v0.59.0

func (es ResourceMetricsSlice) Sort(less func(a, b ResourceMetrics) bool)

Sort sorts the ResourceMetrics elements within ResourceMetricsSlice given the provided less function so that two instances of ResourceMetricsSlice can be compared.

type ScopeMetrics

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

ScopeMetrics is a collection of metrics from a LibraryInstrumentation.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewScopeMetrics function to create new instances. Important: zero-initialized instance is not valid for use.

func NewScopeMetrics

func NewScopeMetrics() ScopeMetrics

NewScopeMetrics creates a new empty ScopeMetrics.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (ScopeMetrics) CopyTo added in v0.59.0

func (ms ScopeMetrics) CopyTo(dest ScopeMetrics)

CopyTo copies all properties from the current struct overriding the destination.

func (ScopeMetrics) Metrics added in v0.59.0

func (ms ScopeMetrics) Metrics() MetricSlice

Metrics returns the Metrics associated with this ScopeMetrics.

func (ScopeMetrics) MoveTo added in v0.59.0

func (ms ScopeMetrics) MoveTo(dest ScopeMetrics)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (ScopeMetrics) SchemaUrl added in v0.59.0

func (ms ScopeMetrics) SchemaUrl() string

SchemaUrl returns the schemaurl associated with this ScopeMetrics.

func (ScopeMetrics) Scope added in v0.59.0

Scope returns the scope associated with this ScopeMetrics.

func (ScopeMetrics) SetSchemaUrl added in v0.59.0

func (ms ScopeMetrics) SetSchemaUrl(v string)

SetSchemaUrl replaces the schemaurl associated with this ScopeMetrics.

type ScopeMetricsSlice

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

ScopeMetricsSlice logically represents a slice of ScopeMetrics.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewScopeMetricsSlice function to create new instances. Important: zero-initialized instance is not valid for use.

func NewScopeMetricsSlice

func NewScopeMetricsSlice() ScopeMetricsSlice

NewScopeMetricsSlice creates a ScopeMetricsSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

func (ScopeMetricsSlice) AppendEmpty added in v0.59.0

func (es ScopeMetricsSlice) AppendEmpty() ScopeMetrics

AppendEmpty will append to the end of the slice an empty ScopeMetrics. It returns the newly added ScopeMetrics.

func (ScopeMetricsSlice) At added in v0.59.0

At returns the element at the given index.

This function is used mostly for iterating over all the values in the slice:

for i := 0; i < es.Len(); i++ {
    e := es.At(i)
    ... // Do something with the element
}

func (ScopeMetricsSlice) CopyTo added in v0.59.0

func (es ScopeMetricsSlice) CopyTo(dest ScopeMetricsSlice)

CopyTo copies all elements from the current slice overriding the destination.

func (ScopeMetricsSlice) EnsureCapacity added in v0.59.0

func (es ScopeMetricsSlice) EnsureCapacity(newCap int)

EnsureCapacity is an operation that ensures the slice has at least the specified capacity. 1. If the newCap <= cap then no change in capacity. 2. If the newCap > cap then the slice capacity will be expanded to equal newCap.

Here is how a new ScopeMetricsSlice can be initialized:

es := NewScopeMetricsSlice()
es.EnsureCapacity(4)
for i := 0; i < 4; i++ {
    e := es.AppendEmpty()
    // Here should set all the values for e.
}

func (ScopeMetricsSlice) Len added in v0.59.0

func (es ScopeMetricsSlice) Len() int

Len returns the number of elements in the slice.

Returns "0" for a newly instance created with "NewScopeMetricsSlice()".

func (ScopeMetricsSlice) MoveAndAppendTo added in v0.59.0

func (es ScopeMetricsSlice) MoveAndAppendTo(dest ScopeMetricsSlice)

MoveAndAppendTo moves all elements from the current slice and appends them to the dest. The current slice will be cleared.

func (ScopeMetricsSlice) RemoveIf added in v0.59.0

func (es ScopeMetricsSlice) RemoveIf(f func(ScopeMetrics) bool)

RemoveIf calls f sequentially for each element present in the slice. If f returns true, the element is removed from the slice.

func (ScopeMetricsSlice) Sort added in v0.59.0

func (es ScopeMetricsSlice) Sort(less func(a, b ScopeMetrics) bool)

Sort sorts the ScopeMetrics elements within ScopeMetricsSlice given the provided less function so that two instances of ScopeMetricsSlice can be compared.

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 struct {
	// contains filtered or unexported fields
}

Sum represents the type of a numeric metric that is calculated as a sum of all reported measurements over a time interval.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewSum function to create new instances. Important: zero-initialized instance is not valid for use.

func NewSum

func NewSum() Sum

NewSum creates a new empty Sum.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (Sum) AggregationTemporality added in v0.59.0

func (ms Sum) AggregationTemporality() AggregationTemporality

AggregationTemporality returns the aggregationtemporality associated with this Sum.

func (Sum) CopyTo added in v0.59.0

func (ms Sum) CopyTo(dest Sum)

CopyTo copies all properties from the current struct overriding the destination.

func (Sum) DataPoints added in v0.59.0

func (ms Sum) DataPoints() NumberDataPointSlice

DataPoints returns the DataPoints associated with this Sum.

func (Sum) IsMonotonic added in v0.59.0

func (ms Sum) IsMonotonic() bool

IsMonotonic returns the ismonotonic associated with this Sum.

func (Sum) MoveTo added in v0.59.0

func (ms Sum) MoveTo(dest Sum)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (Sum) SetAggregationTemporality added in v0.59.0

func (ms Sum) SetAggregationTemporality(v AggregationTemporality)

SetAggregationTemporality replaces the aggregationtemporality associated with this Sum.

func (Sum) SetIsMonotonic added in v0.59.0

func (ms Sum) SetIsMonotonic(v bool)

SetIsMonotonic replaces the ismonotonic associated with this Sum.

type Summary

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

Summary represents the type of a metric that is calculated by aggregating as a Summary of all reported double measurements over a time interval.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewSummary function to create new instances. Important: zero-initialized instance is not valid for use.

func NewSummary

func NewSummary() Summary

NewSummary creates a new empty Summary.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (Summary) CopyTo added in v0.59.0

func (ms Summary) CopyTo(dest Summary)

CopyTo copies all properties from the current struct overriding the destination.

func (Summary) DataPoints added in v0.59.0

func (ms Summary) DataPoints() SummaryDataPointSlice

DataPoints returns the DataPoints associated with this Summary.

func (Summary) MoveTo added in v0.59.0

func (ms Summary) MoveTo(dest Summary)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

type SummaryDataPoint

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

SummaryDataPoint is a single data point in a timeseries that describes the time-varying values of a Summary of double values.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewSummaryDataPoint function to create new instances. Important: zero-initialized instance is not valid for use.

func NewSummaryDataPoint

func NewSummaryDataPoint() SummaryDataPoint

NewSummaryDataPoint creates a new empty SummaryDataPoint.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (SummaryDataPoint) Attributes added in v0.59.0

func (ms SummaryDataPoint) Attributes() pcommon.Map

Attributes returns the Attributes associated with this SummaryDataPoint.

func (SummaryDataPoint) CopyTo added in v0.59.0

func (ms SummaryDataPoint) CopyTo(dest SummaryDataPoint)

CopyTo copies all properties from the current struct overriding the destination.

func (SummaryDataPoint) Count added in v0.59.0

func (ms SummaryDataPoint) Count() uint64

Count returns the count associated with this SummaryDataPoint.

func (SummaryDataPoint) Flags added in v0.59.0

func (ms SummaryDataPoint) Flags() DataPointFlags

Flags returns the flags associated with this SummaryDataPoint.

func (SummaryDataPoint) MoveTo added in v0.59.0

func (ms SummaryDataPoint) MoveTo(dest SummaryDataPoint)

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (SummaryDataPoint) QuantileValues added in v0.59.0

QuantileValues returns the QuantileValues associated with this SummaryDataPoint.

func (SummaryDataPoint) SetCount added in v0.59.0

func (ms SummaryDataPoint) SetCount(v uint64)

SetCount replaces the count associated with this SummaryDataPoint.

func (SummaryDataPoint) SetFlags added in v0.60.0

func (ms SummaryDataPoint) SetFlags(v DataPointFlags)

SetFlags replaces the flags associated with this SummaryDataPoint.

func (SummaryDataPoint) SetStartTimestamp added in v0.59.0

func (ms SummaryDataPoint) SetStartTimestamp(v pcommon.Timestamp)

SetStartTimestamp replaces the starttimestamp associated with this SummaryDataPoint.

func (SummaryDataPoint) SetSum added in v0.59.0

func (ms SummaryDataPoint) SetSum(v float64)

SetSum replaces the sum associated with this SummaryDataPoint.

func (SummaryDataPoint) SetTimestamp added in v0.59.0

func (ms SummaryDataPoint) SetTimestamp(v pcommon.Timestamp)

SetTimestamp replaces the timestamp associated with this SummaryDataPoint.

func (SummaryDataPoint) StartTimestamp added in v0.59.0

func (ms SummaryDataPoint) StartTimestamp() pcommon.Timestamp

StartTimestamp returns the starttimestamp associated with this SummaryDataPoint.

func (SummaryDataPoint) Sum added in v0.59.0

func (ms SummaryDataPoint) Sum() float64

Sum returns the sum associated with this SummaryDataPoint.

func (SummaryDataPoint) Timestamp added in v0.59.0

func (ms SummaryDataPoint) Timestamp() pcommon.Timestamp

Timestamp returns the timestamp associated with this SummaryDataPoint.

type SummaryDataPointSlice

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

SummaryDataPointSlice logically represents a slice of SummaryDataPoint.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewSummaryDataPointSlice function to create new instances. Important: zero-initialized instance is not valid for use.

func NewSummaryDataPointSlice

func NewSummaryDataPointSlice() SummaryDataPointSlice

NewSummaryDataPointSlice creates a SummaryDataPointSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

func (SummaryDataPointSlice) AppendEmpty added in v0.59.0

func (es SummaryDataPointSlice) AppendEmpty() SummaryDataPoint

AppendEmpty will append to the end of the slice an empty SummaryDataPoint. It returns the newly added SummaryDataPoint.

func (SummaryDataPointSlice) At added in v0.59.0

At returns the element at the given index.

This function is used mostly for iterating over all the values in the slice:

for i := 0; i < es.Len(); i++ {
    e := es.At(i)
    ... // Do something with the element
}

func (SummaryDataPointSlice) CopyTo added in v0.59.0

CopyTo copies all elements from the current slice overriding the destination.

func (SummaryDataPointSlice) EnsureCapacity added in v0.59.0

func (es SummaryDataPointSlice) EnsureCapacity(newCap int)

EnsureCapacity is an operation that ensures the slice has at least the specified capacity. 1. If the newCap <= cap then no change in capacity. 2. If the newCap > cap then the slice capacity will be expanded to equal newCap.

Here is how a new SummaryDataPointSlice can be initialized:

es := NewSummaryDataPointSlice()
es.EnsureCapacity(4)
for i := 0; i < 4; i++ {
    e := es.AppendEmpty()
    // Here should set all the values for e.
}

func (SummaryDataPointSlice) Len added in v0.59.0

func (es SummaryDataPointSlice) Len() int

Len returns the number of elements in the slice.

Returns "0" for a newly instance created with "NewSummaryDataPointSlice()".

func (SummaryDataPointSlice) MoveAndAppendTo added in v0.59.0

func (es SummaryDataPointSlice) MoveAndAppendTo(dest SummaryDataPointSlice)

MoveAndAppendTo moves all elements from the current slice and appends them to the dest. The current slice will be cleared.

func (SummaryDataPointSlice) RemoveIf added in v0.59.0

func (es SummaryDataPointSlice) RemoveIf(f func(SummaryDataPoint) bool)

RemoveIf calls f sequentially for each element present in the slice. If f returns true, the element is removed from the slice.

func (SummaryDataPointSlice) Sort added in v0.59.0

func (es SummaryDataPointSlice) Sort(less func(a, b SummaryDataPoint) bool)

Sort sorts the SummaryDataPoint elements within SummaryDataPointSlice given the provided less function so that two instances of SummaryDataPointSlice can be compared.

type SummaryDataPointValueAtQuantile added in v0.62.0

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

SummaryDataPointValueAtQuantile is a quantile value within a Summary data point.

This is a reference type, if passed by value and callee modifies it the caller will see the modification.

Must use NewSummaryDataPointValueAtQuantile function to create new instances. Important: zero-initialized instance is not valid for use.

func NewSummaryDataPointValueAtQuantile added in v0.62.0

func NewSummaryDataPointValueAtQuantile() SummaryDataPointValueAtQuantile

NewSummaryDataPointValueAtQuantile creates a new empty SummaryDataPointValueAtQuantile.

This must be used only in testing code. Users should use "AppendEmpty" when part of a Slice, OR directly access the member if this is embedded in another struct.

func (SummaryDataPointValueAtQuantile) CopyTo added in v0.62.0

CopyTo copies all properties from the current struct overriding the destination.

func (SummaryDataPointValueAtQuantile) MoveTo added in v0.62.0

MoveTo moves all properties from the current struct overriding the destination and resetting the current instance to its zero value

func (SummaryDataPointValueAtQuantile) Quantile added in v0.62.0

Quantile returns the quantile associated with this SummaryDataPointValueAtQuantile.

func (SummaryDataPointValueAtQuantile) SetQuantile added in v0.62.0

func (ms SummaryDataPointValueAtQuantile) SetQuantile(v float64)

SetQuantile replaces the quantile associated with this SummaryDataPointValueAtQuantile.

func (SummaryDataPointValueAtQuantile) SetValue added in v0.62.0

SetValue replaces the value associated with this SummaryDataPointValueAtQuantile.

func (SummaryDataPointValueAtQuantile) Value added in v0.62.0

Value returns the value associated with this SummaryDataPointValueAtQuantile.

type SummaryDataPointValueAtQuantileSlice added in v0.62.0

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

SummaryDataPointValueAtQuantileSlice logically represents a slice of SummaryDataPointValueAtQuantile.

This is a reference type. If passed by value and callee modifies it, the caller will see the modification.

Must use NewSummaryDataPointValueAtQuantileSlice function to create new instances. Important: zero-initialized instance is not valid for use.

func NewSummaryDataPointValueAtQuantileSlice added in v0.62.0

func NewSummaryDataPointValueAtQuantileSlice() SummaryDataPointValueAtQuantileSlice

NewSummaryDataPointValueAtQuantileSlice creates a SummaryDataPointValueAtQuantileSlice with 0 elements. Can use "EnsureCapacity" to initialize with a given capacity.

func (SummaryDataPointValueAtQuantileSlice) AppendEmpty added in v0.62.0

AppendEmpty will append to the end of the slice an empty SummaryDataPointValueAtQuantile. It returns the newly added SummaryDataPointValueAtQuantile.

func (SummaryDataPointValueAtQuantileSlice) At added in v0.62.0

At returns the element at the given index.

This function is used mostly for iterating over all the values in the slice:

for i := 0; i < es.Len(); i++ {
    e := es.At(i)
    ... // Do something with the element
}

func (SummaryDataPointValueAtQuantileSlice) CopyTo added in v0.62.0

CopyTo copies all elements from the current slice overriding the destination.

func (SummaryDataPointValueAtQuantileSlice) EnsureCapacity added in v0.62.0

func (es SummaryDataPointValueAtQuantileSlice) EnsureCapacity(newCap int)

EnsureCapacity is an operation that ensures the slice has at least the specified capacity. 1. If the newCap <= cap then no change in capacity. 2. If the newCap > cap then the slice capacity will be expanded to equal newCap.

Here is how a new SummaryDataPointValueAtQuantileSlice can be initialized:

es := NewSummaryDataPointValueAtQuantileSlice()
es.EnsureCapacity(4)
for i := 0; i < 4; i++ {
    e := es.AppendEmpty()
    // Here should set all the values for e.
}

func (SummaryDataPointValueAtQuantileSlice) Len added in v0.62.0

Len returns the number of elements in the slice.

Returns "0" for a newly instance created with "NewSummaryDataPointValueAtQuantileSlice()".

func (SummaryDataPointValueAtQuantileSlice) MoveAndAppendTo added in v0.62.0

MoveAndAppendTo moves all elements from the current slice and appends them to the dest. The current slice will be cleared.

func (SummaryDataPointValueAtQuantileSlice) RemoveIf added in v0.62.0

RemoveIf calls f sequentially for each element present in the slice. If f returns true, the element is removed from the slice.

func (SummaryDataPointValueAtQuantileSlice) Sort added in v0.62.0

Sort sorts the SummaryDataPointValueAtQuantile elements within SummaryDataPointValueAtQuantileSlice given the provided less function so that two instances of SummaryDataPointValueAtQuantileSlice can be compared.

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.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL