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

Breadcrumb

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

class TraceConfig

Same name in this branch
  1. 11.1.x vendor/open-telemetry/gen-otlp-protobuf/GPBMetadata/Opentelemetry/Proto/Trace/V1/TraceConfig.php \GPBMetadata\Opentelemetry\Proto\Trace\V1\TraceConfig

Global configuration of the trace service. All fields must be specified, or the default (zero) values will be used for each type.

Generated from protobuf message <code>opentelemetry.proto.trace.v1.TraceConfig</code>

Hierarchy

  • class \Google\Protobuf\Internal\Message
    • class \Opentelemetry\Proto\Trace\V1\TraceConfig extends \Google\Protobuf\Internal\Message

Expanded class hierarchy of TraceConfig

File

vendor/open-telemetry/gen-otlp-protobuf/Opentelemetry/Proto/Trace/V1/TraceConfig.php, line 17

Namespace

Opentelemetry\Proto\Trace\V1
View source
class TraceConfig extends \Google\Protobuf\Internal\Message {
    
    /**
     * The global default max number of attributes per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_attributes = 4;</code>
     */
    protected $max_number_of_attributes = 0;
    
    /**
     * The global default max number of annotation events per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_timed_events = 5;</code>
     */
    protected $max_number_of_timed_events = 0;
    
    /**
     * The global default max number of attributes per timed event.
     *
     * Generated from protobuf field <code>int64 max_number_of_attributes_per_timed_event = 6;</code>
     */
    protected $max_number_of_attributes_per_timed_event = 0;
    
    /**
     * The global default max number of link entries per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_links = 7;</code>
     */
    protected $max_number_of_links = 0;
    
