Url Attributes

10 attributes in this category. 9 stable · 1 deprecated

10 attributes

Stable Attributes

url.domain

string Scrub: Manual Visibility: Public OTel: True

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

Example example.com
Changelog
v0.1.0 #127
v0.0.0
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",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "example.com",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

url.fragment

string Scrub: Auto Visibility: Public 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
Changelog
v0.0.0
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",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "details",
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

url.full

string Scrub: Auto Visibility: Public OTel: True

The URL of the resource that was fetched.

Example https://example.com/test?foo=bar#buzz
Aliases http.urlurl
Changelog
v0.1.0 #108
v0.0.0
Raw JSON 
{
  "key": "url.full",
  "brief": "The URL of the resource that was fetched.",
  "type": "string",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "https://example.com/test?foo=bar#buzz",
  "alias": [
    "http.url",
    "url"
  ],
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        108
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

url.path

string Scrub: Auto Visibility: Public OTel: True

The URI path component.

Example /foo
Changelog
v0.0.0
Raw JSON 
{
  "key": "url.path",
  "brief": "The URI path component.",
  "type": "string",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "/foo",
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

url.path.parameter.<key>

string Scrub: Auto Visibility: Public 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
Changelog
v0.1.0 #103
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",
  "apply_scrubbing": {
    "key": "auto"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": "url.path.parameter.id='123'",
  "alias": [
    "params.<key>"
  ],
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        103
      ]
    }
  ]
}

url.port

integer Scrub: Manual Visibility: Public OTel: True

Server port number.

Example 1337
Changelog
v0.4.0 #228
v0.0.0
Raw JSON 
{
  "key": "url.port",
  "brief": "Server port number.",
  "type": "integer",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": 1337,
  "changelog": [
    {
      "version": "0.4.0",
      "prs": [
        228
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

url.query

string Scrub: Auto Visibility: Public OTel: True

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

Scrubbing Reason Query string values can contain sensitive information. Clients should attempt to scrub parameters that might contain sensitive information.
Example foo=bar&bar=baz
Changelog
v0.0.0
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",
  "apply_scrubbing": {
    "key": "auto",
    "reason": "Query string values can contain sensitive information. Clients should attempt to scrub parameters that might contain sensitive information."
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "foo=bar&bar=baz",
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

url.scheme

string Scrub: Manual Visibility: Public OTel: True

The URI scheme component identifying the used protocol.

Example https
Aliases http.scheme
Changelog
v0.1.0 #127
v0.0.0
Raw JSON 
{
  "key": "url.scheme",
  "brief": "The URI scheme component identifying the used protocol.",
  "type": "string",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "https",
  "alias": [
    "http.scheme"
  ],
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

url.template

string Scrub: Manual Visibility: Public OTel: True

The low-cardinality template of an absolute path reference.

Examples /users/{id}/users/:id/about
Aliases http.route
Changelog
next #505 Added multiple examples
v0.1.0 #127
v0.0.0
Raw JSON 
{
  "key": "url.template",
  "brief": "The low-cardinality template of an absolute path reference.",
  "type": "string",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": true,
  "visibility": "public",
  "examples": [
    "/users/{id}",
    "/users/:id",
    "/about"
  ],
  "alias": [
    "http.route"
  ],
  "changelog": [
    {
      "version": "next",
      "prs": [
        505
      ],
      "description": "Added multiple examples"
    },
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

Deprecated Attributes

These attributes are deprecated and should not be used in new code. See each attribute for migration guidance.

url.same_origin Deprecated

boolean Scrub: Manual Visibility: Public OTel: False

Indicates that a URL has the same origin as the current page's origin in the browser.

Example true
Aliases http.request.same_origin

Use http.request.same_origin instead.

This attribute is being deprecated in favor of http.request.same_origin.

Status: backfill

Changelog
v0.16.0 #456 Added url.same_origin attribute, deprecated in favor of http.request.same_origin
Raw JSON 
{
  "key": "url.same_origin",
  "brief": "Indicates that a URL has the same origin as the current page's origin in the browser.",
  "type": "boolean",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": true,
  "deprecation": {
    "replacement": "http.request.same_origin",
    "reason": "This attribute is being deprecated in favor of http.request.same_origin.",
    "_status": "backfill"
  },
  "alias": [
    "http.request.same_origin"
  ],
  "changelog": [
    {
      "version": "0.16.0",
      "prs": [
        456
      ],
      "description": "Added url.same_origin attribute, deprecated in favor of http.request.same_origin"
    }
  ]
}