Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change "Language Feature Reference" table in demo docs #2602

Merged
merged 7 commits into from
Apr 25, 2023

Conversation

pellared
Copy link
Member

@pellared pellared commented Apr 14, 2023

Related to open-telemetry/opentelemetry-specification#2866

Lots of the things documented under "Auto Instrumentation" are in fact about using "instrumentation libraries".

@pellared pellared marked this pull request as ready for review April 14, 2023 10:17
@pellared pellared requested review from a team as code owners April 14, 2023 10:17
@cartermp
Copy link
Contributor

I think this is incorrect since, at the very minimum, the Java service uses the autoinstrumentation agent.

@pellared
Copy link
Member Author

pellared commented Apr 17, 2023

I think this is incorrect since, at the very minimum, the Java service uses the autoinstrumentation agent.

But e.g. Go, .NET are using manual instrumentation libraries. Therefore the existing header is misleading.

And yes, Java is using autoinstrumentation agent to apply instrumentation libraries 😉

EDIT: I am going to add an additional column per @Kielek suggestion.

@pellared pellared changed the title Change "auto" in demo docs Change "Language Feature Reference" table in demo docs Apr 17, 2023
@pellared
Copy link
Member Author

pellared commented Apr 17, 2023

@cartermp I added a separate column. a3bdb57

However, I am not sure if it won't be more readable to remove the whole "Language Feature Reference" section and add more info in "Service Documentation" section. E.g.

- [Ad Service](services/ad/) (**Java**, Automatic Instrumentation, Manual Instrumentation)
- [Cart Service](services/cart/) (**.NET**, Instrumentation Libraries, Manual Instrumentation)
...

WDYT?

Copy link
Contributor

@Kielek Kielek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pellared
Copy link
Member Author

@svrnm svrnm merged commit 8f0f4c7 into open-telemetry:main Apr 25, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants