Url Attributes

9 attributes in this category. 9 stable

Stable Attributes

url.domain

string PII: Maybe OTel: True

Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.

Example example.com
Raw JSON
{
  "key": "url.domain",
  "brief": "Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "example.com"
}

url.fragment

string PII: Maybe OTel: True

The fragments present in the URI. Note that this does not contain the leading # character, while the `http.fragment` attribute does.

Example details
Raw JSON
{
  "key": "url.fragment",
  "brief": "The fragments present in the URI. Note that this does not contain the leading # character, while the `http.fragment` attribute does.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "details"
}

url.full

string PII: Maybe OTel: True

The URL of the resource that was fetched.

Example https://example.com/test?foo=bar#buzz
Aliases http.urlurl
Raw JSON
{
  "key": "url.full",
  "brief": "The URL of the resource that was fetched.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "https://example.com/test?foo=bar#buzz",
  "alias": [
    "http.url",
    "url"
  ]
}

url.path

string PII: Maybe OTel: True

The URI path component.

Example /foo
Raw JSON
{
  "key": "url.path",
  "brief": "The URI path component.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "/foo"
}

url.path.parameter.<key>

string PII: Maybe OTel: False Dynamic

Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.

Example url.path.parameter.id='123'
Aliases params.<key>
Dynamic Suffix Yes - the key contains dynamic parts
Raw JSON
{
  "key": "url.path.parameter.<key>",
  "brief": "Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.",
  "has_dynamic_suffix": true,
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "url.path.parameter.id='123'",
  "alias": [
    "params.<key>"
  ]
}

url.port

integer PII: Maybe OTel: True

Server port number.

Example 1337
Raw JSON
{
  "key": "url.port",
  "brief": "Server port number.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": 1337
}

url.query

string PII: Maybe OTel: True

The query string present in the URL. Note that this does not contain the leading ? character, while the `http.query` attribute does.

PII Reason Query string values can contain sensitive information. Clients should attempt to scrub parameters that might contain sensitive information.
Example foo=bar&bar=baz
Raw JSON
{
  "key": "url.query",
  "brief": "The query string present in the URL. Note that this does not contain the leading ? character, while the `http.query` attribute does.",
  "type": "string",
  "pii": {
    "key": "maybe",
    "reason": "Query string values can contain sensitive information. Clients should attempt to scrub parameters that might contain sensitive information."
  },
  "is_in_otel": true,
  "example": "foo=bar&bar=baz"
}

url.scheme

string PII: Maybe OTel: True

The URI scheme component identifying the used protocol.

Example https
Aliases http.scheme
Raw JSON
{
  "key": "url.scheme",
  "brief": "The URI scheme component identifying the used protocol.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "https",
  "alias": [
    "http.scheme"
  ]
}

url.template

string PII: Maybe OTel: True

The low-cardinality template of an absolute path reference.

Example /users/:id
Aliases http.route
Raw JSON
{
  "key": "url.template",
  "brief": "The low-cardinality template of an absolute path reference.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "/users/:id",
  "alias": [
    "http.route"
  ]
}