OpenTelemetry PHP

IntHistogramDataPoint extends Message
in package

Application

IntHistogramDataPoint is deprecated; use HistogramDataPoint.

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

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.
$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. This value must be equal to the sum of the "sum" fields in buckets if a histogram is provided.
$time_unix_nano : mixed: TimeUnixNano is required, see the detailed comments above Metric.
$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.
$labels : mixed: The set of labels that uniquely identify this timeseries.

Methods

__construct() : mixed: Constructor.
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.
getLabels() : RepeatedField: The set of labels that uniquely identify this timeseries.
getStartTimeUnixNano() : int|string: StartTimeUnixNano is optional but strongly encouraged, see the the detailed comments above Metric.
getSum() : int|string: sum of the values in the population. If count is zero then this field must be zero. This value must be equal to the sum of the "sum" fields in buckets if a histogram is provided.
getTimeUnixNano() : int|string: TimeUnixNano is required, see the detailed comments above Metric.
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.
setLabels() : $this: The set of labels that uniquely identify this timeseries.
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. This value must be equal to the sum of the "sum" fields in buckets if a histogram is provided.
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;

$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. This value must be equal to the sum of the "sum" fields in buckets if a histogram is provided.


    protected
        mixed
    $sum
     = 0

Generated from protobuf field sfixed64 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;

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

$labels

The set of labels that uniquely identify this timeseries.


    private
        mixed
    $labels

Generated from protobuf field repeated .opentelemetry.proto.common.v1.StringKeyValue labels = 1;

__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\StringKeyValue[]|\Google\Protobuf\Internal\RepeatedField $labels
      The set of labels that uniquely identify this timeseries.
@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 int|string $sum
      sum of the values in the population. If count is zero then this field
      must be zero. This value must be equal to the sum of the "sum" fields in
      buckets if a histogram is provided.
@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\IntExemplar[]|\Google\Protobuf\Internal\RepeatedField $exemplars
      (Optional) List of exemplars collected from
      measurements that were used to form the data point

}

getBucketCounts()

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


    public
                    getBucketCounts() : RepeatedField


    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. This value must be equal to the sum of the "sum" fields in buckets if a histogram is provided.


    public
                    getSum() : int|string

Generated from protobuf field sfixed64 sum = 5;

Return values

int|string

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

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, IntExemplar>|RepeatedField $var) : $this

Generated from protobuf field repeated .opentelemetry.proto.metrics.v1.IntExemplar exemplars = 8;

Parameters

$var : array<string|int, IntExemplar>|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

setLabels()

The set of labels that uniquely identify this timeseries.


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

Generated from protobuf field repeated .opentelemetry.proto.common.v1.StringKeyValue labels = 1;

Parameters

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

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. This value must be equal to the sum of the "sum" fields in buckets if a histogram is provided.


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

Generated from protobuf field sfixed64 sum = 5;

Parameters

$var : int|string

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

IntHistogramDataPoint extends Message in package Application

Table of Contents

Properties

Methods

Properties

$count

$start_time_unix_nano

$sum

$time_unix_nano

$bucket_counts

$exemplars

$explicit_bounds

$labels

Methods

__construct()

Parameters

getBucketCounts()

Return values

getCount()

Return values

getExemplars()

Return values

getExplicitBounds()

Return values

getLabels()

Return values

getStartTimeUnixNano()

Return values

getSum()

Return values

getTimeUnixNano()

Return values

setBucketCounts()

Parameters

Return values

setCount()

Parameters

Return values

setExemplars()

Parameters

Return values

setExplicitBounds()

Parameters

Return values

setLabels()

Parameters

Return values

setStartTimeUnixNano()

Parameters

Return values

setSum()

Parameters

Return values

setTimeUnixNano()

Parameters

Return values

IntHistogramDataPoint extends Message
in package

Application