From 8c61967612481a3b8d48926cfaa3c92ce7c46906 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 31 May 2024 03:03:23 -0400 Subject: [PATCH] Spring Boot starter: Alias fixes and partial copyedits (#4563) --- .../java/spring-boot-starter/_index.md | 9 +++------ .../additional-instrumentations.md | 18 +++++++++--------- .../java/spring-boot-starter/annotations.md | 1 - .../spring-boot-starter/getting-started.md | 10 ++++------ .../other-spring-autoconfig.md | 10 +++++----- .../out-of-the-box-instrumentation.md | 1 - 6 files changed, 21 insertions(+), 28 deletions(-) diff --git a/content/en/docs/zero-code/java/spring-boot-starter/_index.md b/content/en/docs/zero-code/java/spring-boot-starter/_index.md index 59ac857a4a84..e9407e1f9905 100644 --- a/content/en/docs/zero-code/java/spring-boot-starter/_index.md +++ b/content/en/docs/zero-code/java/spring-boot-starter/_index.md @@ -1,10 +1,9 @@ --- title: Spring Boot starter aliases: - [ - /docs/languages/java/automatic/spring-boot/, - /docs/zero-code/java/spring-boot/, - ] + - /docs/languages/java/automatic/spring-boot + - /docs/zero-code/java/agent/spring-boot + - /docs/zero-code/java/spring-boot --- You can use two options to instrument @@ -24,5 +23,3 @@ OpenTelemetry. - **Spring Boot configuration files** (`application.properties`, `application.yml`) to configure the OpenTelemetry Spring Boot starter which doesn't work with the OpenTelemetry Java agent - -## Use the OpenTelemetry starter diff --git a/content/en/docs/zero-code/java/spring-boot-starter/additional-instrumentations.md b/content/en/docs/zero-code/java/spring-boot-starter/additional-instrumentations.md index 6b9fa3185bdc..0ad9d177ff9b 100644 --- a/content/en/docs/zero-code/java/spring-boot-starter/additional-instrumentations.md +++ b/content/en/docs/zero-code/java/spring-boot-starter/additional-instrumentations.md @@ -1,14 +1,14 @@ --- -title: Additional instrumentations +title: Additional instrumentation description: - Additional instrumentations in addition to the out of the box instrumentation - of the starter + Instrumentations in addition to the out of the box instrumentation of the + starter weight: 50 --- -The OpenTelemetry Spring Boot starter provides of the box -instrumentation](../out-of-the-box-instrumentation) that you can complete with -additional instrumentations. +The OpenTelemetry Spring Boot starter provides +[out of the box instrumentation](../out-of-the-box-instrumentation) that you can +augment with additional instrumentations. ## Log4j2 Instrumentation @@ -36,7 +36,7 @@ instrumentation library. | --------------------------------------------- | ------- | ------- | ----------------------------------------------------------------------------------------------- | | `otel.instrumentation.log4j-appender.enabled` | Boolean | true | Enables the configuration of the Log4j OpenTelemetry appender with an `OpenTelemetry` instance. | -## OpenTelemetry instrumentations libraries +## Instrumentation libraries -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). +You can configure other instrumentations using +[OpenTelemetry instrumentation libraries](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md#libraries--frameworks). diff --git a/content/en/docs/zero-code/java/spring-boot-starter/annotations.md b/content/en/docs/zero-code/java/spring-boot-starter/annotations.md index 527284e70539..6396dac68ac2 100644 --- a/content/en/docs/zero-code/java/spring-boot-starter/annotations.md +++ b/content/en/docs/zero-code/java/spring-boot-starter/annotations.md @@ -1,7 +1,6 @@ --- title: Annotations description: Using instrumentation annotations with the Spring starter. -aliases: [../annotations] weight: 60 --- diff --git a/content/en/docs/zero-code/java/spring-boot-starter/getting-started.md b/content/en/docs/zero-code/java/spring-boot-starter/getting-started.md index a0c21c90f937..d236309cabb1 100644 --- a/content/en/docs/zero-code/java/spring-boot-starter/getting-started.md +++ b/content/en/docs/zero-code/java/spring-boot-starter/getting-started.md @@ -1,16 +1,14 @@ --- -title: Getting Started -description: Getting Started of the OpenTelemetry starter +title: Getting started with the Spring Boot starter +linkTitle: Getting Started weight: 20 cSpell:ignore: springboot --- -## OpenTelemetry Spring Boot starter - {{% alert title="Note" color="info" %}} -You can also use the Java agent to instrument your Spring Boot application. The -pros and cons are described in the [overview page](..). +You can also use the [Java agent](../../agent) to instrument your Spring Boot +application. For the pros and cons, see [Java zero-code instrumentation](..). {{% /alert %}} diff --git a/content/en/docs/zero-code/java/spring-boot-starter/other-spring-autoconfig.md b/content/en/docs/zero-code/java/spring-boot-starter/other-spring-autoconfig.md index d22be5345cf1..1282b7ac8cd5 100644 --- a/content/en/docs/zero-code/java/spring-boot-starter/other-spring-autoconfig.md +++ b/content/en/docs/zero-code/java/spring-boot-starter/other-spring-autoconfig.md @@ -1,6 +1,6 @@ --- -title: Other Spring autoconfigurations -description: Spring autoconfigurations without the OpenTelemetry Spring starter +title: Other Spring autoconfiguration +description: Spring autoconfiguration without the OpenTelemetry Spring starter cSpell:ignore: autoconfigurations weight: 70 --- @@ -26,9 +26,9 @@ public class OpenTelemetryConfig {} ## Zipkin starter OpenTelemetry Zipkin Exporter Starter is a starter package that includes the -opentelemetry-api, opentelemetry-sdk, opentelemetry-extension-annotations, -opentelemetry-logging-exporter, opentelemetry-spring-boot-autoconfigurations and -spring framework starters required to setup distributed tracing. It also +`opentelemetry-api`, `opentelemetry-sdk`, `opentelemetry-extension-annotations`, +`opentelemetry-logging-exporter`, `opentelemetry-spring-boot-autoconfigurations` +and spring framework starters required to setup distributed tracing. It also provides the [opentelemetry-exporters-zipkin](https://github.com/open-telemetry/opentelemetry-java/tree/main/exporters/zipkin) artifact and corresponding exporter autoconfiguration. Check out diff --git a/content/en/docs/zero-code/java/spring-boot-starter/out-of-the-box-instrumentation.md b/content/en/docs/zero-code/java/spring-boot-starter/out-of-the-box-instrumentation.md index 93584855c51b..c8f1fbd87fb0 100644 --- a/content/en/docs/zero-code/java/spring-boot-starter/out-of-the-box-instrumentation.md +++ b/content/en/docs/zero-code/java/spring-boot-starter/out-of-the-box-instrumentation.md @@ -1,7 +1,6 @@ --- title: Out of the box instrumentation description: Out of the box instrumentation for the starter -aliases: [../annotations] weight: 40 cSpell:ignore: autoconfigurations autoconfigures logback webflux webmvc ---