Module: OpenTelemetry::SemConv::Incubating::URL

Defined in:
lib/opentelemetry/semconv/incubating/url/attributes.rb

Attribute Names collapse

URL_DOMAIN =
Note:

Stability Level: development

Domain extracted from the url.full, such as “opentelemetry.io”.

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.

Examples:

Sample Values

www.foo.bar
opentelemetry.io
3.12.167.2
[1080:0:0:0:8:800:200C:417A]
'url.domain'
URL_EXTENSION =
Note:

Stability Level: development

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

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.

Examples:

Sample Values

png
gz
'url.extension'
URL_FRAGMENT =
Deprecated.

Now available in the stable namespace at URL::URL_FRAGMENT.

Note:

Stability Level: stable

The URI fragment component

Examples:

Sample Values

SemConv
'url.fragment'
URL_FULL =
Deprecated.

Now available in the stable namespace at URL::URL_FULL.

Note:

Stability Level: stable

Absolute URL describing a network resource according to 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.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.

Examples:

Sample Values

https://www.foo.bar/search?q=OpenTelemetry#SemConv
//localhost
'url.full'
URL_ORIGINAL =
Note:

Stability Level: development

Unmodified original URL as seen in the event source.

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.

Examples:

Sample Values

https://www.foo.bar/search?q=OpenTelemetry#SemConv
search?q=OpenTelemetry
'url.original'
URL_PATH =
Deprecated.

Now available in the stable namespace at URL::URL_PATH.

Note:

Stability Level: stable

The URI path component

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

Examples:

Sample Values

/search
'url.path'
URL_PORT =
Note:

Stability Level: development

Port extracted from the url.full

Examples:

Sample Values

443
'url.port'
URL_QUERY =
Deprecated.

Now available in the stable namespace at URL::URL_QUERY.

Note:

Stability Level: stable

The URI query component

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.

Examples:

Sample Values

q=OpenTelemetry
'url.query'
URL_REGISTERED_DOMAIN =
Note:

Stability Level: development

The highest registered url domain, stripped of the subdomain.

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.

Examples:

Sample Values

example.com
foo.co.uk
'url.registered_domain'
URL_SCHEME =
Deprecated.

Now available in the stable namespace at URL::URL_SCHEME.

Note:

Stability Level: stable

The URI scheme component identifying the used protocol.

Examples:

Sample Values

https
ftp
telnet
'url.scheme'
URL_SUBDOMAIN =
Note:

Stability Level: development

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.

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.

Examples:

Sample Values

east
sub2.sub1
'url.subdomain'
URL_TEMPLATE =
Note:

Stability Level: development

The low-cardinality template of an absolute path reference.

Examples:

Sample Values

/users/{id}
/users/:id
/users?id={id}
'url.template'
URL_TOP_LEVEL_DOMAIN =
Note:

Stability Level: development

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.

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

Examples:

Sample Values

com
co.uk
'url.top_level_domain'