OpenTelemetry PHP

ExponentialHistogramDataPoint extends Message
in package

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.

Generated from protobuf message opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint

Table of Contents

Properties

$count  : mixed
count is the number of values in the population. Must be non-negative. This value must be equal to the sum of the "bucket_counts" values in the positive and negative Buckets plus the "zero_count" field.
$flags  : mixed
Flags that apply to this specific data point. See DataPointFlags for the available flags and their meaning.
$max  : mixed
max is the maximum value over (start_time, end_time].
$min  : mixed
min is the minimum value over (start_time, end_time].
$negative  : mixed
negative carries the negative range of exponential bucket counts.
$positive  : mixed
positive carries the positive range of exponential bucket counts.
$scale  : mixed
scale describes the resolution of the histogram. Boundaries are located at powers of the base, where: base = (2^(2^-scale)) The histogram bucket identified by `index`, a signed integer, contains values that are greater than (base^index) and less than or equal to (base^(index+1)).
$start_time_unix_nano  : mixed
StartTimeUnixNano is optional but strongly encouraged, see the the detailed comments above Metric.
$sum  : mixed
sum of the values in the population. If count is zero then this field must be zero.
$time_unix_nano  : mixed
TimeUnixNano is required, see the detailed comments above Metric.
$zero_count  : mixed
zero_count is the count of values that are either exactly zero or within the region considered zero by the instrumentation at the tolerated degree of precision. This bucket stores values that cannot be expressed using the standard exponential formula as well as values that have been rounded to zero.
$zero_threshold  : mixed
ZeroThreshold may be optionally set to convey the width of the zero region. Where the zero region is defined as the closed interval [-ZeroThreshold, ZeroThreshold].
$attributes  : mixed
The set of key/value pairs that uniquely identify the timeseries from where this point belongs. The list may be empty (may contain 0 elements).
$exemplars  : mixed
(Optional) List of exemplars collected from measurements that were used to form the data point

Methods

__construct()  : mixed
Constructor.
clearMax()  : mixed
clearMin()  : mixed
clearNegative()  : mixed
clearPositive()  : mixed
clearSum()  : mixed
getAttributes()  : RepeatedField
The set of key/value pairs that uniquely identify the timeseries from where this point belongs. The list may be empty (may contain 0 elements).
getCount()  : int|string
count is the number of values in the population. Must be non-negative. This value must be equal to the sum of the "bucket_counts" values in the positive and negative Buckets plus the "zero_count" field.
getExemplars()  : RepeatedField
(Optional) List of exemplars collected from measurements that were used to form the data point
getFlags()  : int
Flags that apply to this specific data point. See DataPointFlags for the available flags and their meaning.
getMax()  : float
max is the maximum value over (start_time, end_time].
getMin()  : float
min is the minimum value over (start_time, end_time].
getNegative()  : Buckets|null
negative carries the negative range of exponential bucket counts.
getPositive()  : Buckets|null
positive carries the positive range of exponential bucket counts.
getScale()  : int
scale describes the resolution of the histogram. Boundaries are located at powers of the base, where: base = (2^(2^-scale)) The histogram bucket identified by `index`, a signed integer, contains values that are greater than (base^index) and less than or equal to (base^(index+1)).
getStartTimeUnixNano()  : int|string
StartTimeUnixNano is optional but strongly encouraged, see the the detailed comments above Metric.
getSum()  : float
sum of the values in the population. If count is zero then this field must be zero.
getTimeUnixNano()  : int|string
TimeUnixNano is required, see the detailed comments above Metric.
getZeroCount()  : int|string
zero_count is the count of values that are either exactly zero or within the region considered zero by the instrumentation at the tolerated degree of precision. This bucket stores values that cannot be expressed using the standard exponential formula as well as values that have been rounded to zero.
getZeroThreshold()  : float
ZeroThreshold may be optionally set to convey the width of the zero region. Where the zero region is defined as the closed interval [-ZeroThreshold, ZeroThreshold].
hasMax()  : mixed
hasMin()  : mixed
hasNegative()  : mixed
hasPositive()  : mixed
hasSum()  : mixed
setAttributes()  : $this
The set of key/value pairs that uniquely identify the timeseries from where this point belongs. The list may be empty (may contain 0 elements).
setCount()  : $this
count is the number of values in the population. Must be non-negative. This value must be equal to the sum of the "bucket_counts" values in the positive and negative Buckets plus the "zero_count" field.
setExemplars()  : $this
(Optional) List of exemplars collected from measurements that were used to form the data point
setFlags()  : $this
Flags that apply to this specific data point. See DataPointFlags for the available flags and their meaning.
setMax()  : $this
max is the maximum value over (start_time, end_time].
setMin()  : $this
min is the minimum value over (start_time, end_time].
setNegative()  : $this
negative carries the negative range of exponential bucket counts.
setPositive()  : $this
positive carries the positive range of exponential bucket counts.
setScale()  : $this
scale describes the resolution of the histogram. Boundaries are located at powers of the base, where: base = (2^(2^-scale)) The histogram bucket identified by `index`, a signed integer, contains values that are greater than (base^index) and less than or equal to (base^(index+1)).
setStartTimeUnixNano()  : $this
StartTimeUnixNano is optional but strongly encouraged, see the the detailed comments above Metric.
setSum()  : $this
sum of the values in the population. If count is zero then this field must be zero.
setTimeUnixNano()  : $this
TimeUnixNano is required, see the detailed comments above Metric.
setZeroCount()  : $this
zero_count is the count of values that are either exactly zero or within the region considered zero by the instrumentation at the tolerated degree of precision. This bucket stores values that cannot be expressed using the standard exponential formula as well as values that have been rounded to zero.
setZeroThreshold()  : $this
ZeroThreshold may be optionally set to convey the width of the zero region. Where the zero region is defined as the closed interval [-ZeroThreshold, ZeroThreshold].

