OpenTelemetry PHP

Location extends Message
in package

Describes function and line table debug information.

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

Table of Contents

Properties

$address  : mixed
The instruction address for this location, if available. It should be within [Mapping.memory_start...Mapping.memory_limit] for the corresponding mapping. A non-leaf address may be in the middle of a call instruction. It is up to display tools to find the beginning of the instruction if necessary.
$is_folded  : mixed
Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In that case the line information above represents one of the multiple symbols. This field must be recomputed when the symbolization state of the profile changes.
$mapping_index  : mixed
Reference to mapping in Profile.mapping_table.
$attribute_indices  : mixed
References to attributes in Profile.attribute_table. [optional]
$line  : mixed
Multiple line indicates this location has inlined functions, where the last entry represents the caller into which the preceding entries were inlined.

Methods

__construct()  : mixed
Constructor.
clearMappingIndex()  : mixed
getAddress()  : int|string
The instruction address for this location, if available. It should be within [Mapping.memory_start...Mapping.memory_limit] for the corresponding mapping. A non-leaf address may be in the middle of a call instruction. It is up to display tools to find the beginning of the instruction if necessary.
getAttributeIndices()  : RepeatedField
References to attributes in Profile.attribute_table. [optional]
getIsFolded()  : bool
Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In that case the line information above represents one of the multiple symbols. This field must be recomputed when the symbolization state of the profile changes.
getLine()  : RepeatedField
Multiple line indicates this location has inlined functions, where the last entry represents the caller into which the preceding entries were inlined.
getMappingIndex()  : int
Reference to mapping in Profile.mapping_table.
hasMappingIndex()  : mixed
setAddress()  : $this
The instruction address for this location, if available. It should be within [Mapping.memory_start...Mapping.memory_limit] for the corresponding mapping. A non-leaf address may be in the middle of a call instruction. It is up to display tools to find the beginning of the instruction if necessary.
setAttributeIndices()  : $this
References to attributes in Profile.attribute_table. [optional]
setIsFolded()  : $this
Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In that case the line information above represents one of the multiple symbols. This field must be recomputed when the symbolization state of the profile changes.
setLine()  : $this
Multiple line indicates this location has inlined functions, where the last entry represents the caller into which the preceding entries were inlined.
setMappingIndex()  : $this
Reference to mapping in Profile.mapping_table.

Properties

$address

The instruction address for this location, if available. It should be within [Mapping.memory_start...Mapping.memory_limit] for the corresponding mapping. A non-leaf address may be in the middle of a call instruction. It is up to display tools to find the beginning of the instruction if necessary.

protected mixed $address = 0

Generated from protobuf field uint64 address = 2;

$is_folded

Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In that case the line information above represents one of the multiple symbols. This field must be recomputed when the symbolization state of the profile changes.

protected mixed $is_folded = false

Generated from protobuf field bool is_folded = 4;

$mapping_index

Reference to mapping in Profile.mapping_table.

protected mixed $mapping_index = null

It can be unset if the mapping is unknown or not applicable for this profile type.

Generated from protobuf field optional int32 mapping_index = 1;

$attribute_indices

References to attributes in Profile.attribute_table. [optional]

private mixed $attribute_indices

Generated from protobuf field repeated int32 attribute_indices = 5;

$line

Multiple line indicates this location has inlined functions, where the last entry represents the caller into which the preceding entries were inlined.

private mixed $line

E.g., if memcpy() is inlined into printf: line[0].function_name == "memcpy" line[1].function_name == "printf"

Generated from protobuf field repeated .opentelemetry.proto.profiles.v1development.Line line = 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 $mapping_index
      Reference to mapping in Profile.mapping_table.
      It can be unset if the mapping is unknown or not applicable for
      this profile type.
@type int|string $address
      The instruction address for this location, if available.  It
      should be within [Mapping.memory_start...Mapping.memory_limit]
      for the corresponding mapping. A non-leaf address may be in the
      middle of a call instruction. It is up to display tools to find
      the beginning of the instruction if necessary.
@type \Opentelemetry\Proto\Profiles\V1development\Line[]|\Google\Protobuf\Internal\RepeatedField $line
      Multiple line indicates this location has inlined functions,
      where the last entry represents the caller into which the
      preceding entries were inlined.
      E.g., if memcpy() is inlined into printf:
         line[0].function_name == "memcpy"
         line[1].function_name == "printf"
@type bool $is_folded
      Provides an indication that multiple symbols map to this location's
      address, for example due to identical code folding by the linker. In that
      case the line information above represents one of the multiple
      symbols. This field must be recomputed when the symbolization state of the
      profile changes.
@type int[]|\Google\Protobuf\Internal\RepeatedField $attribute_indices
      References to attributes in Profile.attribute_table. [optional]

}

clearMappingIndex()

public clearMappingIndex() : mixed

getAddress()

The instruction address for this location, if available. It should be within [Mapping.memory_start...Mapping.memory_limit] for the corresponding mapping. A non-leaf address may be in the middle of a call instruction. It is up to display tools to find the beginning of the instruction if necessary.

public getAddress() : int|string

Generated from protobuf field uint64 address = 2;

Return values
int|string

getAttributeIndices()

References to attributes in Profile.attribute_table. [optional]

public getAttributeIndices() : RepeatedField

Generated from protobuf field repeated int32 attribute_indices = 5;

Return values
RepeatedField

getIsFolded()

Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In that case the line information above represents one of the multiple symbols. This field must be recomputed when the symbolization state of the profile changes.

public getIsFolded() : bool

Generated from protobuf field bool is_folded = 4;

Return values
bool

getLine()

Multiple line indicates this location has inlined functions, where the last entry represents the caller into which the preceding entries were inlined.

public getLine() : RepeatedField

E.g., if memcpy() is inlined into printf: line[0].function_name == "memcpy" line[1].function_name == "printf"

Generated from protobuf field repeated .opentelemetry.proto.profiles.v1development.Line line = 3;

Return values
RepeatedField

getMappingIndex()

Reference to mapping in Profile.mapping_table.

public getMappingIndex() : int

It can be unset if the mapping is unknown or not applicable for this profile type.

Generated from protobuf field optional int32 mapping_index = 1;

Return values
int

hasMappingIndex()

public hasMappingIndex() : mixed

setAddress()

The instruction address for this location, if available. It should be within [Mapping.memory_start...Mapping.memory_limit] for the corresponding mapping. A non-leaf address may be in the middle of a call instruction. It is up to display tools to find the beginning of the instruction if necessary.

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

Generated from protobuf field uint64 address = 2;

Parameters
$var : int|string
Return values
$this

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

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

setIsFolded()

Provides an indication that multiple symbols map to this location's address, for example due to identical code folding by the linker. In that case the line information above represents one of the multiple symbols. This field must be recomputed when the symbolization state of the profile changes.

public setIsFolded(bool $var) : $this

Generated from protobuf field bool is_folded = 4;

Parameters
$var : bool
Return values
$this

setLine()

Multiple line indicates this location has inlined functions, where the last entry represents the caller into which the preceding entries were inlined.

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

E.g., if memcpy() is inlined into printf: line[0].function_name == "memcpy" line[1].function_name == "printf"

Generated from protobuf field repeated .opentelemetry.proto.profiles.v1development.Line line = 3;

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

setMappingIndex()

Reference to mapping in Profile.mapping_table.

public setMappingIndex(int $var) : $this

It can be unset if the mapping is unknown or not applicable for this profile type.

Generated from protobuf field optional int32 mapping_index = 1;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results