40 lines
2.0 KiB
YAML
40 lines
2.0 KiB
YAML
groups:
|
|
- id: url
|
|
brief: Attributes describing URL.
|
|
type: attribute_group
|
|
prefix: url
|
|
attributes:
|
|
- id: scheme
|
|
type: string
|
|
brief: 'The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol.'
|
|
examples: ["https", "ftp", "telnet"]
|
|
- id: full
|
|
type: string
|
|
brief: Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986)
|
|
note: >
|
|
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)
|
|
and SHOULD NOT be validated or modified except for sanitizing purposes.
|
|
examples: ['https://www.foo.bar/search?q=OpenTelemetry#SemConv', '//localhost']
|
|
tag: sensitive-information
|
|
- id: path
|
|
type: string
|
|
brief: 'The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component'
|
|
examples: ['/search']
|
|
note: When missing, the value is assumed to be `/`
|
|
- id: query
|
|
type: string
|
|
brief: 'The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component'
|
|
examples: ["q=OpenTelemetry"]
|
|
note: Sensitive content provided in query string SHOULD be scrubbed when instrumentations can identify it.
|
|
tag: sensitive-information
|
|
- id: fragment
|
|
type: string
|
|
brief: 'The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component'
|
|
examples: ["SemConv"]
|