From bea4a3386c33f01ea074e697cf5239f0986decfd Mon Sep 17 00:00:00 2001 From: OpenTelemetry Bot <107717825+opentelemetrybot@users.noreply.github.com> Date: Fri, 8 Nov 2024 18:00:43 -0600 Subject: [PATCH] Update opentelemetry-specification version to v1.39.0 (#5552) --- .gitmodules | 2 +- content-modules/opentelemetry-specification | 2 +- .../en/docs/languages/go/instrumentation.md | 2 +- .../en/docs/languages/java/api-components.md | 8 ++++---- .../en/docs/languages/java/instrumentation.md | 4 ++-- content/en/docs/specs/status.md | 2 +- .../en/docs/zero-code/python/logs-example.md | 2 +- scripts/content-modules/adjust-pages.pl | 18 +++++++++++++++++- static/refcache.json | 4 ++++ 9 files changed, 32 insertions(+), 12 deletions(-) diff --git a/.gitmodules b/.gitmodules index b444d2d24a00..a78309399754 100644 --- a/.gitmodules +++ b/.gitmodules @@ -7,7 +7,7 @@ [submodule "content-modules/opentelemetry-specification"] path = content-modules/opentelemetry-specification url = https://github.com/open-telemetry/opentelemetry-specification.git - spec-pin = v1.38.0 + spec-pin = v1.39.0 [submodule "content-modules/community"] path = content-modules/community url = https://github.com/open-telemetry/community diff --git a/content-modules/opentelemetry-specification b/content-modules/opentelemetry-specification index 0a78571045ca..8954d3b52509 160000 --- a/content-modules/opentelemetry-specification +++ b/content-modules/opentelemetry-specification @@ -1 +1 @@ -Subproject commit 0a78571045ca1dca48621c9648ec3c832c3c541c +Subproject commit 8954d3b525098dc4dadc364e7b82da9235c7f37e diff --git a/content/en/docs/languages/go/instrumentation.md b/content/en/docs/languages/go/instrumentation.md index 15987be1fc29..ef60971ac96a 100644 --- a/content/en/docs/languages/go/instrumentation.md +++ b/content/en/docs/languages/go/instrumentation.md @@ -1096,7 +1096,7 @@ telemetry backends. [instrumentation library]: ../libraries/ [opentelemetry collector]: https://github.com/open-telemetry/opentelemetry-collector -[logs bridge API]: /docs/specs/otel/logs/bridge-api +[logs bridge API]: /docs/specs/otel/logs/api/ [log data model]: /docs/specs/otel/logs/data-model [`go.opentelemetry.io/otel`]: https://pkg.go.dev/go.opentelemetry.io/otel [`go.opentelemetry.io/otel/exporters/stdout/stdoutmetric`]: diff --git a/content/en/docs/languages/java/api-components.md b/content/en/docs/languages/java/api-components.md index c5df547cdf7a..193019a6fe84 100644 --- a/content/en/docs/languages/java/api-components.md +++ b/content/en/docs/languages/java/api-components.md @@ -5,10 +5,10 @@ logBridgeWarning: > While the `LoggerProvider` / `Logger` APIs are structurally similar to the equivalent trace and metric APIs, they serve a different use case. As of now, `LoggerProvider` / `Logger` and associated classes represent the [Log Bridge - API](/docs/specs/otel/logs/bridge-api/), which exists to write log appenders - to bridge logs recorded through other log APIs / frameworks into - OpenTelemetry. They are not intended for end user use as a replacement for - Log4j / SLF4J / Logback / etc. + API](/docs/specs/otel/logs/api/), which exists to write log appenders to + bridge logs recorded through other log APIs / frameworks into OpenTelemetry. + They are not intended for end user use as a replacement for Log4j / SLF4J / + Logback / etc. cSpell:ignore: Dotel kotlint Logback updowncounter --- diff --git a/content/en/docs/languages/java/instrumentation.md b/content/en/docs/languages/java/instrumentation.md index c08589bf13d6..1359be9759a0 100644 --- a/content/en/docs/languages/java/instrumentation.md +++ b/content/en/docs/languages/java/instrumentation.md @@ -191,8 +191,8 @@ While the [LoggerProvider](../api-components/#loggerprovider) / equivalent [trace](../api-components/#tracerprovider) and [metric](../api-components/#meterprovider) APIs, they serve a different use case. As of now, `LoggerProvider` / `Logger` and associated classes represent -the [Log Bridge API](/docs/specs/otel/logs/bridge-api/), which exists to write -log appenders to bridge logs recorded through other log APIs / frameworks into +the [Log Bridge API](/docs/specs/otel/logs/api/), which exists to write log +appenders to bridge logs recorded through other log APIs / frameworks into OpenTelemetry. They are not intended for end user use as a replacement for Log4j / SLF4J / Logback / etc. diff --git a/content/en/docs/specs/status.md b/content/en/docs/specs/status.md index 31f336d495cd..82075dad9bb9 100644 --- a/content/en/docs/specs/status.md +++ b/content/en/docs/specs/status.md @@ -92,7 +92,7 @@ same as the **Protocol** status. ### [Logging][] -- {{% spec_status "Bridge API" "otel/logs/bridge-api" "Status" %}} +- {{% spec_status "Bridge API" "otel/logs/api" "Status" %}} - {{% spec_status "SDK" "otel/logs/sdk" "Status" %}} - {{% spec_status "Event API" "otel/logs/event-api" "Status" %}} - {{% spec_status "Protocol" "otlp" "Status" %}} diff --git a/content/en/docs/zero-code/python/logs-example.md b/content/en/docs/zero-code/python/logs-example.md index 3bd6076e1f0a..60ffff6b5bf4 100644 --- a/content/en/docs/zero-code/python/logs-example.md +++ b/content/en/docs/zero-code/python/logs-example.md @@ -24,7 +24,7 @@ auto-instrumentation of logs. The example below is based on the logs example in > Metrics API, because it's not used by application developers to create logs. > Instead, they would use this bridge API to setup log appenders in the standard > language-specific logging libraries. More information can be found -> [here](/docs/specs/otel/logs/bridge-api). +> [here](/docs/specs/otel/logs/api/). Start by creating the examples directory and the example Python file: diff --git a/scripts/content-modules/adjust-pages.pl b/scripts/content-modules/adjust-pages.pl index ae801b5728eb..edc02477ec56 100755 --- a/scripts/content-modules/adjust-pages.pl +++ b/scripts/content-modules/adjust-pages.pl @@ -18,13 +18,14 @@ my $semConvRef = "$otelSpecRepoUrl/blob/main/semantic_conventions/README.md"; my $specBasePath = '/docs/specs'; my %versions = qw( - spec: 1.38.0 + spec: 1.39.0 otlp: 1.3.2 semconv: 1.28.0 ); my $otelSpecVers = $versions{'spec:'}; my $otlpSpecVers = $versions{'otlp:'}; my $semconvVers = $versions{'semconv:'}; +my $warn2 = 0; # TODO remove along with warning 002 sub printTitleAndFrontMatter() { print "---\n"; @@ -42,6 +43,12 @@ () $frontMatterFromFile =~ s/linkTitle: .*/$& $semconvVers/; # $frontMatterFromFile =~ s/body_class: .*/$& td-page--draft/; # $frontMatterFromFile =~ s/cascade:\n/$& draft: true\n/; + } elsif ($ARGV =~ /otel\/specification\/logs\/api.md$/) { + if ($otelSpecVers ne "1.39.0") { + # TODO: delete the enclosing elsif body + print STDOUT "WARNING [001]: $0: remove obsolete code now that OTel spec has been updated.\n" + } + $frontMatterFromFile .= "linkTitle: API\naliases: [bridge-api]\n"; } my $titleMaybeQuoted = ($title =~ ':') ? "\"$title\"" : $title; print "title: $titleMaybeQuoted\n" if $frontMatterFromFile !~ /title: /; @@ -109,6 +116,15 @@ () # SPECIFICATION custom processing + # TODO: drop the entire if-then-else statement patch code when OTel spec vers contains + # https://github.com/open-telemetry/opentelemetry-specification/pull/4287, + # which should be vers > 1.39.0. + if ($otelSpecVers eq "1.39.0") { + s|(/api\.md)#logs-api\b|$1|g; + } elsif ($ARGV =~ /otel\/spec/) { + print STDOUT "WARNING [002]: $0: remove obsolete code now that OTel spec has been updated.\n" unless $warn2++ + } + s|\(https://github.com/open-telemetry/opentelemetry-specification\)|($specBasePath/otel/)|; s|(\]\()/specification/|$1$specBasePath/otel/)|; s|\.\./semantic_conventions/README.md|$semConvRef| if $ARGV =~ /overview/; diff --git a/static/refcache.json b/static/refcache.json index 0f24cedfa09c..e8979de1698c 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -5075,6 +5075,10 @@ "StatusCode": 200, "LastSeen": "2024-06-12T11:21:46.656082+02:00" }, + "https://github.com/golang/go/issues/68652#issuecomment-2274452424": { + "StatusCode": 200, + "LastSeen": "2024-11-07T20:32:07.730871-05:00" + }, "https://github.com/google/pprof": { "StatusCode": 200, "LastSeen": "2024-10-24T15:10:16.695786+02:00"