Package io.opentelemetry.semconv

Class UrlAttributes

java.lang.Object
io.opentelemetry.semconv.UrlAttributes
public final class UrlAttributes extends Object

  • Field Details

    • URL_FRAGMENT

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_FRAGMENT
      The URI fragment component

    • URL_FULL

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

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_PATH
      The URI path component

      Notes:

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

    • URL_QUERY

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

      public static final io.opentelemetry.api.common.AttributeKey<String> URL_SCHEME
      The URI scheme component identifying the used protocol.