View Source OpenTelemetry.SemConv.URLAttributes (OpenTelemetry.SemConv v1.27.0)
OpenTelemetry Semantic Conventions for URL attributes.
Summary
Functions
The URI fragment component
Absolute URL describing a network resource according to RFC3986
The URI path component
The URI query component
The URI scheme component identifying the used protocol.
Functions
@spec url_fragment() :: :"url.fragment"
The URI fragment component
Value type
Value must be of type atom() | String.t().
Examples
["SemConv"]iex> OpenTelemetry.SemConv.URLAttributes.url_fragment()
:"url.fragment"?URL_FRAGMENT.
'url.fragment'@spec url_full() :: :"url.full"
Absolute URL describing a network resource according to RFC3986
Value type
Value must be of type atom() | String.t().
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.
Examples
["https://www.foo.bar/search?q=OpenTelemetry#SemConv", "//localhost"]iex> OpenTelemetry.SemConv.URLAttributes.url_full()
:"url.full"?URL_FULL.
'url.full'@spec url_path() :: :"url.path"
The URI path component
Value type
Value must be of type atom() | String.t().
Notes
Sensitive content provided in url.path SHOULD be scrubbed when instrumentations can identify it.
Examples
["/search"]iex> OpenTelemetry.SemConv.URLAttributes.url_path()
:"url.path"?URL_PATH.
'url.path'@spec url_query() :: :"url.query"
The URI query component
Value type
Value must be of type atom() | String.t().
Notes
Sensitive content provided in url.query SHOULD be scrubbed when instrumentations can identify it.
Examples
["q=OpenTelemetry"]iex> OpenTelemetry.SemConv.URLAttributes.url_query()
:"url.query"?URL_QUERY.
'url.query'@spec url_scheme() :: :"url.scheme"
The URI scheme component identifying the used protocol.
Value type
Value must be of type atom() | String.t().
Examples
["https", "ftp", "telnet"]iex> OpenTelemetry.SemConv.URLAttributes.url_scheme()
:"url.scheme"?URL_SCHEME.
'url.scheme'