Skip to content

Conversation

@steverao
Copy link
Contributor

@steverao steverao commented Mar 7, 2025

No description provided.

@steverao steverao requested a review from a team as a code owner March 7, 2025 02:47
README.md Outdated

## 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

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

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

[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

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

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

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

Co-authored-by: Jay DeLuca <[email protected]>
Copy link
Member

@trask trask left a comment

Choose a reason for hiding this comment

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

thanks @steverao!

my only thought is distros are a pretty advanced concept and mainly targeted for observability vendors as opposed to end users

did you have a particular audience, discoverability problem in mind here?

@steverao
Copy link
Contributor Author

my only thought is distros are a pretty advanced concept and mainly targeted for observability vendors as opposed to end users

Yes, compared with some ordinary users, it's really more useful for observability vendors or middle/large-size businesses that they want to do some customizations. If we don't add related content to more obvious place such as README.md. IMO, it isn't easy to find it. In fact, I don't notice it at first😅

Co-authored-by: Trask Stalnaker <[email protected]>
@trask trask merged commit c284f6c into open-telemetry:main Mar 13, 2025
86 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.

3 participants