From 23d542d7fcd431b38e69970b7f3aadf37b51421e Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Thu, 2 Nov 2023 08:23:02 -0700 Subject: [PATCH] Change sampling relevant from MUST to SHOULD (and update build-tools version) --- CHANGELOG.md | 2 ++ Makefile | 2 +- docs/http/http-spans.md | 6 +++--- internal/tools/schema_check.sh | 2 +- 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7ed68fab38..e8932ee330 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -52,6 +52,8 @@ release. ([#478](https://github.com/open-telemetry/semantic-conventions/pull/478)) - Remove outdated `http.request.header.host` guidance ([#479](https://github.com/open-telemetry/semantic-conventions/pull/479)) +- Change sampling relevant from `MUST` to `SHOULD` + ([#486](https://github.com/open-telemetry/semantic-conventions/pull/486)) ### Features diff --git a/Makefile b/Makefile index c6d956424b..ca93385774 100644 --- a/Makefile +++ b/Makefile @@ -8,7 +8,7 @@ MISSPELL = $(TOOLS_DIR)/$(MISSPELL_BINARY) # see https://github.com/open-telemetry/build-tools/releases for semconvgen updates # Keep links in model/README.md and .vscode/settings.json in sync! -SEMCONVGEN_VERSION=0.22.0 +SEMCONVGEN_VERSION=0.23.0 # TODO: add `yamllint` step to `all` after making sure it works on Mac. .PHONY: all diff --git a/docs/http/http-spans.md b/docs/http/http-spans.md index d3f9156c8a..42ccfb7375 100644 --- a/docs/http/http-spans.md +++ b/docs/http/http-spans.md @@ -180,7 +180,7 @@ The attribute value MUST consist of either multiple header values as an array of **[9]:** Generally `tcp` for `HTTP/1.0`, `HTTP/1.1`, and `HTTP/2`. Generally `udp` for `HTTP/3`. Other obscure implementations are possible. -Following attributes MUST be provided **at span creation time** (when provided at all), so they can be considered for sampling decisions: +The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): * [`http.request.method`](../attributes-registry/http.md) @@ -249,7 +249,7 @@ For an HTTP client span, `SpanKind` MUST be `Client`. `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. -Following attributes MUST be provided **at span creation time** (when provided at all), so they can be considered for sampling decisions: +The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](../general/attributes.md) * [`server.port`](../general/attributes.md) @@ -366,7 +366,7 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin **[7]:** The scheme of the original client request, if known (e.g. from [Forwarded#proto](https://developer.mozilla.org/docs/Web/HTTP/Headers/Forwarded#proto), [X-Forwarded-Proto](https://developer.mozilla.org/docs/Web/HTTP/Headers/X-Forwarded-Proto), or a similar header). Otherwise, the scheme of the immediate peer request. -Following attributes MUST be provided **at span creation time** (when provided at all), so they can be considered for sampling decisions: +The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): * [`client.address`](../general/attributes.md) * [`server.address`](../general/attributes.md) diff --git a/internal/tools/schema_check.sh b/internal/tools/schema_check.sh index 32c489d1a7..801fcee04f 100755 --- a/internal/tools/schema_check.sh +++ b/internal/tools/schema_check.sh @@ -6,7 +6,7 @@ set -e -BUILD_TOOL_SCHEMAS_VERSION=0.22.0 +BUILD_TOOL_SCHEMAS_VERSION=0.23.0 # List of versions that do not require or have a schema. declare -a skip_versions=("1.0.0" "1.0.1" "1.1.0" "1.2.0" "1.3.0" "1.6.0")