OpenTelemetry PHP

HistogramDataPoint extends Message
in package

Application

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

If the histogram contains the distribution of values, then both "explicit_bounds" and "bucket counts" fields must be defined. If the histogram does not contain the distribution of values, then both "explicit_bounds" and "bucket_counts" must be omitted and only "count" and "sum" are known.

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

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 "count" fields in buckets if a histogram is provided.
$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].
$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.
$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).
$bucket_counts : mixed: bucket_counts is an optional field contains the count values of histogram for each bucket.
$exemplars : mixed: (Optional) List of exemplars collected from measurements that were used to form the data point
$explicit_bounds : mixed: explicit_bounds specifies buckets with explicitly defined bounds for values.

Methods

__construct() : mixed: Constructor.
clearMax() : mixed
clearMin() : 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).
getBucketCounts() : RepeatedField: bucket_counts is an optional field contains the count values of histogram for each bucket.
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 "count" fields in buckets if a histogram is provided.
getExemplars() : RepeatedField: (Optional) List of exemplars collected from measurements that were used to form the data point
getExplicitBounds() : RepeatedField: explicit_bounds specifies buckets with explicitly defined bounds for values.
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].
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.
hasMax() : mixed
hasMin() : 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).
setBucketCounts() : $this: bucket_counts is an optional field contains the count values of histogram for each bucket.
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 "count" fields in buckets if a histogram is provided.
setExemplars() : $this: (Optional) List of exemplars collected from measurements that were used to form the data point
setExplicitBounds() : $this: explicit_bounds specifies buckets with explicitly defined bounds for values.
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].
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.

$count

count is the number of values in the population. Must be non-negative. This value must be equal to the sum of the "count" fields in buckets if a histogram is provided.


    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 = 12;

$min

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


    protected
        mixed
    $min
     = null

Generated from protobuf field optional double min = 11;

$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;

$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 = 9;

$bucket_counts

bucket_counts is an optional field contains the count values of histogram for each bucket.


    private
        mixed
    $bucket_counts

The sum of the bucket_counts must equal the value in the count field. The number of elements in bucket_counts array must be by one greater than the number of elements in explicit_bounds array.

Generated from protobuf field repeated fixed64 bucket_counts = 6;

$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 = 8;

$explicit_bounds

explicit_bounds specifies buckets with explicitly defined bounds for values.


    private
        mixed
    $explicit_bounds

The boundaries for bucket at index i are: (-infinity, explicit_bounds[i]] for i == 0 (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < size(explicit_bounds) (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds) The values in the explicit_bounds array must be strictly increasing. Histogram buckets are inclusive of their upper boundary, except the last bucket where the boundary is at infinity. This format is intentionally compatible with the OpenMetrics histogram definition.

Generated from protobuf field repeated double explicit_bounds = 7;

__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 "count" fields in buckets if a
      histogram is provided.
@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[]|string[]|\Google\Protobuf\Internal\RepeatedField $bucket_counts
      bucket_counts is an optional field contains the count values of histogram
      for each bucket.
      The sum of the bucket_counts must equal the value in the count field.
      The number of elements in bucket_counts array must be by one greater than
      the number of elements in explicit_bounds array.
@type float[]|\Google\Protobuf\Internal\RepeatedField $explicit_bounds
      explicit_bounds specifies buckets with explicitly defined bounds for values.
      The boundaries for bucket at index i are:
      (-infinity, explicit_bounds[i]] for i == 0
      (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < size(explicit_bounds)
      (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds)
      The values in the explicit_bounds array must be strictly increasing.
      Histogram buckets are inclusive of their upper boundary, except the last
      bucket where the boundary is at infinity. This format is intentionally
      compatible with the OpenMetrics histogram definition.
@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 int $flags
      Flags that apply to this specific data point.  See DataPointFlags
      for the available flags and their meaning.
@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].

}

clearMax()


    public
                    clearMax() : mixed

clearMin()


    public
                    clearMin() : mixed

clearSum()


    public
                    clearSum() : mixed

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 = 9;

Return values

RepeatedField

getBucketCounts()

bucket_counts is an optional field contains the count values of histogram for each bucket.


    public
                    getBucketCounts() : RepeatedField

The sum of the bucket_counts must equal the value in the count field. The number of elements in bucket_counts array must be by one greater than the number of elements in explicit_bounds array.

Generated from protobuf field repeated fixed64 bucket_counts = 6;

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 "count" fields in buckets if a histogram is provided.


    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 = 8;

Return values

RepeatedField

getExplicitBounds()

explicit_bounds specifies buckets with explicitly defined bounds for values.


    public
                    getExplicitBounds() : RepeatedField

Generated from protobuf field repeated double explicit_bounds = 7;

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 = 12;

Return values

float

getMin()

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


    public
                    getMin() : float

Generated from protobuf field optional double min = 11;

Return values

float

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

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

hasMax()


    public
                    hasMax() : mixed

hasMin()


    public
                    hasMin() : mixed

hasSum()


    public
                    hasSum() : mixed

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 = 9;

Parameters

$var : array<string|int, KeyValue>|RepeatedField

Return values

$this

setBucketCounts()

bucket_counts is an optional field contains the count values of histogram for each bucket.


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

The sum of the bucket_counts must equal the value in the count field. The number of elements in bucket_counts array must be by one greater than the number of elements in explicit_bounds array.

Generated from protobuf field repeated fixed64 bucket_counts = 6;

Parameters

$var : array<string|int, int>|array<string|int, string>|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 "count" fields in buckets if a histogram is provided.


    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 = 8;

Parameters

$var : array<string|int, Exemplar>|RepeatedField

Return values

$this

setExplicitBounds()

explicit_bounds specifies buckets with explicitly defined bounds for values.


    public
                    setExplicitBounds(array<string|int, float>|RepeatedField $var) : $this

Generated from protobuf field repeated double explicit_bounds = 7;

Parameters

$var : array<string|int, float>|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 = 12;

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 = 11;

Parameters

$var : float

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

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

HistogramDataPoint extends Message in package Application

Table of Contents

Properties

Methods

Properties

$count

$flags

$max

$min

$start_time_unix_nano

$sum

$time_unix_nano

$attributes

$bucket_counts

$exemplars

$explicit_bounds

Methods

__construct()

Parameters

clearMax()

clearMin()

clearSum()

getAttributes()

Return values

getBucketCounts()

Return values

getCount()

Return values

getExemplars()

Return values

getExplicitBounds()

Return values

getFlags()

Return values

getMax()

Return values

getMin()

Return values

getStartTimeUnixNano()

Return values

getSum()

Return values

getTimeUnixNano()

Return values

hasMax()

hasMin()

hasSum()

setAttributes()

Parameters

Return values

setBucketCounts()

Parameters

Return values

setCount()

Parameters

Return values

setExemplars()

Parameters

Return values

setExplicitBounds()

Parameters

Return values

setFlags()

Parameters

Return values

setMax()

Parameters

Return values

setMin()

Parameters

Return values

setStartTimeUnixNano()

Parameters

Return values

setSum()

Parameters

Return values

setTimeUnixNano()

Parameters

Return values

HistogramDataPoint extends Message
in package

Application