    /**
     * The global default max number of attributes per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_attributes_per_link = 8;</code>
     */
    protected $max_number_of_attributes_per_link = 0;
    protected $sampler;
    
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type \Opentelemetry\Proto\Trace\V1\ConstantSampler $constant_sampler
     *     @type \Opentelemetry\Proto\Trace\V1\TraceIdRatioBased $trace_id_ratio_based
     *     @type \Opentelemetry\Proto\Trace\V1\RateLimitingSampler $rate_limiting_sampler
     *     @type int|string $max_number_of_attributes
     *           The global default max number of attributes per span.
     *     @type int|string $max_number_of_timed_events
     *           The global default max number of annotation events per span.
     *     @type int|string $max_number_of_attributes_per_timed_event
     *           The global default max number of attributes per timed event.
     *     @type int|string $max_number_of_links
     *           The global default max number of link entries per span.
     *     @type int|string $max_number_of_attributes_per_link
     *           The global default max number of attributes per span.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Opentelemetry\Proto\Trace\V1\TraceConfig::initOnce();
        parent::__construct($data);
    }
    
    /**
     * Generated from protobuf field <code>.opentelemetry.proto.trace.v1.ConstantSampler constant_sampler = 1;</code>
     * @return \Opentelemetry\Proto\Trace\V1\ConstantSampler|null
     */
    public function getConstantSampler() {
        return $this->readOneof(1);
    }
    public function hasConstantSampler() {
        return $this->hasOneof(1);
    }
    
    /**
     * Generated from protobuf field <code>.opentelemetry.proto.trace.v1.ConstantSampler constant_sampler = 1;</code>
     * @param \Opentelemetry\Proto\Trace\V1\ConstantSampler $var
     * @return $this
     */
    public function setConstantSampler($var) {
        GPBUtil::checkMessage($var, \Opentelemetry\Proto\Trace\V1\ConstantSampler::class);
        $this->writeOneof(1, $var);
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>.opentelemetry.proto.trace.v1.TraceIdRatioBased trace_id_ratio_based = 2;</code>
     * @return \Opentelemetry\Proto\Trace\V1\TraceIdRatioBased|null
     */
    public function getTraceIdRatioBased() {
        return $this->readOneof(2);
    }
    public function hasTraceIdRatioBased() {
        return $this->hasOneof(2);
    }
    
    /**
     * Generated from protobuf field <code>.opentelemetry.proto.trace.v1.TraceIdRatioBased trace_id_ratio_based = 2;</code>
     * @param \Opentelemetry\Proto\Trace\V1\TraceIdRatioBased $var
     * @return $this
     */
    public function setTraceIdRatioBased($var) {
        GPBUtil::checkMessage($var, \Opentelemetry\Proto\Trace\V1\TraceIdRatioBased::class);
        $this->writeOneof(2, $var);
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>.opentelemetry.proto.trace.v1.RateLimitingSampler rate_limiting_sampler = 3;</code>
     * @return \Opentelemetry\Proto\Trace\V1\RateLimitingSampler|null
     */
    public function getRateLimitingSampler() {
        return $this->readOneof(3);
    }
    public function hasRateLimitingSampler() {
        return $this->hasOneof(3);
    }
    
    /**
     * Generated from protobuf field <code>.opentelemetry.proto.trace.v1.RateLimitingSampler rate_limiting_sampler = 3;</code>
     * @param \Opentelemetry\Proto\Trace\V1\RateLimitingSampler $var
     * @return $this
     */
    public function setRateLimitingSampler($var) {
        GPBUtil::checkMessage($var, \Opentelemetry\Proto\Trace\V1\RateLimitingSampler::class);
        $this->writeOneof(3, $var);
        return $this;
    }
    
    /**
     * The global default max number of attributes per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_attributes = 4;</code>
     * @return int|string
     */
    public function getMaxNumberOfAttributes() {
        return $this->max_number_of_attributes;
    }
    
    /**
     * The global default max number of attributes per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_attributes = 4;</code>
     * @param int|string $var
     * @return $this
     */
    public function setMaxNumberOfAttributes($var) {
        GPBUtil::checkInt64($var);
        $this->max_number_of_attributes = $var;
        return $this;
    }
    
    /**
     * The global default max number of annotation events per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_timed_events = 5;</code>
     * @return int|string
     */
    public function getMaxNumberOfTimedEvents() {
        return $this->max_number_of_timed_events;
    }
    
    /**
     * The global default max number of annotation events per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_timed_events = 5;</code>
     * @param int|string $var
     * @return $this
     */
    public function setMaxNumberOfTimedEvents($var) {
        GPBUtil::checkInt64($var);
        $this->max_number_of_timed_events = $var;
        return $this;
    }
    
    /**
     * The global default max number of attributes per timed event.
     *
     * Generated from protobuf field <code>int64 max_number_of_attributes_per_timed_event = 6;</code>
     * @return int|string
     */
    public function getMaxNumberOfAttributesPerTimedEvent() {
        return $this->max_number_of_attributes_per_timed_event;
    }
    
    /**
     * The global default max number of attributes per timed event.
     *
     * Generated from protobuf field <code>int64 max_number_of_attributes_per_timed_event = 6;</code>
     * @param int|string $var
     * @return $this
     */
    public function setMaxNumberOfAttributesPerTimedEvent($var) {
        GPBUtil::checkInt64($var);
        $this->max_number_of_attributes_per_timed_event = $var;
        return $this;
    }
    
    /**
     * The global default max number of link entries per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_links = 7;</code>
     * @return int|string
     */
    public function getMaxNumberOfLinks() {
        return $this->max_number_of_links;
    }
    
    /**
     * The global default max number of link entries per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_links = 7;</code>
     * @param int|string $var
     * @return $this
     */
    public function setMaxNumberOfLinks($var) {
        GPBUtil::checkInt64($var);
        $this->max_number_of_links = $var;
        return $this;
    }
    
    /**
     * The global default max number of attributes per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_attributes_per_link = 8;</code>
     * @return int|string
     */
    public function getMaxNumberOfAttributesPerLink() {
        return $this->max_number_of_attributes_per_link;
    }
    
    /**
     * The global default max number of attributes per span.
     *
     * Generated from protobuf field <code>int64 max_number_of_attributes_per_link = 8;</code>
     * @param int|string $var
     * @return $this
     */
    public function setMaxNumberOfAttributesPerLink($var) {
        GPBUtil::checkInt64($var);
        $this->max_number_of_attributes_per_link = $var;
        return $this;
    }
    
    /**
     * @return string
     */
    public function getSampler() {
        return $this->whichOneof("sampler");
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
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
TraceConfig::$max_number_of_attributes protected property The global default max number of attributes per span.
TraceConfig::$max_number_of_attributes_per_link protected property The global default max number of attributes per span.
TraceConfig::$max_number_of_attributes_per_timed_event protected property The global default max number of attributes per timed event.
TraceConfig::$max_number_of_links protected property The global default max number of link entries per span.
TraceConfig::$max_number_of_timed_events protected property The global default max number of annotation events per span.
TraceConfig::$sampler protected property
TraceConfig::getConstantSampler public function Generated from protobuf field &lt;code&gt;.opentelemetry.proto.trace.v1.ConstantSampler constant_sampler = 1;&lt;/code&gt;
TraceConfig::getMaxNumberOfAttributes public function The global default max number of attributes per span.
TraceConfig::getMaxNumberOfAttributesPerLink public function The global default max number of attributes per span.
TraceConfig::getMaxNumberOfAttributesPerTimedEvent public function The global default max number of attributes per timed event.
TraceConfig::getMaxNumberOfLinks public function The global default max number of link entries per span.
TraceConfig::getMaxNumberOfTimedEvents public function The global default max number of annotation events per span.
TraceConfig::getRateLimitingSampler public function Generated from protobuf field &lt;code&gt;.opentelemetry.proto.trace.v1.RateLimitingSampler rate_limiting_sampler = 3;&lt;/code&gt;
TraceConfig::getSampler public function
TraceConfig::getTraceIdRatioBased public function Generated from protobuf field &lt;code&gt;.opentelemetry.proto.trace.v1.TraceIdRatioBased trace_id_ratio_based = 2;&lt;/code&gt;
TraceConfig::hasConstantSampler public function
TraceConfig::hasRateLimitingSampler public function
TraceConfig::hasTraceIdRatioBased public function
TraceConfig::setConstantSampler public function Generated from protobuf field &lt;code&gt;.opentelemetry.proto.trace.v1.ConstantSampler constant_sampler = 1;&lt;/code&gt;
TraceConfig::setMaxNumberOfAttributes public function The global default max number of attributes per span.
TraceConfig::setMaxNumberOfAttributesPerLink public function The global default max number of attributes per span.
TraceConfig::setMaxNumberOfAttributesPerTimedEvent public function The global default max number of attributes per timed event.
TraceConfig::setMaxNumberOfLinks public function The global default max number of link entries per span.
TraceConfig::setMaxNumberOfTimedEvents public function The global default max number of annotation events per span.
TraceConfig::setRateLimitingSampler public function Generated from protobuf field &lt;code&gt;.opentelemetry.proto.trace.v1.RateLimitingSampler rate_limiting_sampler = 3;&lt;/code&gt;
TraceConfig::setTraceIdRatioBased public function Generated from protobuf field &lt;code&gt;.opentelemetry.proto.trace.v1.TraceIdRatioBased trace_id_ratio_based = 2;&lt;/code&gt;
TraceConfig::__construct public function Constructor. Overrides Message::__construct
RSS feed
Powered by Drupal