Package io.opentelemetry.semconv.incubating

Class UrlIncubatingAttributes

java.lang.Object
io.opentelemetry.semconv.incubating.UrlIncubatingAttributes
public final class UrlIncubatingAttributes extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_DOMAIN
    Domain extracted from the url.full, such as "opentelemetry.io".
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_EXTENSION
    The file extension extracted from the url.full, excluding the leading dot.
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_FRAGMENT
    Deprecated.
    deprecated in favor of stable UrlAttributes.URL_FRAGMENT attribute.
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_FULL
    Deprecated.
    deprecated in favor of stable UrlAttributes.URL_FULL attribute.
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_ORIGINAL
    Unmodified original URL as seen in the event source.
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_PATH
    Deprecated.
    deprecated in favor of stable UrlAttributes.URL_PATH attribute.
    static final io.opentelemetry.api.common.AttributeKey<Long>
    URL_PORT
    Port extracted from the url.full
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_QUERY
    Deprecated.
    deprecated in favor of stable UrlAttributes.URL_QUERY attribute.
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_REGISTERED_DOMAIN
    The highest registered url domain, stripped of the subdomain.
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_SCHEME
    Deprecated.
    deprecated in favor of stable UrlAttributes.URL_SCHEME attribute.
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_SUBDOMAIN
    The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain.
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_TEMPLATE
    The low-cardinality template of an absolute path reference.
    static final io.opentelemetry.api.common.AttributeKey<String>
    URL_TOP_LEVEL_DOMAIN
    The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name.

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • URL_DOMAIN

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_DOMAIN
      Domain extracted from the url.full, such as "opentelemetry.io".

      Notes:

      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.

    • URL_EXTENSION

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_EXTENSION
      The file extension extracted from the url.full, excluding the leading dot.

      Notes:

      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.

    • URL_FRAGMENT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> URL_FRAGMENT
      Deprecated.
      deprecated in favor of stable UrlAttributes.URL_FRAGMENT attribute.
      The URI fragment component

    • URL_FULL

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> URL_FULL
      Deprecated.
      deprecated in favor of stable UrlAttributes.URL_FULL attribute.
      Absolute URL describing a network resource according to RFC3986

      Notes:

      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.

    • URL_ORIGINAL

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_ORIGINAL
      Unmodified original URL as seen in the event source.

      Notes:

      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.

    • URL_PATH

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> URL_PATH
      Deprecated.
      deprecated in favor of stable UrlAttributes.URL_PATH attribute.
      The URI path component

      Notes:

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

    • URL_PORT

      public static final io.opentelemetry.api.common.AttributeKey<Long> URL_PORT
      Port extracted from the url.full

    • URL_QUERY

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> URL_QUERY
      Deprecated.
      deprecated in favor of stable UrlAttributes.URL_QUERY attribute.
      The URI query component

      Notes:

      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.

    • URL_REGISTERED_DOMAIN

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_REGISTERED_DOMAIN
      The highest registered url domain, stripped of the subdomain.

      Notes:

      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.

    • URL_SCHEME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> URL_SCHEME
      Deprecated.
      deprecated in favor of stable UrlAttributes.URL_SCHEME attribute.
      The URI scheme component identifying the used protocol.

    • URL_SUBDOMAIN

      public static final io.opentelemetry.api.common.AttributeKey<String> 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.

      Notes:

      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.

    • URL_TEMPLATE

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_TEMPLATE
      The low-cardinality template of an absolute path reference.

    • URL_TOP_LEVEL_DOMAIN

      public static final io.opentelemetry.api.common.AttributeKey<String> 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.

      Notes:

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