OpenTelemetry PHP

UrlIncubatingAttributes
in

Semantic attributes and corresponding values for url.

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

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

Table of Contents

Constants

URL_DOMAIN  = 'url.domain'
Domain extracted from the `url.full`, such as "opentelemetry.io".
URL_EXTENSION  = 'url.extension'
The file extension extracted from the `url.full`, excluding the leading dot.
URL_FRAGMENT  = 'url.fragment'
The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component
URL_FULL  = 'url.full'
Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) For network calls, URL usually has `scheme://host[:port][path][?query][#fragment]` format, where the fragment is not transmitted over HTTP, but if it is known, it SHOULD be included nevertheless.
URL_ORIGINAL  = 'url.original'
Unmodified original URL as seen in the event source.
URL_PATH  = 'url.path'
The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component
URL_PORT  = 'url.port'
Port extracted from the `url.full`
URL_QUERY  = 'url.query'
The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component
URL_REGISTERED_DOMAIN  = 'url.registered_domain'
The highest registered url domain, stripped of the subdomain.
URL_SCHEME  = 'url.scheme'
The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol.
URL_SUBDOMAIN  = 'url.subdomain'
The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain.
URL_TEMPLATE  = 'url.template'
The low-cardinality template of an [absolute path reference](https://www.rfc-editor.org/rfc/rfc3986#section-4.2).
URL_TOP_LEVEL_DOMAIN  = 'url.top_level_domain'
The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is `com`.

Constants

URL_DOMAIN

Domain extracted from the `url.full`, such as "opentelemetry.io".

public mixed URL_DOMAIN = 'url.domain'

In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the domain field. If the URL contains a literal IPv6 address enclosed by [ and ], the [ and ] characters should also be captured in the domain field.

Tags
experimental

URL_EXTENSION

The file extension extracted from the `url.full`, excluding the leading dot.

public mixed URL_EXTENSION = 'url.extension'

The file extension is only set if it exists, as not every url has a file extension. When the file name has multiple extensions example.tar.gz, only the last one should be captured gz, not tar.gz.

Tags
experimental

URL_FRAGMENT

The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component

public mixed URL_FRAGMENT = 'url.fragment'
Tags
stable

URL_FULL

Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) For network calls, URL usually has `scheme://host[:port][path][?query][#fragment]` format, where the fragment is not transmitted over HTTP, but if it is known, it SHOULD be included nevertheless.

public mixed URL_FULL = 'url.full'

url.full MUST NOT contain credentials passed via URL in form of https://username:password@www.example.com/. In such case username and password SHOULD be redacted and attribute's value SHOULD be https://REDACTED:REDACTED@www.example.com/.

url.full SHOULD capture the absolute URL when it is available (or can be reconstructed).

Sensitive content provided in url.full SHOULD be scrubbed when instrumentations can identify it.

Query string values for the following keys SHOULD be redacted by default and replaced by the value REDACTED:

This list is subject to change over time.

When a query string value is redacted, the query string key SHOULD still be preserved, e.g. https://www.example.com/path?color=blue&sig=REDACTED.

Tags
stable

URL_ORIGINAL

Unmodified original URL as seen in the event source.

public mixed URL_ORIGINAL = 'url.original'

In network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path. This field is meant to represent the URL as it was observed, complete or not. url.original might contain credentials passed via URL in form of https://username:password@www.example.com/. In such case password and username SHOULD NOT be redacted and attribute's value SHOULD remain the same.

Tags
experimental

URL_PATH

The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component

public mixed URL_PATH = 'url.path'

Sensitive content provided in url.path SHOULD be scrubbed when instrumentations can identify it.

Tags
stable

URL_QUERY

The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component

public mixed URL_QUERY = 'url.query'

Sensitive content provided in url.query SHOULD be scrubbed when instrumentations can identify it.

Query string values for the following keys SHOULD be redacted by default and replaced by the value REDACTED:

This list is subject to change over time.

When a query string value is redacted, the query string key SHOULD still be preserved, e.g. q=OpenTelemetry&sig=REDACTED.

Tags
stable

URL_REGISTERED_DOMAIN

The highest registered url domain, stripped of the subdomain.

public mixed URL_REGISTERED_DOMAIN = 'url.registered_domain'

This value can be determined precisely with the public suffix list. For example, the registered domain for foo.example.com is example.com. Trying to approximate this by simply taking the last two labels will not work well for TLDs such as co.uk.

Tags
experimental

URL_SCHEME

The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol.

public mixed URL_SCHEME = 'url.scheme'
Tags
stable

URL_SUBDOMAIN

The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain.

public mixed URL_SUBDOMAIN = 'url.subdomain'

The subdomain portion of www.east.mydomain.co.uk is east. If the domain has multiple levels of subdomain, such as sub2.sub1.example.com, the subdomain field should contain sub2.sub1, with no trailing period.

Tags
experimental

URL_TEMPLATE

The low-cardinality template of an [absolute path reference](https://www.rfc-editor.org/rfc/rfc3986#section-4.2).

public mixed URL_TEMPLATE = 'url.template'
Tags
experimental

URL_TOP_LEVEL_DOMAIN

The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is `com`.

public mixed URL_TOP_LEVEL_DOMAIN = 'url.top_level_domain'

This value can be determined precisely with the public suffix list.

Tags
experimental 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results