Properties

$count

count is the number of values in the population. Must be non-negative. This value must be equal to the sum of the "bucket_counts" values in the positive and negative Buckets plus the "zero_count" field.

protected mixed $count = 0

Generated from protobuf field fixed64 count = 4;

$flags

Flags that apply to this specific data point. See DataPointFlags for the available flags and their meaning.

protected mixed $flags = 0

Generated from protobuf field uint32 flags = 10;

$max

max is the maximum value over (start_time, end_time].

protected mixed $max = null

Generated from protobuf field optional double max = 13;

$min

min is the minimum value over (start_time, end_time].

protected mixed $min = null

Generated from protobuf field optional double min = 12;

$negative

negative carries the negative range of exponential bucket counts.

protected mixed $negative = null

Generated from protobuf field .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets negative = 9;

$positive

positive carries the positive range of exponential bucket counts.

protected mixed $positive = null

Generated from protobuf field .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets positive = 8;

$scale

scale describes the resolution of the histogram. Boundaries are located at powers of the base, where: base = (2^(2^-scale)) The histogram bucket identified by `index`, a signed integer, contains values that are greater than (base^index) and less than or equal to (base^(index+1)).

protected mixed $scale = 0

The positive and negative ranges of the histogram are expressed separately. Negative values are mapped by their absolute value into the negative range using the same scale as the positive range. scale is not restricted by the protocol, as the permissible values depend on the range of the data.

Generated from protobuf field sint32 scale = 6;

$start_time_unix_nano

StartTimeUnixNano is optional but strongly encouraged, see the the detailed comments above Metric.

protected mixed $start_time_unix_nano = 0

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

Generated from protobuf field fixed64 start_time_unix_nano = 2;

$sum

sum of the values in the population. If count is zero then this field must be zero.

protected mixed $sum = null

Note: Sum should only be filled out when measuring non-negative discrete events, and is assumed to be monotonic over the values of these events. Negative events can be recorded, but sum should not be filled out when doing so. This is specifically to enforce compatibility w/ OpenMetrics, see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram

Generated from protobuf field optional double sum = 5;

$time_unix_nano

TimeUnixNano is required, see the detailed comments above Metric.

protected mixed $time_unix_nano = 0

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

Generated from protobuf field fixed64 time_unix_nano = 3;

$zero_count

zero_count is the count of values that are either exactly zero or within the region considered zero by the instrumentation at the tolerated degree of precision. This bucket stores values that cannot be expressed using the standard exponential formula as well as values that have been rounded to zero.

