document java supported technologies #95

SylvainJuge · 2025-03-11T13:55:31Z

add release notes with link
add supported technologies (includes exclusive features)
add features

The "features" page is the one we will can link to from a broader "feature matrix".

elastic-acrolinx · 2025-03-11T13:55:41Z

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article	Total score (Required: 80)	Words + phrases (Brand, terms)	Correctness (Spelling, grammar)	Clarity (Readability)
✅ docs/_edot-sdks/java/release.md	63	17	9	17
✅ docs/_edot-sdks/java/supported-technologies.md	63	17	41	28

*TBD

elastic-acrolinx · 2025-03-11T14:14:06Z

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article	Total score (Required: 80)	Words + phrases (Brand, terms)	Correctness (Spelling, grammar)	Clarity (Readability)
✅ docs/_edot-sdks/java/release.md	63	17	9	17
✅ docs/_edot-sdks/java/supported-technologies.md	67	16	50	30

*TBD

elastic-acrolinx · 2025-03-11T14:22:19Z

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article	Total score (Required: 80)	Words + phrases (Brand, terms)	Correctness (Spelling, grammar)	Clarity (Readability)
✅ docs/_edot-sdks/java/release.md	63	17	9	17
✅ docs/_edot-sdks/java/supported-technologies.md	66	17	44	30

*TBD

elastic-acrolinx · 2025-03-11T16:14:37Z

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article	Total score (Required: 80)	Words + phrases (Brand, terms)	Correctness (Spelling, grammar)	Clarity (Readability)
✅ docs/_edot-sdks/java/faq.md	100	100	100	100
✅ docs/_edot-sdks/java/features.md	59	16	40	31
✅ docs/_edot-sdks/java/migration.md	67	25	25	25
✅ docs/_edot-sdks/java/release.md	63	17	9	17
✅ docs/_edot-sdks/java/supported-technologies.md	63	23	64	27
✅ docs/_edot-sdks/java/troubleshooting.md	87	9	100	100

*TBD

docs/_edot-sdks/java/features.md

elastic-acrolinx · 2025-03-12T06:31:07Z

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article	Total score (Required: 80)	Words + phrases (Brand, terms)	Correctness (Spelling, grammar)	Clarity (Readability)
✅ docs/_edot-sdks/java/faq.md	100	100	100	100
✅ docs/_edot-sdks/java/features.md	59	17	41	28
✅ docs/_edot-sdks/java/migration.md	67	25	25	25
✅ docs/_edot-sdks/java/release.md	63	17	9	17
✅ docs/_edot-sdks/java/supported-technologies.md	63	23	64	27
✅ docs/_edot-sdks/java/troubleshooting.md	87	9	100	100

*TBD

hegerchr

I've left some comments where I think it could help the reader.

hegerchr · 2025-03-12T07:20:56Z

docs/_edot-sdks/java/features.md

+inherits all the features of the OpenTelemetry Java Instrumentation to capture logs, metrics and traces.
+
+The EDOT Java agent also provides exclusive features that are _not available_ in the [OpenTelemetry Java Instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation)
+or are provided but with different default configuration.


Can we be a bit more clear about to what the different default configuration refers to. Maybe starting a new sentence. I find a bit hard to read as it is at the moment.

hegerchr · 2025-03-12T07:22:50Z

docs/_edot-sdks/java/features.md

+
+This extension provides the ability to enhance the traces by creating spans from [async-profiler](https://github.com/async-profiler/async-profiler) data without the need of explicit instrumentation of corresponding spans.
+
+This feature is disabled by default and can be enabled by setting `OTEL_INFERRED_SPANS_ENABLED` to `true`.


Does this has any impact on the runtime environment and resources that should be mentioned here?

I am not sure to understand, can you elaborate a bit ?

hegerchr · 2025-03-12T07:23:50Z

docs/_edot-sdks/java/features.md

+
+## Runtime metrics
+
+Experimental runtime metrics are _enabled_ by default.


Should we better use "tech preview" here?

Here the 'experimental' comes from the upstream configuration option, so I think it's better to keep it as-is for now. We can maybe clarify this and add a link to semconv to help understand that it's because those are experimental in semconv.

hegerchr · 2025-03-12T07:25:54Z

docs/_edot-sdks/java/features.md

+
+[Universal Profiling](https://www.elastic.co/observability/universal-profiling) integration provides the ability to correlate traces with profiling data from the Elastic universal profiler.
+
+This feature is enabled by default on supported systems, disabled otherwise.


What are the supported systems? Following the link in line 58 I haven't found the answer.

I don't know and haven't found a clear reference on this, I assume it's a combination of linux, kernel version and availability of binaries for the target architecture. This sentence was almost copied as-is from the existing docs.

SylvainJuge added 2 commits March 11, 2025 09:56

add release notes with link

5e8b823

add supported technologies

967835e

SylvainJuge requested a review from AlexanderWert March 11, 2025 13:55

SylvainJuge self-assigned this Mar 11, 2025

SylvainJuge marked this pull request as draft March 11, 2025 13:57

SylvainJuge added 2 commits March 11, 2025 15:06

add openai instrumentation

10ec098

add universal profiling integration

97ba2d5

SylvainJuge added 2 commits March 11, 2025 15:17

add universal profiling link

f313bd6

use env variable syntax for config

39108d9

SylvainJuge marked this pull request as ready for review March 11, 2025 14:22

add features page

71d499f

SylvainJuge requested a review from hegerchr March 11, 2025 16:18

AlexanderWert reviewed Mar 12, 2025

View reviewed changes

docs/_edot-sdks/java/features.md Outdated Show resolved Hide resolved

Update docs/_edot-sdks/java/features.md

2c90e33

AlexanderWert approved these changes Mar 12, 2025

View reviewed changes

AlexanderWert merged commit 9af6912 into elastic:main Mar 12, 2025
3 checks passed

hegerchr reviewed Mar 12, 2025

View reviewed changes

SylvainJuge mentioned this pull request Mar 12, 2025

java docs post-review changes #98

Merged

SylvainJuge deleted the java-supported-technologies branch March 12, 2025 08:25


		This extension provides the ability to enhance the traces by creating spans from [async-profiler](https://github.com/async-profiler/async-profiler) data without the need of explicit instrumentation of corresponding spans.

		This feature is disabled by default and can be enabled by setting `OTEL_INFERRED_SPANS_ENABLED` to `true`.


		## Runtime metrics

		Experimental runtime metrics are _enabled_ by default.


		[Universal Profiling](https://www.elastic.co/observability/universal-profiling) integration provides the ability to correlate traces with profiling data from the Elastic universal profiler.

		This feature is enabled by default on supported systems, disabled otherwise.

document java supported technologies #95

document java supported technologies #95

Uh oh!

Conversation

SylvainJuge commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elastic-acrolinx commented Mar 11, 2025

Acrolinx Scorecards

Uh oh!

elastic-acrolinx commented Mar 11, 2025

Acrolinx Scorecards

Uh oh!

elastic-acrolinx commented Mar 11, 2025

Acrolinx Scorecards

Uh oh!

elastic-acrolinx commented Mar 11, 2025

Acrolinx Scorecards

Uh oh!

Uh oh!

elastic-acrolinx commented Mar 12, 2025

Acrolinx Scorecards

Uh oh!

Uh oh!

hegerchr left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

SylvainJuge commented Mar 11, 2025 •

edited

Loading

hegerchr left a comment •

edited

Loading