Skip to content

Add distro's introduction to README.md #13470

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.

Sign up for GitHub

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

Merged
trask merged 4 commits into from
Mar 13, 2025
Merged

Add distro's introduction to README.md #13470

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4101815
Add distro's introduction to README.md
steverao Mar 7, 2025
03ce596
Update README.md
steverao Mar 7, 2025
df341c1
Address review comment
steverao Mar 7, 2025
0db262a
Update README.md
steverao Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,10 @@ having to create a separate distribution or to fork this repository. For example
custom samplers or span exporters, set new defaults, and embed it all in the agent to obtain a
single jar file.

## Creating agent distribution

[Distro](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features.
Copy link
Member

@jaydeluca jaydeluca Mar 7, 2025

Choose a reason for hiding this comment

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

Suggested change
[Distro](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features.
The [Distro documentation](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features.

Copy link
Contributor Author

@steverao steverao Mar 7, 2025

Choose a reason for hiding this comment

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

I used same hyperlink format with

opentelemetry-java-instrumentation/README.md

Lines 102 to 105 in 826ba74

[Extensions](examples/extension/README.md) add new features and capabilities to the agent without
having to create a separate distribution or to fork this repository. For example, you can create
custom samplers or span exporters, set new defaults, and embed it all in the agent to obtain a
single jar file.

Copy link
Member

@jaydeluca jaydeluca Mar 7, 2025

Choose a reason for hiding this comment

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

I think the extensions sentence flows nicely, but “Distro” alone being treated as the subject of the sentence feels a little ambiguous as to what “Distro” refers to. On the other hand, the links are for examples as opposed to documentation, so maybe i'm over thinking it.

Copy link
Contributor Author

@steverao steverao Mar 7, 2025

Choose a reason for hiding this comment

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

the links are for examples as opposed to documentation

How about using Distribution instead of Distro here?

Copy link
Member

@jaydeluca jaydeluca Mar 7, 2025

Choose a reason for hiding this comment

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

I think the extension paragraph and this new one feel a little bit different.

This extensions paragraph feels like it is describing the function of an extension, and not necessarily describing the contents of what the link is taking you to.

Extensions add new features and capabilities to the agent without
having to create a separate distribution or to fork this repository. For example, you can create
custom samplers or span exporters, set new defaults, and embed it all in the agent to obtain a
single jar file.

In contrast, the new paragraph seems to be more describing the contents of the the link as opposed to stricly what the custom distribution functionality enables.

Distro provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features.

I think if we wanted to take the same approach in the distro section, we could do something like:

A custom distribution allows you to extend and repackage the Opentelemetry Java instrumentation agent in order to incorporate custom features.

With that being said, what you currently have is also probably ok


## Manually instrumenting

For most users, the out-of-the-box instrumentation is completely sufficient and nothing more has to
Expand Down
Loading