protected mixed $zero_count = 0

Implementations MAY consider the zero bucket to have probability mass equal to (zero_count / count).

Generated from protobuf field fixed64 zero_count = 7;

$zero_threshold

ZeroThreshold may be optionally set to convey the width of the zero region. Where the zero region is defined as the closed interval [-ZeroThreshold, ZeroThreshold].

protected mixed $zero_threshold = 0.0

When ZeroThreshold is 0, zero count bucket stores values that cannot be expressed using the standard exponential formula as well as values that have been rounded to zero.

Generated from protobuf field double zero_threshold = 14;

$attributes

The set of key/value pairs that uniquely identify the timeseries from where this point belongs. The list may be empty (may contain 0 elements).

private mixed $attributes

Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).

Generated from protobuf field repeated .opentelemetry.proto.common.v1.KeyValue attributes = 1;

$exemplars

(Optional) List of exemplars collected from measurements that were used to form the data point

private mixed $exemplars

Generated from protobuf field repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 11;

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type \Opentelemetry\Proto\Common\V1\KeyValue[]|\Google\Protobuf\Internal\RepeatedField $attributes
      The set of key/value pairs that uniquely identify the timeseries from
      where this point belongs. The list may be empty (may contain 0 elements).
      Attribute keys MUST be unique (it is not allowed to have more than one
      attribute with the same key).
@type int|string $start_time_unix_nano
      StartTimeUnixNano is optional but strongly encouraged, see the
      the detailed comments above Metric.
      Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
      1970.
@type int|string $time_unix_nano
      TimeUnixNano is required, see the detailed comments above Metric.
      Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
      1970.
@type int|string $count
      count is the number of values in the population. Must be
      non-negative. This value must be equal to the sum of the "bucket_counts"
      values in the positive and negative Buckets plus the "zero_count" field.
@type float $sum
      sum of the values in the population. If count is zero then this field
      must be zero.
      Note: Sum should only be filled out when measuring non-negative discrete
      events, and is assumed to be monotonic over the values of these events.
      Negative events *can* be recorded, but sum should not be filled out when
      doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
      see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram
@type int $scale
      scale describes the resolution of the histogram.  Boundaries are
      located at powers of the base, where:
        base = (2^(2^-scale))
      The histogram bucket identified by `index`, a signed integer,
      contains values that are greater than (base^index) and
      less than or equal to (base^(index+1)).
      The positive and negative ranges of the histogram are expressed
      separately.  Negative values are mapped by their absolute value
      into the negative range using the same scale as the positive range.
      scale is not restricted by the protocol, as the permissible
      values depend on the range of the data.
@type int|string $zero_count
      zero_count is the count of values that are either exactly zero or
      within the region considered zero by the instrumentation at the
      tolerated degree of precision.  This bucket stores values that
      cannot be expressed using the standard exponential formula as
      well as values that have been rounded to zero.
      Implementations MAY consider the zero bucket to have probability
      mass equal to (zero_count / count).
@type \Opentelemetry\Proto\Metrics\V1\ExponentialHistogramDataPoint\Buckets $positive
      positive carries the positive range of exponential bucket counts.
@type \Opentelemetry\Proto\Metrics\V1\ExponentialHistogramDataPoint\Buckets $negative
      negative carries the negative range of exponential bucket counts.
@type int $flags
      Flags that apply to this specific data point.  See DataPointFlags
      for the available flags and their meaning.
@type \Opentelemetry\Proto\Metrics\V1\Exemplar[]|\Google\Protobuf\Internal\RepeatedField $exemplars
      (Optional) List of exemplars collected from
      measurements that were used to form the data point
@type float $min
      min is the minimum value over (start_time, end_time].
@type float $max
      max is the maximum value over (start_time, end_time].
@type float $zero_threshold
      ZeroThreshold may be optionally set to convey the width of the zero
      region. Where the zero region is defined as the closed interval
      [-ZeroThreshold, ZeroThreshold].
      When ZeroThreshold is 0, zero count bucket stores values that cannot be
      expressed using the standard exponential formula as well as values that
      have been rounded to zero.

}

getAttributes()

