From 75fd2bf7c679d2a450ee8310fdc6f34a7e8a3595 Mon Sep 17 00:00:00 2001 From: maryliag Date: Thu, 6 Feb 2025 13:10:50 -0500 Subject: [PATCH 1/4] fix description of log instrumentation --- content/en/docs/languages/java/instrumentation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/languages/java/instrumentation.md b/content/en/docs/languages/java/instrumentation.md index 1b1e4c0df4a1..8086bf9c8723 100644 --- a/content/en/docs/languages/java/instrumentation.md +++ b/content/en/docs/languages/java/instrumentation.md @@ -28,8 +28,8 @@ instrumentation topics: complement each other. - [Semantic conventions](#semantic-conventions): The semantic conventions define how to produce telemetry for standard operations. -- [Log instrumentation](#log-instrumentation): The semantic conventions define - how to produce telemetry for standard operations. +- [Log instrumentation](#log-instrumentation): Log instrumentation can be used + to get logs from an existing Java logging framework into OpenTelemetry. {{% alert %}} While [instrumentation categories](#instrumentation-categories) enumerates several options for instrumenting an application, we recommend users From e86667c54293008d063f0920889a15b8350ceb4d Mon Sep 17 00:00:00 2001 From: maryliag Date: Fri, 7 Feb 2025 09:37:54 -0500 Subject: [PATCH 2/4] remove repetition --- content/en/docs/languages/java/instrumentation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/docs/languages/java/instrumentation.md b/content/en/docs/languages/java/instrumentation.md index 8086bf9c8723..f1aeaaa0a352 100644 --- a/content/en/docs/languages/java/instrumentation.md +++ b/content/en/docs/languages/java/instrumentation.md @@ -23,12 +23,12 @@ instrumentation topics: - [Instrumentation categories](#instrumentation-categories): There are a variety of categories of instrumentation addressing different use cases and installation patterns. -- [Context propagation](#context-propagation): Context propagation provides +- [Context propagation](#context-propagation): Provides correlation between traces, metrics, and logs, allowing the signals to complement each other. -- [Semantic conventions](#semantic-conventions): The semantic conventions define +- [Semantic conventions](#semantic-conventions): Define how to produce telemetry for standard operations. -- [Log instrumentation](#log-instrumentation): Log instrumentation can be used +- [Log instrumentation](#log-instrumentation): Can be used to get logs from an existing Java logging framework into OpenTelemetry. {{% alert %}} While [instrumentation categories](#instrumentation-categories) From 426a1926a92b164531145f6be19dc158ecc79d85 Mon Sep 17 00:00:00 2001 From: maryliag Date: Fri, 7 Feb 2025 09:47:12 -0500 Subject: [PATCH 3/4] fix lint --- content/en/docs/languages/java/instrumentation.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/content/en/docs/languages/java/instrumentation.md b/content/en/docs/languages/java/instrumentation.md index f1aeaaa0a352..7c035964a2b9 100644 --- a/content/en/docs/languages/java/instrumentation.md +++ b/content/en/docs/languages/java/instrumentation.md @@ -23,13 +23,12 @@ instrumentation topics: - [Instrumentation categories](#instrumentation-categories): There are a variety of categories of instrumentation addressing different use cases and installation patterns. -- [Context propagation](#context-propagation): Provides - correlation between traces, metrics, and logs, allowing the signals to - complement each other. -- [Semantic conventions](#semantic-conventions): Define - how to produce telemetry for standard operations. -- [Log instrumentation](#log-instrumentation): Can be used - to get logs from an existing Java logging framework into OpenTelemetry. +- [Context propagation](#context-propagation): Provides correlation between + traces, metrics, and logs, allowing the signals to complement each other. +- [Semantic conventions](#semantic-conventions): Define how to produce telemetry + for standard operations. +- [Log instrumentation](#log-instrumentation): Can be used to get logs from an + existing Java logging framework into OpenTelemetry. {{% alert %}} While [instrumentation categories](#instrumentation-categories) enumerates several options for instrumenting an application, we recommend users From b9de27573462b5228dd99f2c24682a6caa1888f9 Mon Sep 17 00:00:00 2001 From: maryliag Date: Fri, 7 Feb 2025 10:10:45 -0500 Subject: [PATCH 4/4] add suggestion formatting --- content/en/docs/languages/java/instrumentation.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/content/en/docs/languages/java/instrumentation.md b/content/en/docs/languages/java/instrumentation.md index 7c035964a2b9..8eb6a9dc047e 100644 --- a/content/en/docs/languages/java/instrumentation.md +++ b/content/en/docs/languages/java/instrumentation.md @@ -20,14 +20,13 @@ instrumentation API calls. This page discusses the OpenTelemetry ecosystem in OpenTelemetry Java, including resources for end users and cross-cutting instrumentation topics: -- [Instrumentation categories](#instrumentation-categories): There are a variety - of categories of instrumentation addressing different use cases and - installation patterns. -- [Context propagation](#context-propagation): Provides correlation between +- [Instrumentation categories](#instrumentation-categories) addressing different + use cases and installation patterns. +- [Context propagation](#context-propagation) provides correlation between traces, metrics, and logs, allowing the signals to complement each other. -- [Semantic conventions](#semantic-conventions): Define how to produce telemetry +- [Semantic conventions](#semantic-conventions) define how to produce telemetry for standard operations. -- [Log instrumentation](#log-instrumentation): Can be used to get logs from an +- [Log instrumentation](#log-instrumentation), which is used to get logs from an existing Java logging framework into OpenTelemetry. {{% alert %}} While [instrumentation categories](#instrumentation-categories)