OpenTelemetry PHP

ClientIncubatingAttributes

Semantic attributes and corresponding values for client.

Tags
see
https://opentelemetry.io/docs/specs/semconv/registry/attributes/client/

May contain @experimental Semantic Conventions which may change or be removed in the future.

Table of Contents

Constants

CLIENT_ADDRESS  : mixed = 'client.address'
Client address - domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name.
CLIENT_AS_NUMBER  : mixed = 'client.as.number'
The [Autonomous System Number (ASN)](https://www.iana.org/assignments/as-numbers/as-numbers.xhtml) associated with the client IP address.
CLIENT_AS_ORGANIZATION  : mixed = 'client.as.organization'
The name of the organization associated with the autonomous system of the client IP address.
CLIENT_MAC_ADDRESS  : mixed = 'client.mac.address'
Client Media Access Control (MAC) address.
CLIENT_PORT  : mixed = 'client.port'
Client port number.
CLIENT_PREFIX  : mixed = 'client.prefix'
The IP prefix associated with the client IP address, in CIDR notation.
CLIENT_SERVICE_NAME  : mixed = 'client.service.name'
Logical name of the service acting as the client in a connection-based network interaction.
CLIENT_SERVICE_NAMESPACE  : mixed = 'client.service.namespace'
Logical namespace of the service acting as the client in a connection-based network interaction.

Constants

CLIENT_ADDRESS

Client address - domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name.

public mixed CLIENT_ADDRESS = 'client.address'

When observed from the server side, and when communicating through an intermediary, client.address SHOULD represent the client address behind any intermediaries, for example proxies, if it's available.

Tags
stable

CLIENT_AS_NUMBER

The [Autonomous System Number (ASN)](https://www.iana.org/assignments/as-numbers/as-numbers.xhtml) associated with the client IP address.

public mixed CLIENT_AS_NUMBER = 'client.as.number'

This attribute SHOULD only be set when the client address is an IP address and the ASN is available from routing, enrichment, or lookup data. The value SHOULD be represented as an integer without the AS prefix.

Tags
experimental

CLIENT_AS_ORGANIZATION

The name of the organization associated with the autonomous system of the client IP address.

public mixed CLIENT_AS_ORGANIZATION = 'client.as.organization'

This attribute SHOULD only be set when client.as.number is set and the organization name is available. The value SHOULD be the organization name as provided by the lookup or enrichment source, not the AS name or short code.

Tags
experimental

CLIENT_MAC_ADDRESS

Client Media Access Control (MAC) address.

public mixed CLIENT_MAC_ADDRESS = 'client.mac.address'

This attribute MUST identify a MAC address associated with the logical client endpoint, including when that endpoint is behind intermediaries. If the client's MAC address is unknown, this attribute MUST NOT be set. The MAC address of a proxy, gateway, or next-hop router MUST NOT be used as a substitute.

MAC addresses MUST be represented in IEEE RA hexadecimal form: as hyphen-separated octets in uppercase hexadecimal form from most to least significant.

[!WARNING]> This attribute may contain sensitive (PII) information.

Tags
experimental

CLIENT_PORT

Client port number.

public mixed CLIENT_PORT = 'client.port'

When observed from the server side, and when communicating through an intermediary, client.port SHOULD represent the client port behind any intermediaries, for example proxies, if it's available.

Tags
stable

CLIENT_PREFIX

The IP prefix associated with the client IP address, in CIDR notation.

public mixed CLIENT_PREFIX = 'client.prefix'

[!WARNING]> This attribute may contain sensitive (PII) information. A /32> IPv4 prefix or /128> IPv6 prefix preserves the complete endpoint IP address. Using CIDR notation does not guarantee that the data is anonymous.

The value MUST be an IPv4 or IPv6 network prefix in CIDR notation, as defined in RFC 4632 for IPv4 and RFC 4291 for IPv6. IPv4 prefixes MUST use a dotted-decimal address followed by / and a decimal prefix length from 0 to 32. IPv6 prefixes MUST use the canonical address text representation defined in RFC 5952, followed by / and a decimal prefix length from 0 to 128. All host bits in the address MUST be set to zero. The value MUST NOT contain a domain name, UNIX domain socket name, or IPv6 zone identifier.

Instrumentation or Collector receivers that populate this attribute MUST convert native representations, such as an address and subnet mask or an address and prefix length, to equivalent CIDR notation before emitting it.

This attribute MUST NOT be set unless client.address is set to an IPv4 or IPv6 address. The address MUST use the same IP version as this prefix and be contained in it.

Tags
experimental

CLIENT_SERVICE_NAME

Logical name of the service acting as the client in a connection-based network interaction.

public mixed CLIENT_SERVICE_NAME = 'client.service.name'

SHOULD be equal to the actual service.name resource attribute of the logical client, if any. This identifies the client service whether the telemetry is recorded by the client, the server, or another observer.

Tags
experimental

CLIENT_SERVICE_NAMESPACE

Logical namespace of the service acting as the client in a connection-based network interaction.

public mixed CLIENT_SERVICE_NAMESPACE = 'client.service.namespace'

SHOULD be equal to the actual service.namespace resource attribute of the logical client, if any. This identifies the client service's namespace whether the telemetry is recorded by the client, the server, or another observer. Together with client.service.name, this identifies the client service. An empty namespace is equivalent to an unspecified namespace.

Tags
experimental
On this page

Search results