The set of key/value pairs that uniquely identify the timeseries from where this point belongs. The list may be empty (may contain 0 elements).

public getAttributes() : RepeatedField

Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).

Generated from protobuf field repeated .opentelemetry.proto.common.v1.KeyValue attributes = 1;

Return values
RepeatedField

getCount()

count is the number of values in the population. Must be non-negative. This value must be equal to the sum of the "bucket_counts" values in the positive and negative Buckets plus the "zero_count" field.

public getCount() : int|string

Generated from protobuf field fixed64 count = 4;

Return values
int|string

getExemplars()

(Optional) List of exemplars collected from measurements that were used to form the data point

public getExemplars() : RepeatedField

Generated from protobuf field repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 11;

Return values
RepeatedField

getFlags()

Flags that apply to this specific data point. See DataPointFlags for the available flags and their meaning.

public getFlags() : int

Generated from protobuf field uint32 flags = 10;

Return values
int

getMax()

max is the maximum value over (start_time, end_time].

public getMax() : float

Generated from protobuf field optional double max = 13;

Return values
float

getMin()

min is the minimum value over (start_time, end_time].

public getMin() : float

Generated from protobuf field optional double min = 12;

Return values
float

getNegative()

negative carries the negative range of exponential bucket counts.

public getNegative() : Buckets|null

Generated from protobuf field .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets negative = 9;

Return values
Buckets|null

getPositive()

positive carries the positive range of exponential bucket counts.

public getPositive() : Buckets|null

Generated from protobuf field .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets positive = 8;

Return values
Buckets|null

getScale()

scale describes the resolution of the histogram. Boundaries are located at powers of the base, where: base = (2^(2^-scale)) The histogram bucket identified by `index`, a signed integer, contains values that are greater than (base^index) and less than or equal to (base^(index+1)).

public getScale() : int

The positive and negative ranges of the histogram are expressed separately. Negative values are mapped by their absolute value into the negative range using the same scale as the positive range. scale is not restricted by the protocol, as the permissible values depend on the range of the data.

Generated from protobuf field sint32 scale = 6;

Return values
int

getStartTimeUnixNano()

StartTimeUnixNano is optional but strongly encouraged, see the the detailed comments above Metric.

public getStartTimeUnixNano() : int|string

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

Generated from protobuf field fixed64 start_time_unix_nano = 2;

Return values
int|string

getSum()

sum of the values in the population. If count is zero then this field must be zero.

public getSum() : float

Note: Sum should only be filled out when measuring non-negative discrete events, and is assumed to be monotonic over the values of these events. Negative events can be recorded, but sum should not be filled out when doing so. This is specifically to enforce compatibility w/ OpenMetrics, see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram

Generated from protobuf field optional double sum = 5;

Return values
float

getTimeUnixNano()

TimeUnixNano is required, see the detailed comments above Metric.

public getTimeUnixNano() : int|string

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

Generated from protobuf field fixed64 time_unix_nano = 3;

Return values
int|string

getZeroCount()

zero_count is the count of values that are either exactly zero or within the region considered zero by the instrumentation at the tolerated degree of precision. This bucket stores values that cannot be expressed using the standard exponential formula as well as values that have been rounded to zero.

public getZeroCount() : int|string

Implementations MAY consider the zero bucket to have probability mass equal to (zero_count / count).

Generated from protobuf field fixed64 zero_count = 7;

Return values
int|string

getZeroThreshold()

ZeroThreshold may be optionally set to convey the width of the zero region. Where the zero region is defined as the closed interval [-ZeroThreshold, ZeroThreshold].

public getZeroThreshold() : float

When ZeroThreshold is 0, zero count bucket stores values that cannot be expressed using the standard exponential formula as well as values that have been rounded to zero.

Generated from protobuf field double zero_threshold = 14;

Return values
float

setAttributes()

The set of key/value pairs that uniquely identify the timeseries from where this point belongs. The list may be empty (may contain 0 elements).

public setAttributes(array<string|int, KeyValue>|RepeatedField $var) : $this

Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).

Generated from protobuf field repeated .opentelemetry.proto.common.v1.KeyValue attributes = 1;

