Merge branch 'main' into theletterf-add-style-guide

open-telemetry · Jan 11, 2024 · ba1ee0d · ba1ee0d
2 parents 7acc40e + f8a7ec7
commit ba1ee0d
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 41 deletions.
diff --git a/.cspell.yml b/.cspell.yml
@@ -8,6 +8,19 @@ ignorePaths:
 # words here are only listed for their spelling, if there is a certain way
 # to write a word (e.g. OpenTelemetry vs Opentelemetry or cloud native vs
 # cloud-native), edit the text-lint rules in .textlintrc.yml
+patterns:
+  - name: CodeBlock
+    pattern: |
+      /
+          ^(\s*[~`]{3,})   # code-block start
+          .*               # all languages and options, e.g. shell {hl_lines=[12]}
+          [\s\S]*?         # content
+          \1               # code-block end
+      /igmx
+languageSettings:
+  - languageId: markdown
+    ignoreRegExpList:
+      - CodeBlock
 words:
   - accountingservice
   - adservice

diff --git a/content/en/blog/2022/instrument-nginx/index.md b/content/en/blog/2022/instrument-nginx/index.md
@@ -3,12 +3,10 @@ title: Learn how to instrument NGINX with OpenTelemetry
 linkTitle: Instrument Nginx
 date: 2022-08-22
 author: >-
-  [Debajit Das](https://github.com/debajitdas),  [Kumar
-  Pratyus](https://github.com/kpratyus),
-
-  [Severin Neumann](https://github.com/svrnm) (Cisco)
-# prettier-ignore
-cSpell:ignore: catalina Debajit Kumar Pratyus realip tracestate webserver WORKDIR xvfz
+  [Debajit Das](https://github.com/debajitdas), [Kumar
+  Pratyus](https://github.com/kpratyus), [Severin
+  Neumann](https://github.com/svrnm) (Cisco)
+cSpell:ignore: Debajit Kumar Pratyus webserver
 ---
 
 Apache HTTP Server and NGINX are the most popular web servers. It's most likely

diff --git a/content/en/blog/2023/any-metric-receiver.md b/content/en/blog/2023/any-metric-receiver.md
@@ -3,8 +3,7 @@ title: Receive any custom metric with the OpenTelemetry Collector
 linkTitle: Any Metric Receiver
 date: 2023-11-30
 author: '[Severin Neumann](https://github.com/svrnm), Cisco'
-# prettier-ignore
-cSpell:ignore: carbonreceiver datapoint debugexporter enddate gomod helmuth noout openssl otlpexporter otlphttpexporter otlpreceiver ottl servername transformprocessor webserver
+cSpell:ignore: helmuth openssl ottl transformprocessor webserver
 ---
 
 While OpenTelemetry (OTel) is here to help you with troubleshooting and handling

diff --git a/content/en/blog/2023/logs-collection/index.md b/content/en/blog/2023/logs-collection/index.md
@@ -3,8 +3,7 @@ title: Collecting Logs with OpenTelemetry Python
 linkTitle: Python Logs Collection
 date: 2023-11-21
 author: '[Michael Hausenblas](https://github.com/mhausenblas) (AWS)'
-# prettier-ignore
-cSpell:ignore: asctime Chehab exgru fileconsumer filelog Grogu grogu hossko Houssam levelname logfile otelbin Padawan svrnm WORKDIR yoda
+cSpell:ignore: asctime Chehab filelog grogu Houssam levelname padawan yoda
 ---
 
 In the following, we will walk through how to do

diff --git a/content/en/docs/collector/building/receiver.md b/content/en/docs/collector/building/receiver.md
@@ -3,7 +3,7 @@ title: Building a receiver
 weight: 20
 aliases: [/docs/collector/trace-receiver/]
 # prettier-ignore
-cSpell:ignore: amzn atmxph backendsystem batchprocessor chicago comcast crand debugexporter devs Errorf gogl Intn ispnetwork loggingexporter loglevel mapstructure mcrsft otelcontribcol otlpexporter otlpreceiver pcommon pdata protogen ptrace Rcvr rquedas sanfrancisco serialnumber slrs stateid struct structs Subchannel tailtracer telemetrygen uber wndws zapgrpc
+cSpell:ignore: backendsystem crand debugexporter loggingexporter mapstructure pcommon pdata protogen ptrace rcvr struct structs tailtracer telemetrygen uber
 ---
 
 <!-- markdownlint-disable heading-increment no-duplicate-heading -->
@@ -57,7 +57,7 @@ copy the `builder-config.yaml` described on
 and run the builder. As an outcome you should now have a folder structure like
 this:
 
-```console
+```text
 .
 ├── builder-config.yaml
 ├── ocb

diff --git a/content/en/docs/demo/architecture.md b/content/en/docs/demo/architecture.md
@@ -3,8 +3,6 @@ title: Demo Architecture
 linkTitle: Architecture
 aliases: [current_architecture]
 body_class: otel-mermaid-max-width
-# prettier-ignore
-cSpell:ignore: cppsvc dotnetsvc erlangsvc featureflagstore golangsvc javascriptsvc javasvc kotlinsvc loadgenerator phpsvc pythonsvc rubysvc rustsvc tsdb typescriptsvc
 ---
 
 **OpenTelemetry Demo** is composed of microservices written in different

diff --git a/content/en/docs/instrumentation/java/automatic/spring-boot.md b/content/en/docs/instrumentation/java/automatic/spring-boot.md
@@ -2,28 +2,38 @@
 title: Spring Boot
 linkTitle: Spring Boot
 weight: 30
-description: Spring instrumentation for OpenTelemetry Java
+description: Spring Boot instrumentation for OpenTelemetry Java
 cSpell:ignore: autoconfigure datasource logback springboot springframework
 ---
 
-You can use the [OpenTelemetry Java agent](..) with byte code instrumentation to
-automatically instrument a [Spring Boot](https://spring.io/projects/spring-boot)
-application; or you can also use the OpenTelemetry [Spring Boot starter] to
-instrument your application.
+The [OpenTelemetry Java agent](..) with byte code instrumentation can cover most
+of your needs when instrumenting
+[Spring Boot](https://spring.io/projects/spring-boot) applications.
+
+The OpenTelemetry [Spring Boot starter] can help you in the following cases:
+
+- with Spring Boot Native image applications for which the OpenTelemetry Java
+  agent does not work
+- the startup overhead of the OpenTelemetry Java agent exceeds your requirements
+- the OpenTelemetry Java agent might not work if your application already uses
+  another Java monitoring agent
 
 [Spring Boot starter]:
   https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.build-systems.starters
 
-The OpenTelemetry starter is compatible with Spring Boot 2.0 and 3.0, and Spring
-native.
+The
+[opentelemetry-java-examples/spring-native](https://github.com/open-telemetry/opentelemetry-java-examples/tree/main/spring-native)
+repository contains an example of a Spring Boot Native image application
+instrumented using the OpenTelemetry Spring Boot starter.
+
+The rest of this page documents the OpenTelemetry starter that works with Spring
+Boot 2.0 and 3.0.
 
-For an example Spring Boot Native image application that uses the OpenTelemetry
-Spring Boot starter, see
-[opentelemetry-java-examples/spring-native](https://github.com/open-telemetry/opentelemetry-java-examples/tree/main/spring-native).
+## OpenTelemetry Spring starter
 
-## Configuration
+### Configuration
 
-### Dependency management
+#### Dependency management
 
 A Bill of Material
 ([BOM](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms))
@@ -100,7 +110,7 @@ with the `io.spring.dependency-management` plugin.
 
 {{% /alert %}}
 
-### OpenTelemetry Starter dependency
+#### OpenTelemetry Starter dependency
 
 Add the dependency given below to enable the OpenTelemetry starter.
 
@@ -134,9 +144,9 @@ dependencies {
 
 {{% /tab %}} {{< /tabpane>}}
 
-## Additional instrumentations
+### Additional instrumentations
 
-### JDBC Instrumentation
+#### JDBC Instrumentation
 
 You have two ways to enable the JDBC instrumentation with the OpenTelemetry
 starter.
@@ -194,7 +204,7 @@ dependencies {
 
 {{% /tab %}} {{< /tabpane>}}
 
-### Logging Instrumentation
+#### Logging Instrumentation
 
 To enable the logging instrumentation for Logback you have to add the
 OpenTelemetry appender in your `logback.xml` or `logback-spring.xml` file:
@@ -243,7 +253,7 @@ and
 [Log4j](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/log4j/log4j-appender-2.17/library/README.md)
 instrumentation libraries.
 
-### Other Instrumentation
+#### Other Instrumentation
 
 You can configure other instrumentations with
 [OpenTelemetry instrumentations libraries](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md#libraries--frameworks).
diff --git a/scripts/content-modules/adjust-pages.pl b/scripts/content-modules/adjust-pages.pl
@@ -19,7 +19,7 @@
 my $specBasePath = '/docs/specs';
 my $path_base_for_github_subdir = "content/en$specBasePath";
 my %versions = qw(
-  spec: 1.28.0
+  spec: 1.29.0
   otlp: 1.0.0
   semconv: 1.24.0
 );
@@ -113,14 +113,6 @@ ()
   s|\.\./semantic_conventions/README.md|$semConvRef| if $ARGV =~ /overview/;
   s|\.\./specification/(.*?\))|../otel/$1)|g if $ARGV =~ /otel\/specification/;
 
-  # TODO: drop the following warning once the checks are enabled in the spec repos
-  if (
-    /\((https:\/\/github.com\/open-telemetry\/opentelemetry-specification\/\w+\/.*?\/specification([^\)]*))\)/ &&
-    $ARGV !~ /tmp\/(opamp|otlp\/docs|semconv)|semantic_conventions/
-    ) {
-    printf STDOUT "WARNING: link to spec page encoded as an external URL, but should be a local path, fix this upstream;\n  File: $ARGV \n  Link: $1\n";
-  }
-
   # Match markdown inline links or link definitions to OTel spec pages: "[...](URL)" or "[...]: URL"
   s|(\]:\s+\|\()https://github.com/open-telemetry/opentelemetry-specification/\w+/(main\|v$otelSpecVers)/specification(.*?\)?)|$1$specBasePath/otel$3|;
 

diff --git a/static/refcache.json b/static/refcache.json
@@ -7057,7 +7057,11 @@
   },
   "https://www.w3.org/TR/baggage/#baggage-string": {
     "StatusCode": 206,
+<<<<<<< HEAD
     "LastSeen": "2024-01-11T14:01:22.958369+01:00"
+=======
+    "LastSeen": "2024-01-11T06:07:13.666570443Z"
+>>>>>>> main
   },
   "https://www.w3.org/TR/baggage/#header-content": {
     "StatusCode": 206,
@@ -7129,7 +7133,7 @@
   },
   "https://yaml.org/spec/1.2.2/": {
     "StatusCode": 206,
-    "LastSeen": "2024-01-11T14:01:23.459474+01:00"
+    "LastSeen": "2024-01-11T06:07:16.115841487Z"
   },
   "https://youtu.be/9iaGG-YZw5I": {
     "StatusCode": 200,