Skip to content

Commit 85a97ce

Browse files
committed
Merge remote-tracking branch 'upstream/main' into forwarded-server-address-port
2 parents a189837 + aebcb07 commit 85a97ce

File tree

14 files changed

+110
-91
lines changed

14 files changed

+110
-91
lines changed

CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,22 @@ release.
1111

1212
- BREAKING: Rename http.resend_count to http.request.resend_count.
1313
([#374](https://github.com/open-telemetry/semantic-conventions/pull/374))
14+
- BREAKING: Change `network.protocol.name` from recommended to opt-in in HTTP semconv.
15+
([#398](https://github.com/open-telemetry/semantic-conventions/pull/398))
1416
- BREAKING: Define url.scheme in terms of logical operation in HTTP server semconv.
1517
([#376](https://github.com/open-telemetry/semantic-conventions/pull/376))
1618
- BREAKING: Change `network.transport` from recommended to opt-in in HTTP semconv.
1719
([#402](https://github.com/open-telemetry/semantic-conventions/pull/402))
20+
- BREAKING: Change `network.type` from recommended to opt-in in HTTP semconv.
21+
([#410](https://github.com/open-telemetry/semantic-conventions/pull/410))
1822
- BREAKING: Factor in `X-Forwarded-Host` / `Forwarded` when capturing `server.address` and `server.port`.
1923
([#411](https://github.com/open-telemetry/semantic-conventions/pull/411))
2024

2125
### Features
2226

27+
- Metric namespaces SHOULD NOT be pluralized.
28+
([#267](https://github.com/open-telemetry/opentelemetry-specification/pull/267))
29+
2330
### Fixes
2431

2532
- Clarify that `error.type` should be the fully-qualified exception class name
@@ -31,6 +38,8 @@ release.
3138
([#399](https://github.com/open-telemetry/semantic-conventions/pull/399))
3239
- Add cardinality warning about two opt-in HTTP metric attributes to all HTTP metrics.
3340
([#412](https://github.com/open-telemetry/semantic-conventions/pull/412))
41+
- Remove outdated note about not recording HTTP `server.address` when only IP address available.
42+
([#413](https://github.com/open-telemetry/semantic-conventions/pull/413))
3443

3544
## v1.22.0 (2023-10-12)
3645

docs/attributes-registry/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,6 @@ All registered attributes are listed by namespace in this registry.
2828
Currently, the following namespaces exist:
2929

3030
* [HTTP](http.md)
31+
* [URL](url.md)
3132

3233
[developers recommendations]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/common/attribute-naming.md#recommendations-for-application-developers

docs/attributes-registry/url.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--- Hugo front matter used to generate the website version of this page:
2+
linkTitle: URL
3+
--->
4+
# URL
5+
6+
## URL Attributes
7+
8+
<!-- semconv registry.url(omit_requirement_level) -->
9+
| Attribute | Type | Description | Examples |
10+
|---|---|---|---|
11+
| `url.fragment` | string | The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component | `SemConv` |
12+
| `url.full` | string | Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) [1] | `https://www.foo.bar/search?q=OpenTelemetry#SemConv`; `//localhost` |
13+
| `url.path` | string | The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component [2] | `/search` |
14+
| `url.query` | string | The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component [3] | `q=OpenTelemetry` |
15+
| `url.scheme` | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `https`; `ftp`; `telnet` |
16+
17+
**[1]:** 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.
18+
`url.full` MUST NOT contain credentials passed via URL in form of `https://username:[email protected]/`. In such case username and password should be redacted and attribute's value should be `https://REDACTED:[email protected]/`.
19+
`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.
20+
21+
**[2]:** When missing, the value is assumed to be `/`
22+
23+
**[3]:** Sensitive content provided in query string SHOULD be scrubbed when instrumentations can identify it.
24+
<!-- endsemconv -->

docs/database/elasticsearch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ If the endpoint id is not available, the span name SHOULD be the `http.request.m
3434
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [6] | `GET`; `POST`; `HEAD` | Required |
3535
| [`server.address`](../general/attributes.md) | string | Name of the database host. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
3636
| [`server.port`](../general/attributes.md) | int | Server port number. [8] | `80`; `8080`; `443` | Conditionally Required: [9] |
37-
| [`url.full`](../url/url.md) | string | Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) [10] | `https://localhost:9200/index/_search?q=user.id:kimchy` | Required |
37+
| [`url.full`](../attributes-registry/url.md) | string | Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) [10] | `https://localhost:9200/index/_search?q=user.id:kimchy` | Required |
3838

3939
**[1]:** When communicating with an Elastic Cloud deployment, this should be collected from the "X-Found-Handling-Cluster" HTTP response header.
4040

docs/general/metrics.md

+2
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ using the OpenMetrics exposition format, use the
105105

106106
#### Pluralization
107107

108+
Metric namespaces SHOULD NOT be pluralized.
109+
108110
Metric names SHOULD NOT be pluralized, unless the value being recorded
109111
represents discrete instances of a
110112
[countable quantity](https://en.wikipedia.org/wiki/Count_noun).

0 commit comments

Comments
 (0)