Parameters
$var : array<string|int, KeyValue>|RepeatedField
Return values
$this

setCount()

count is the number of values in the population. Must be non-negative. This value must be equal to the sum of the "bucket_counts" values in the positive and negative Buckets plus the "zero_count" field.

public setCount(int|string $var) : $this

Generated from protobuf field fixed64 count = 4;

Parameters
$var : int|string
Return values
$this

setExemplars()

(Optional) List of exemplars collected from measurements that were used to form the data point

public setExemplars(array<string|int, Exemplar>|RepeatedField $var) : $this

Generated from protobuf field repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 11;

Parameters
$var : array<string|int, Exemplar>|RepeatedField
Return values
$this

setFlags()

Flags that apply to this specific data point. See DataPointFlags for the available flags and their meaning.

public setFlags(int $var) : $this

Generated from protobuf field uint32 flags = 10;

Parameters
$var : int
Return values
$this

setMax()

max is the maximum value over (start_time, end_time].

public setMax(float $var) : $this

Generated from protobuf field optional double max = 13;

Parameters
$var : float
Return values
$this

setMin()

min is the minimum value over (start_time, end_time].

public setMin(float $var) : $this

Generated from protobuf field optional double min = 12;

Parameters
$var : float
Return values
$this

setNegative()

negative carries the negative range of exponential bucket counts.

public setNegative(Buckets $var) : $this

Generated from protobuf field .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets negative = 9;

Parameters
$var : Buckets
Return values
$this

setPositive()

positive carries the positive range of exponential bucket counts.

public setPositive(Buckets $var) : $this

Generated from protobuf field .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets positive = 8;

Parameters
$var : Buckets
Return values
$this

setScale()

scale describes the resolution of the histogram. Boundaries are located at powers of the base, where: base = (2^(2^-scale)) The histogram bucket identified by `index`, a signed integer, contains values that are greater than (base^index) and less than or equal to (base^(index+1)).

public setScale(int $var) : $this

The positive and negative ranges of the histogram are expressed separately. Negative values are mapped by their absolute value into the negative range using the same scale as the positive range. scale is not restricted by the protocol, as the permissible values depend on the range of the data.

Generated from protobuf field sint32 scale = 6;

Parameters
$var : int
Return values
$this

setStartTimeUnixNano()

StartTimeUnixNano is optional but strongly encouraged, see the the detailed comments above Metric.

public setStartTimeUnixNano(int|string $var) : $this

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

Generated from protobuf field fixed64 start_time_unix_nano = 2;

Parameters
$var : int|string
Return values
$this

setSum()

sum of the values in the population. If count is zero then this field must be zero.

public setSum(float $var) : $this

Note: Sum should only be filled out when measuring non-negative discrete events, and is assumed to be monotonic over the values of these events. Negative events can be recorded, but sum should not be filled out when doing so. This is specifically to enforce compatibility w/ OpenMetrics, see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram

Generated from protobuf field optional double sum = 5;

Parameters
$var : float
Return values
$this

setTimeUnixNano()

TimeUnixNano is required, see the detailed comments above Metric.

public setTimeUnixNano(int|string $var) : $this

Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

Generated from protobuf field fixed64 time_unix_nano = 3;

Parameters
$var : int|string
Return values
$this

setZeroCount()

zero_count is the count of values that are either exactly zero or within the region considered zero by the instrumentation at the tolerated degree of precision. This bucket stores values that cannot be expressed using the standard exponential formula as well as values that have been rounded to zero.

public setZeroCount(int|string $var) : $this

Implementations MAY consider the zero bucket to have probability mass equal to (zero_count / count).

Generated from protobuf field fixed64 zero_count = 7;

Parameters
$var : int|string
Return values
$this

setZeroThreshold()

ZeroThreshold may be optionally set to convey the width of the zero region. Where the zero region is defined as the closed interval [-ZeroThreshold, ZeroThreshold].

public setZeroThreshold(float $var) : $this

When ZeroThreshold is 0, zero count bucket stores values that cannot be expressed using the standard exponential formula as well as values that have been rounded to zero.

Generated from protobuf field double zero_threshold = 14;

Parameters
$var : float
Return values
$this

        
On this page

Search results