OpenTelemetry PHP

SummaryDataPoint extends Message
in package

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

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

Table of Contents

Properties

$count  : mixed
count is the number of values in the population. Must be non-negative.
$flags  : mixed
Flags that apply to this specific data point. See DataPointFlags for the available flags and their meaning.
$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).
$quantile_values  : mixed
(Optional) list of values at different quantiles of the distribution calculated from the current snapshot. The quantiles must be strictly increasing.

Methods

__construct()  : mixed
Constructor.
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.
getFlags()  : int
Flags that apply to this specific data point. See DataPointFlags for the available flags and their meaning.
getQuantileValues()  : RepeatedField
(Optional) list of values at different quantiles of the distribution calculated from the current snapshot. The quantiles must be strictly increasing.
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.
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.
setFlags()  : $this
Flags that apply to this specific data point. See DataPointFlags for the available flags and their meaning.
setQuantileValues()  : $this
(Optional) list of values at different quantiles of the distribution calculated from the current snapshot. The quantiles must be strictly increasing.
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.

Properties

$count

count is the number of values in the population. Must be non-negative.

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

$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 = 0.0

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#summary

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

$quantile_values

(Optional) list of values at different quantiles of the distribution calculated from the current snapshot. The quantiles must be strictly increasing.

private mixed $quantile_values

Generated from protobuf field repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;

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.
@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#summary
@type \Opentelemetry\Proto\Metrics\V1\SummaryDataPoint\ValueAtQuantile[]|\Google\Protobuf\Internal\RepeatedField $quantile_values
      (Optional) list of values at different quantiles of the distribution calculated
      from the current snapshot. The quantiles must be strictly increasing.
@type int $flags
      Flags that apply to this specific data point.  See DataPointFlags
      for the available flags and their meaning.

}

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

Return values
RepeatedField

getCount()

count is the number of values in the population. Must be non-negative.

public getCount() : int|string

Generated from protobuf field fixed64 count = 4;

Return values
int|string

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

Return values
int

getQuantileValues()

(Optional) list of values at different quantiles of the distribution calculated from the current snapshot. The quantiles must be strictly increasing.

public getQuantileValues() : RepeatedField

Generated from protobuf field repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;

Return values
RepeatedField

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#summary

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

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

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

setCount()

count is the number of values in the population. Must be non-negative.

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

Generated from protobuf field fixed64 count = 4;

Parameters
$var : int|string
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 = 8;

Parameters
$var : int
Return values
$this

setQuantileValues()

(Optional) list of values at different quantiles of the distribution calculated from the current snapshot. The quantiles must be strictly increasing.

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

Generated from protobuf field repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;

Parameters
$var : array<string|int, ValueAtQuantile>|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.

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#summary

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

        
On this page

Search results