Module: OpenTelemetry::SemConv::URL
- Defined in:
- lib/opentelemetry/semconv/url/attributes.rb
Attribute Names collapse
- URL_FRAGMENT =
Note:
Stability Level: stable
The URI fragment component
'url.fragment'
- URL_FULL =
Note:
Stability Level: stable
Absolute URL describing a network resource according to RFC3986
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 ofhttps://username:password@www.example.com/
. In such case username and password SHOULD be redacted and attribute’s value SHOULD behttps://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.full'
- URL_PATH =
Note:
Stability Level: stable
The URI path component
Sensitive content provided in
url.path
SHOULD be scrubbed when instrumentations can identify it. 'url.path'
- URL_QUERY =
Note:
Stability Level: stable
The URI query component
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.query'
- URL_SCHEME =
Note:
Stability Level: stable
The URI scheme component identifying the used protocol.
'url.scheme'