UrlExperimentalAttributes

org.typelevel.otel4s.semconv.experimental.attributes.UrlExperimentalAttributes

Attributes

Source
UrlExperimentalAttributes.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete fields

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

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

Attributes

Note

  • 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 <a href="https://www.rfc-editor.org/rfc/rfc2732#section-2">literal IPv6 address enclosed by `[` and `]`, the `[` and `]` characters should also be captured in the domain field.

Source
UrlExperimentalAttributes.scala

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

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

Attributes

Note

  • 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.

Source
UrlExperimentalAttributes.scala

Unmodified original URL as seen in the event source.

Unmodified original URL as seen in the event source.

Attributes

Note

  • 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:[email protected]/. In such case password and username SHOULD NOT be redacted and attribute's value SHOULD remain the same.

Source
UrlExperimentalAttributes.scala

Port extracted from the url.full

Port extracted from the url.full

Attributes

Source
UrlExperimentalAttributes.scala

The highest registered url domain, stripped of the subdomain.

The highest registered url domain, stripped of the subdomain.

Attributes

Note

  • This value can be determined precisely with the <a href="http://publicsuffix.org">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`.

Source
UrlExperimentalAttributes.scala

The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain.

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.

Attributes

Note

  • 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.

Source
UrlExperimentalAttributes.scala

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

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.

Attributes

Note

  • This value can be determined precisely with the <a href="http://publicsuffix.org">public suffix list.

Source
UrlExperimentalAttributes.scala

Deprecated fields

The URI fragment component

The URI fragment component

Attributes

Deprecated
true
Source
UrlExperimentalAttributes.scala

Absolute URL describing a network resource according to <a href="https://www.rfc-editor.org/rfc/rfc3986">RFC3986

Absolute URL describing a network resource according to <a href="https://www.rfc-editor.org/rfc/rfc3986">RFC3986

Attributes

Note

  • 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:[email protected]/. In such case username and password SHOULD be redacted and attribute's value SHOULD be https://REDACTED:[email protected]/. 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.

Deprecated
true
Source
UrlExperimentalAttributes.scala

The URI path component

The URI path component

Attributes

Note

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

Deprecated
true
Source
UrlExperimentalAttributes.scala

The URI query component

The URI query component

Attributes

Note

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

Deprecated
true
Source
UrlExperimentalAttributes.scala

The URI scheme component identifying the used protocol.

The URI scheme component identifying the used protocol.

Attributes

Deprecated
true
Source
UrlExperimentalAttributes.scala