Url Attributes

10 attributes in this category.9 stable·1 deprecated

10 attributes

Stable Attributes

url.domain

stringScrub: ManualVisibility: PublicOTel: True

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

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

stringScrub: AutoVisibility: PublicOTel: True

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

Exampledetails
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

stringScrub: AutoVisibility: PublicOTel: True

The URL of the resource that was fetched.

Examplehttps://example.com/test?foo=bar#buzz
Aliaseshttp.urlurlaws.request.url
Changelog
v0.19.0#488Added aws.request.url as an alias
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",
    "aws.request.url"
  ],
  "changelog": [
    {
      "version": "0.19.0",
      "prs": [
        488
      ],
      "description": "Added aws.request.url as an alias"
    },
    {
      "version": "0.1.0",
      "prs": [
        108
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

url.path

stringScrub: AutoVisibility: PublicOTel: 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>

stringScrub: AutoVisibility: PublicOTel: FalseDynamic

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

Exampleurl.path.parameter.id='123'
Aliasesparams.<key>
Dynamic SuffixYes - 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

integerScrub: ManualVisibility: PublicOTel: True

Server port number.

Example1337
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

stringScrub: AutoVisibility: PublicOTel: True

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

Scrubbing ReasonQuery string values can contain sensitive information. Clients should attempt to scrub parameters that might contain sensitive information.
Examplefoo=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

stringScrub: ManualVisibility: PublicOTel: True

The URI scheme component identifying the used protocol.

Examplehttps
Aliaseshttp.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

stringScrub: ManualVisibility: PublicOTel: True

The low-cardinality template of an absolute URL path reference.

Examples/users/{id}/users/:id/about
Additional Context
  • This attribute should primarily be set by client-side routing instrumentation, or `http.client` spans (if applicable).
  • Use `http.route` for server-side instrumentation that captures the framework route of an incoming request.
Changelog
v0.19.0#505#521Added multiple examples, removed alias to `http.route`, added additional context
v0.1.0#127
v0.0.0
Raw JSON
{
  "key": "url.template",
  "brief": "The low-cardinality template of an absolute URL path reference.",
  "type": "string",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": true,
  "visibility": "public",
  "examples": [
    "/users/{id}",
    "/users/:id",
    "/about"
  ],
  "additional_context": [
    "This attribute should primarily be set by client-side routing instrumentation, or `http.client` spans (if applicable).",
    "Use `http.route` for server-side instrumentation that captures the framework route of an incoming request."
  ],
  "changelog": [
    {
      "version": "0.19.0",
      "prs": [
        505,
        521
      ],
      "description": "Added multiple examples, removed alias to `http.route`, added additional context"
    },
    {
      "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_originDeprecated

booleanScrub: ManualVisibility: PublicOTel: False

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

Exampletrue
Aliaseshttp.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#456Added 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"
    }
  ]
}