Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Exemplar.php

class Exemplar

Same name in this branch
  1. 11.1.x vendor/open-telemetry/sdk/Metrics/Data/Exemplar.php \OpenTelemetry\SDK\Metrics\Data\Exemplar

A representation of an exemplar, which is a sample input 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.

Generated from protobuf message <code>opentelemetry.proto.metrics.v1.Exemplar</code>

Hierarchy

  • class \Google\Protobuf\Internal\Message
    • class \Opentelemetry\Proto\Metrics\V1\Exemplar extends \Google\Protobuf\Internal\Message

Expanded class hierarchy of Exemplar

1 file declares its use of Exemplar
MetricConverter.php in vendor/open-telemetry/exporter-otlp/MetricConverter.php

File

vendor/open-telemetry/gen-otlp-protobuf/Opentelemetry/Proto/Metrics/V1/Exemplar.php, line 19

Namespace

Opentelemetry\Proto\Metrics\V1
View source
class Exemplar extends \Google\Protobuf\Internal\Message {
    
    /**
     * The set of key/value pairs that were filtered out by the aggregator, but
     * recorded alongside the original measurement. Only key/value pairs that were
     * filtered out by the aggregator should be included
     *
     * Generated from protobuf field <code>repeated .opentelemetry.proto.common.v1.KeyValue filtered_attributes = 7;</code>
     */
    private $filtered_attributes;
    
    /**
     * time_unix_nano is the exact time when this exemplar was recorded
     * Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     * 1970.
     *
     * Generated from protobuf field <code>fixed64 time_unix_nano = 2;</code>
     */
    protected $time_unix_nano = 0;
    
    /**
     * (Optional) Span ID of the exemplar trace.
     * span_id may be missing if the measurement is not recorded inside a trace
     * or if the trace is not sampled.
     *
     * Generated from protobuf field <code>bytes span_id = 4;</code>
     */
    protected $span_id = '';
    
