OpenTelemetry PHP

EntityRef extends Message
in package

A reference to an Entity.

Entity represents an object of interest associated with produced telemetry: e.g spans, metrics, profiles, or logs. Status: [Development]

Generated from protobuf message opentelemetry.proto.common.v1.EntityRef

Table of Contents

Properties

$schema_url  : mixed
The Schema URL, if known. This is the identifier of the Schema that the entity data is recorded in. To learn more about Schema URL see https://opentelemetry.io/docs/specs/otel/schemas/#schema-url This schema_url applies to the data in this message and to the Resource attributes referenced by id_keys and description_keys.
$type  : mixed
Defines the type of the entity. MUST not change during the lifetime of the entity.
$description_keys  : mixed
Descriptive (non-identifying) attribute keys of the entity.
$id_keys  : mixed
Attribute Keys that identify the entity.

Methods

__construct()  : mixed
Constructor.
getDescriptionKeys()  : RepeatedField
Descriptive (non-identifying) attribute keys of the entity.
getIdKeys()  : RepeatedField
Attribute Keys that identify the entity.
getSchemaUrl()  : string
The Schema URL, if known. This is the identifier of the Schema that the entity data is recorded in. To learn more about Schema URL see https://opentelemetry.io/docs/specs/otel/schemas/#schema-url This schema_url applies to the data in this message and to the Resource attributes referenced by id_keys and description_keys.
getType()  : string
Defines the type of the entity. MUST not change during the lifetime of the entity.
setDescriptionKeys()  : $this
Descriptive (non-identifying) attribute keys of the entity.
setIdKeys()  : $this
Attribute Keys that identify the entity.
setSchemaUrl()  : $this
The Schema URL, if known. This is the identifier of the Schema that the entity data is recorded in. To learn more about Schema URL see https://opentelemetry.io/docs/specs/otel/schemas/#schema-url This schema_url applies to the data in this message and to the Resource attributes referenced by id_keys and description_keys.
setType()  : $this
Defines the type of the entity. MUST not change during the lifetime of the entity.

Properties

$schema_url

The Schema URL, if known. This is the identifier of the Schema that the entity data is recorded in. To learn more about Schema URL see https://opentelemetry.io/docs/specs/otel/schemas/#schema-url This schema_url applies to the data in this message and to the Resource attributes referenced by id_keys and description_keys.

protected mixed $schema_url = ''

TODO: discuss if we are happy with this somewhat complicated definition of what the schema_url applies to. This field obsoletes the schema_url field in ResourceMetrics/ResourceSpans/ResourceLogs.

Generated from protobuf field string schema_url = 1;

$type

Defines the type of the entity. MUST not change during the lifetime of the entity.

protected mixed $type = ''

For example: "service" or "host". This field is required and MUST not be empty for valid entities.

Generated from protobuf field string type = 2;

$description_keys

Descriptive (non-identifying) attribute keys of the entity.

private mixed $description_keys

MAY change over the lifetime of the entity. MAY be empty. These attribute keys are not part of entity's identity. These keys MUST exist in the containing {message}.attributes.

Generated from protobuf field repeated string description_keys = 4;

$id_keys

Attribute Keys that identify the entity.

private mixed $id_keys

MUST not change during the lifetime of the entity. The Id must contain at least one attribute. These keys MUST exist in the containing {message}.attributes.

Generated from protobuf field repeated string id_keys = 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 string $schema_url
      The Schema URL, if known. This is the identifier of the Schema that the entity data
      is recorded in. To learn more about Schema URL see
      https://opentelemetry.io/docs/specs/otel/schemas/#schema-url
      This schema_url applies to the data in this message and to the Resource attributes
      referenced by id_keys and description_keys.
      TODO: discuss if we are happy with this somewhat complicated definition of what
      the schema_url applies to.
      This field obsoletes the schema_url field in ResourceMetrics/ResourceSpans/ResourceLogs.
@type string $type
      Defines the type of the entity. MUST not change during the lifetime of the entity.
      For example: "service" or "host". This field is required and MUST not be empty
      for valid entities.
@type string[]|\Google\Protobuf\Internal\RepeatedField $id_keys
      Attribute Keys that identify the entity.
      MUST not change during the lifetime of the entity. The Id must contain at least one attribute.
      These keys MUST exist in the containing {message}.attributes.
@type string[]|\Google\Protobuf\Internal\RepeatedField $description_keys
      Descriptive (non-identifying) attribute keys of the entity.
      MAY change over the lifetime of the entity. MAY be empty.
      These attribute keys are not part of entity's identity.
      These keys MUST exist in the containing {message}.attributes.

}

getDescriptionKeys()

Descriptive (non-identifying) attribute keys of the entity.

public getDescriptionKeys() : RepeatedField

MAY change over the lifetime of the entity. MAY be empty. These attribute keys are not part of entity's identity. These keys MUST exist in the containing {message}.attributes.

Generated from protobuf field repeated string description_keys = 4;

Return values
RepeatedField

getIdKeys()

Attribute Keys that identify the entity.

public getIdKeys() : RepeatedField

MUST not change during the lifetime of the entity. The Id must contain at least one attribute. These keys MUST exist in the containing {message}.attributes.

Generated from protobuf field repeated string id_keys = 3;

Return values
RepeatedField

getSchemaUrl()

The Schema URL, if known. This is the identifier of the Schema that the entity data is recorded in. To learn more about Schema URL see https://opentelemetry.io/docs/specs/otel/schemas/#schema-url This schema_url applies to the data in this message and to the Resource attributes referenced by id_keys and description_keys.

public getSchemaUrl() : string

TODO: discuss if we are happy with this somewhat complicated definition of what the schema_url applies to. This field obsoletes the schema_url field in ResourceMetrics/ResourceSpans/ResourceLogs.

Generated from protobuf field string schema_url = 1;

Return values
string

getType()

Defines the type of the entity. MUST not change during the lifetime of the entity.

public getType() : string

For example: "service" or "host". This field is required and MUST not be empty for valid entities.

Generated from protobuf field string type = 2;

Return values
string

setDescriptionKeys()

Descriptive (non-identifying) attribute keys of the entity.

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

MAY change over the lifetime of the entity. MAY be empty. These attribute keys are not part of entity's identity. These keys MUST exist in the containing {message}.attributes.

Generated from protobuf field repeated string description_keys = 4;

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

setIdKeys()

Attribute Keys that identify the entity.

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

MUST not change during the lifetime of the entity. The Id must contain at least one attribute. These keys MUST exist in the containing {message}.attributes.

Generated from protobuf field repeated string id_keys = 3;

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

setSchemaUrl()

The Schema URL, if known. This is the identifier of the Schema that the entity data is recorded in. To learn more about Schema URL see https://opentelemetry.io/docs/specs/otel/schemas/#schema-url This schema_url applies to the data in this message and to the Resource attributes referenced by id_keys and description_keys.

public setSchemaUrl(string $var) : $this

TODO: discuss if we are happy with this somewhat complicated definition of what the schema_url applies to. This field obsoletes the schema_url field in ResourceMetrics/ResourceSpans/ResourceLogs.

Generated from protobuf field string schema_url = 1;

Parameters
$var : string
Return values
$this

setType()

Defines the type of the entity. MUST not change during the lifetime of the entity.

public setType(string $var) : $this

For example: "service" or "host". This field is required and MUST not be empty for valid entities.

Generated from protobuf field string type = 2;

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results