OpenTelemetry PHP

Sample extends Message
in package

Each Sample records values encountered in some program context. The program context is typically a stack trace, perhaps augmented with auxiliary information like the thread-id, some indicator of a higher level request being handled etc.

Generated from protobuf message opentelemetry.proto.profiles.v1development.Sample

Table of Contents

Properties

$link_index  : mixed
Reference to link in Profile.link_table. [optional]
$locations_length  : mixed
locations_length along with locations_start_index refers to a slice of locations in Profile.location_indices.
$locations_start_index  : mixed
locations_start_index along with locations_length refers to to a slice of locations in Profile.location_indices.
$attribute_indices  : mixed
References to attributes in Profile.attribute_table. [optional]
$timestamps_unix_nano  : mixed
Timestamps associated with Sample represented in nanoseconds. These timestamps are expected to fall within the Profile's time range. [optional]
$value  : mixed
The type and unit of each value is defined by the corresponding entry in Profile.sample_type. All samples must have the same number of values, the same as the length of Profile.sample_type.

Methods

__construct()  : mixed
Constructor.
clearLinkIndex()  : mixed
getAttributeIndices()  : RepeatedField
References to attributes in Profile.attribute_table. [optional]
getLinkIndex()  : int
Reference to link in Profile.link_table. [optional]
getLocationsLength()  : int
locations_length along with locations_start_index refers to a slice of locations in Profile.location_indices.
getLocationsStartIndex()  : int
locations_start_index along with locations_length refers to to a slice of locations in Profile.location_indices.
getTimestampsUnixNano()  : RepeatedField
Timestamps associated with Sample represented in nanoseconds. These timestamps are expected to fall within the Profile's time range. [optional]
getValue()  : RepeatedField
The type and unit of each value is defined by the corresponding entry in Profile.sample_type. All samples must have the same number of values, the same as the length of Profile.sample_type.
hasLinkIndex()  : mixed
setAttributeIndices()  : $this
References to attributes in Profile.attribute_table. [optional]
setLinkIndex()  : $this
Reference to link in Profile.link_table. [optional]
setLocationsLength()  : $this
locations_length along with locations_start_index refers to a slice of locations in Profile.location_indices.
setLocationsStartIndex()  : $this
locations_start_index along with locations_length refers to to a slice of locations in Profile.location_indices.
setTimestampsUnixNano()  : $this
Timestamps associated with Sample represented in nanoseconds. These timestamps are expected to fall within the Profile's time range. [optional]
setValue()  : $this
The type and unit of each value is defined by the corresponding entry in Profile.sample_type. All samples must have the same number of values, the same as the length of Profile.sample_type.

Properties

$link_index

Reference to link in Profile.link_table. [optional]

protected mixed $link_index = null

Generated from protobuf field optional int32 link_index = 5;

$locations_length

locations_length along with locations_start_index refers to a slice of locations in Profile.location_indices.

protected mixed $locations_length = 0

Supersedes location_index.

Generated from protobuf field int32 locations_length = 2;

$locations_start_index

locations_start_index along with locations_length refers to to a slice of locations in Profile.location_indices.

protected mixed $locations_start_index = 0

Generated from protobuf field int32 locations_start_index = 1;

$attribute_indices

References to attributes in Profile.attribute_table. [optional]

private mixed $attribute_indices

Generated from protobuf field repeated int32 attribute_indices = 4;

$timestamps_unix_nano

Timestamps associated with Sample represented in nanoseconds. These timestamps are expected to fall within the Profile's time range. [optional]

private mixed $timestamps_unix_nano

Generated from protobuf field repeated uint64 timestamps_unix_nano = 6;

$value

The type and unit of each value is defined by the corresponding entry in Profile.sample_type. All samples must have the same number of values, the same as the length of Profile.sample_type.

private mixed $value

When aggregating multiple samples into a single sample, the result has a list of values that is the element-wise sum of the lists of the originals.

Generated from protobuf field repeated int64 value = 3;

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 int $locations_start_index
      locations_start_index along with locations_length refers to to a slice of locations in Profile.location_indices.