    /**
     * (Optional) Trace ID of the exemplar trace.
     * trace_id may be missing if the measurement is not recorded inside a trace
     * or if the trace is not sampled.
     *
     * Generated from protobuf field <code>bytes trace_id = 5;</code>
     */
    protected $trace_id = '';
    protected $value;
    
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type \Opentelemetry\Proto\Common\V1\KeyValue[]|\Google\Protobuf\Internal\RepeatedField $filtered_attributes
     *           The set of key/value pairs that were filtered out by the aggregator, but
     *           recorded alongside the original measurement. Only key/value pairs that were
     *           filtered out by the aggregator should be included
     *     @type int|string $time_unix_nano
     *           time_unix_nano is the exact time when this exemplar was recorded
     *           Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     *           1970.
     *     @type float $as_double
     *     @type int|string $as_int
     *     @type string $span_id
     *           (Optional) Span ID of the exemplar trace.
     *           span_id may be missing if the measurement is not recorded inside a trace
     *           or if the trace is not sampled.
     *     @type string $trace_id
     *           (Optional) Trace ID of the exemplar trace.
     *           trace_id may be missing if the measurement is not recorded inside a trace
     *           or if the trace is not sampled.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Opentelemetry\Proto\Metrics\V1\Metrics::initOnce();
        parent::__construct($data);
    }
    
    /**
     * The set of key/value pairs that were filtered out by the aggregator, but
     * recorded alongside the original measurement. Only key/value pairs that were
     * filtered out by the aggregator should be included
     *
     * Generated from protobuf field <code>repeated .opentelemetry.proto.common.v1.KeyValue filtered_attributes = 7;</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getFilteredAttributes() {
        return $this->filtered_attributes;
    }
    
    /**
     * The set of key/value pairs that were filtered out by the aggregator, but
     * recorded alongside the original measurement. Only key/value pairs that were
     * filtered out by the aggregator should be included
     *
     * Generated from protobuf field <code>repeated .opentelemetry.proto.common.v1.KeyValue filtered_attributes = 7;</code>
     * @param \Opentelemetry\Proto\Common\V1\KeyValue[]|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setFilteredAttributes($var) {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Opentelemetry\Proto\Common\V1\KeyValue::class);
        $this->filtered_attributes = $arr;
        return $this;
    }
    
    /**
     * time_unix_nano is the exact time when this exemplar was recorded
     * Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     * 1970.
     *
     * Generated from protobuf field <code>fixed64 time_unix_nano = 2;</code>
     * @return int|string
     */
    public function getTimeUnixNano() {
        return $this->time_unix_nano;
    }
    
    /**
     * time_unix_nano is the exact time when this exemplar was recorded
     * Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
     * 1970.
     *
     * Generated from protobuf field <code>fixed64 time_unix_nano = 2;</code>
     * @param int|string $var
     * @return $this
     */
    public function setTimeUnixNano($var) {
        GPBUtil::checkUint64($var);
        $this->time_unix_nano = $var;
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>double as_double = 3;</code>
     * @return float
     */
    public function getAsDouble() {
        return $this->readOneof(3);
    }
    public function hasAsDouble() {
        return $this->hasOneof(3);
    }
    
    /**
     * Generated from protobuf field <code>double as_double = 3;</code>
     * @param float $var
     * @return $this
     */
    public function setAsDouble($var) {
        GPBUtil::checkDouble($var);
        $this->writeOneof(3, $var);
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>sfixed64 as_int = 6;</code>
     * @return int|string
     */
    public function getAsInt() {
        return $this->readOneof(6);
    }
    public function hasAsInt() {
        return $this->hasOneof(6);
    }
    
    /**
     * Generated from protobuf field <code>sfixed64 as_int = 6;</code>
     * @param int|string $var
     * @return $this
     */
    public function setAsInt($var) {
        GPBUtil::checkInt64($var);
        $this->writeOneof(6, $var);
        return $this;
    }
    
    /**
     * (Optional) Span ID of the exemplar trace.
     * span_id may be missing if the measurement is not recorded inside a trace
     * or if the trace is not sampled.
     *
     * Generated from protobuf field <code>bytes span_id = 4;</code>
     * @return string
     */
    public function getSpanId() {
        return $this->span_id;
    }
    
    /**
     * (Optional) Span ID of the exemplar trace.
     * span_id may be missing if the measurement is not recorded inside a trace
     * or if the trace is not sampled.
     *
     * Generated from protobuf field <code>bytes span_id = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setSpanId($var) {
        GPBUtil::checkString($var, False);
        $this->span_id = $var;
        return $this;
    }
    
    /**
     * (Optional) Trace ID of the exemplar trace.
     * trace_id may be missing if the measurement is not recorded inside a trace
     * or if the trace is not sampled.
     *
     * Generated from protobuf field <code>bytes trace_id = 5;</code>
     * @return string
     */
    public function getTraceId() {
        return $this->trace_id;
    }
    
    /**
     * (Optional) Trace ID of the exemplar trace.
     * trace_id may be missing if the measurement is not recorded inside a trace
     * or if the trace is not sampled.
     *
     * Generated from protobuf field <code>bytes trace_id = 5;</code>
     * @param string $var
     * @return $this
     */
    public function setTraceId($var) {
        GPBUtil::checkString($var, False);
        $this->trace_id = $var;
        return $this;
    }
    
    /**
     * @return string
     */
    public function getValue() {
        return $this->whichOneof("value");
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
Exemplar::$filtered_attributes private property The set of key/value pairs that were filtered out by the aggregator, but
recorded alongside the original measurement. Only key/value pairs that were
filtered out by the aggregator should be included
Exemplar::$span_id protected property (Optional) Span ID of the exemplar trace.
span_id may be missing if the measurement is not recorded inside a trace
or if the trace is not sampled.
Exemplar::$time_unix_nano protected property time_unix_nano is the exact time when this exemplar was recorded
Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
1970.
Exemplar::$trace_id protected property (Optional) Trace ID of the exemplar trace.
trace_id may be missing if the measurement is not recorded inside a trace
or if the trace is not sampled.
Exemplar::$value protected property
Exemplar::getAsDouble public function Generated from protobuf field &lt;code&gt;double as_double = 3;&lt;/code&gt;
Exemplar::getAsInt public function Generated from protobuf field &lt;code&gt;sfixed64 as_int = 6;&lt;/code&gt;
Exemplar::getFilteredAttributes public function The set of key/value pairs that were filtered out by the aggregator, but
recorded alongside the original measurement. Only key/value pairs that were
filtered out by the aggregator should be included
Exemplar::getSpanId public function (Optional) Span ID of the exemplar trace.
span_id may be missing if the measurement is not recorded inside a trace
or if the trace is not sampled.
Exemplar::getTimeUnixNano public function time_unix_nano is the exact time when this exemplar was recorded
Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
1970.
Exemplar::getTraceId public function (Optional) Trace ID of the exemplar trace.
trace_id may be missing if the measurement is not recorded inside a trace
or if the trace is not sampled.
Exemplar::getValue public function
Exemplar::hasAsDouble public function
Exemplar::hasAsInt public function
Exemplar::setAsDouble public function Generated from protobuf field &lt;code&gt;double as_double = 3;&lt;/code&gt;
Exemplar::setAsInt public function Generated from protobuf field &lt;code&gt;sfixed64 as_int = 6;&lt;/code&gt;
Exemplar::setFilteredAttributes public function The set of key/value pairs that were filtered out by the aggregator, but
recorded alongside the original measurement. Only key/value pairs that were
filtered out by the aggregator should be included
Exemplar::setSpanId public function (Optional) Span ID of the exemplar trace.
span_id may be missing if the measurement is not recorded inside a trace
or if the trace is not sampled.
Exemplar::setTimeUnixNano public function time_unix_nano is the exact time when this exemplar was recorded
Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
1970.
Exemplar::setTraceId public function (Optional) Trace ID of the exemplar trace.
trace_id may be missing if the measurement is not recorded inside a trace
or if the trace is not sampled.
Exemplar::__construct public function Constructor. Overrides Message::__construct
Message::$desc private property @ignore
Message::$unknown private property
Message::appendHelper private function
Message::byteSize public function @ignore
Message::clear public function Clear all containing fields.
Message::convertJsonValueToProtoValue private function
Message::defaultValue private function @ignore
Message::discardUnknownFields public function Clear all unknown fields previously parsed.
Message::existField private function @ignore
Message::fieldByteSize private function @ignore
Message::fieldDataOnlyByteSize private function @ignore
Message::fieldDataOnlyJsonByteSize private function @ignore
Message::fieldJsonByteSize private function @ignore
Message::hasOneof protected function
Message::initWithDescriptor private function @ignore
Message::initWithGeneratedPool private function @ignore
Message::jsonByteSize public function @ignore
Message::kvUpdateHelper private function
Message::mergeFrom public function Merges the contents of the specified message into current message.
Message::mergeFromArray protected function Populates the message from a user-supplied PHP array. Array keys
correspond to Message properties and nested message properties.
Message::mergeFromArrayJsonImpl private function
Message::mergeFromJsonArray protected function
Message::mergeFromJsonString public function Parses a json string to protobuf message.
Message::mergeFromString public function Parses a protocol buffer contained in a string.
Message::normalizeArrayElementsToMessageType private static function Tries to normalize the elements in $value into a provided protobuf
wrapper type $class. If $value is any type other than array, we do
not do any conversion, and instead rely on the existing protobuf
type checking. If $value is an array, we process…
Message::normalizeToMessageType private static function Tries to normalize $value into a provided protobuf wrapper type $class.
If $value is any type other than an object, we attempt to construct an
instance of $class and assign $value to it using the setValue method
shared by all wrapper types.
Message::parseFieldFromStream private function @ignore
Message::parseFieldFromStreamNoTag private static function @ignore
Message::parseFromJsonStream public function @ignore
Message::parseFromStream public function @ignore
Message::readOneof protected function
Message::readWrapperValue protected function
Message::repeatedFieldDataOnlyByteSize private function @ignore
Message::serializeFieldToJsonStream private function @ignore
Message::serializeFieldToStream private function @ignore
Message::serializeMapFieldToStream private function @ignore
Message::serializeRepeatedFieldToStream private function @ignore
Message::serializeSingularFieldToStream private function @ignore
Message::serializeToJsonStream public function @ignore
Message::serializeToJsonString public function Serialize the message to json string.
Message::serializeToStream public function @ignore
Message::serializeToString public function Serialize the message to string.
Message::skipField private function @ignore
Message::whichOneof protected function
Message::writeOneof protected function
Message::writeWrapperValue protected function
Message::__debugInfo public function
RSS feed
Powered by Drupal