@type int $locations_length
      locations_length along with locations_start_index refers to a slice of locations in Profile.location_indices.
      Supersedes location_index.
@type int[]|string[]|\Google\Protobuf\Internal\RepeatedField $value
      The type and unit of each value is defined by the corresponding
      entry in Profile.sample_type. All samples must have the same
      number of values, the same as the length of Profile.sample_type.
      When aggregating multiple samples into a single sample, the
      result has a list of values that is the element-wise sum of the
      lists of the originals.
@type int[]|\Google\Protobuf\Internal\RepeatedField $attribute_indices
      References to attributes in Profile.attribute_table. [optional]
@type int $link_index
      Reference to link in Profile.link_table. [optional]
@type int[]|string[]|\Google\Protobuf\Internal\RepeatedField $timestamps_unix_nano
      Timestamps associated with Sample represented in nanoseconds. These timestamps are expected
      to fall within the Profile's time range. [optional]

}

clearLinkIndex()

public clearLinkIndex() : mixed

getAttributeIndices()

References to attributes in Profile.attribute_table. [optional]

public getAttributeIndices() : RepeatedField

Generated from protobuf field repeated int32 attribute_indices = 4;

Return values
RepeatedField

getLinkIndex()

Reference to link in Profile.link_table. [optional]

public getLinkIndex() : int

Generated from protobuf field optional int32 link_index = 5;

Return values
int

getLocationsLength()

locations_length along with locations_start_index refers to a slice of locations in Profile.location_indices.

public getLocationsLength() : int

Supersedes location_index.

Generated from protobuf field int32 locations_length = 2;

Return values
int

getLocationsStartIndex()

locations_start_index along with locations_length refers to to a slice of locations in Profile.location_indices.

public getLocationsStartIndex() : int

Generated from protobuf field int32 locations_start_index = 1;

Return values
int

getTimestampsUnixNano()

Timestamps associated with Sample represented in nanoseconds. These timestamps are expected to fall within the Profile's time range. [optional]

public getTimestampsUnixNano() : RepeatedField

Generated from protobuf field repeated uint64 timestamps_unix_nano = 6;

Return values
RepeatedField

getValue()

The type and unit of each value is defined by the corresponding entry in Profile.sample_type. All samples must have the same number of values, the same as the length of Profile.sample_type.

public getValue() : RepeatedField

When aggregating multiple samples into a single sample, the result has a list of values that is the element-wise sum of the lists of the originals.

Generated from protobuf field repeated int64 value = 3;

Return values
RepeatedField

hasLinkIndex()

public hasLinkIndex() : mixed

setAttributeIndices()

References to attributes in Profile.attribute_table. [optional]

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

Generated from protobuf field repeated int32 attribute_indices = 4;

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

setLinkIndex()

Reference to link in Profile.link_table. [optional]

public setLinkIndex(int $var) : $this

Generated from protobuf field optional int32 link_index = 5;

Parameters
$var : int
Return values
$this

setLocationsLength()

locations_length along with locations_start_index refers to a slice of locations in Profile.location_indices.

public setLocationsLength(int $var) : $this

Supersedes location_index.

Generated from protobuf field int32 locations_length = 2;

Parameters
$var : int
Return values
$this

setLocationsStartIndex()

locations_start_index along with locations_length refers to to a slice of locations in Profile.location_indices.

public setLocationsStartIndex(int $var) : $this

Generated from protobuf field int32 locations_start_index = 1;

Parameters
$var : int
Return values
$this

setTimestampsUnixNano()

Timestamps associated with Sample represented in nanoseconds. These timestamps are expected to fall within the Profile's time range. [optional]

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

Generated from protobuf field repeated uint64 timestamps_unix_nano = 6;

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

setValue()

The type and unit of each value is defined by the corresponding entry in Profile.sample_type. All samples must have the same number of values, the same as the length of Profile.sample_type.

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

When aggregating multiple samples into a single sample, the result has a list of values that is the element-wise sum of the lists of the originals.

Generated from protobuf field repeated int64 value = 3;

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results