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

Unify addons and agent packages #77

Conversation

tigrannajaryan
Copy link
Member

@tigrannajaryan tigrannajaryan commented Apr 25, 2022

Addons and agent packages were previously defined separately
in the spec but had a lot of similarities. This change combines
them into one concept of "packages". The resulting spec is
significantly shorter while providing the same functionality.
It may also reduce the code duplication in implementations.

Resolves #4

@tigrannajaryan
Copy link
Member Author

@open-telemetry/opamp-spec-approvers I made this a draft for now, please tell what you think about it.

@tigrannajaryan
Copy link
Member Author

@andykellr it would be also good to have your thoughts on this.

@andykellr
Copy link
Contributor

I can look at it in more detail tomorrow or Wednesday, but at first glance it makes sense to me.

@tigrannajaryan tigrannajaryan marked this pull request as ready for review April 26, 2022 12:57
@tigrannajaryan tigrannajaryan requested a review from a team April 26, 2022 12:58
@tigrannajaryan tigrannajaryan force-pushed the feature/unify-addons-and-packages branch 2 times, most recently from 1291413 to ff53ff1 Compare April 26, 2022 13:03
tigrannajaryan added a commit to tigrannajaryan/opamp-spec that referenced this pull request Apr 26, 2022
The action is not properly triggered on PRs, e.g. open-telemetry#77

I am not completely sure why, but I copied the "on" trigger from the https://github.com/open-telemetry/opentelemetry-specification
repo where the action works fine, so hopefully this should fix it.
tigrannajaryan added a commit that referenced this pull request Apr 26, 2022
The action is not properly triggered on PRs, e.g. #77

I am not completely sure why, but I copied the "on" trigger from the https://github.com/open-telemetry/opentelemetry-specification
repo where the action works fine, so hopefully this should fix it.
Addons and agent packages were previously defined separately
in the spec but had a lot of similarities. This changes combines
them into one concept of "packages". The resulting spec is
significantly shorter while providing the same functionality.
It may also reduce the code duplication in implementations.

Resolves open-telemetry#4
@tigrannajaryan tigrannajaryan force-pushed the feature/unify-addons-and-packages branch from ff53ff1 to 4c5d4d8 Compare April 26, 2022 13:34
@tigrannajaryan
Copy link
Member Author

tigrannajaryan commented Apr 27, 2022

@open-telemetry/opamp-spec-approvers I spent a bit more time thinking about this change and feel reasonably confident that this is a move in the right direction. I think this is ready for review.

specification.md Outdated
TODO: is there a need to prescribe any specific behavior or explain what happens if there
are more than one top-level packages in the server's offer or we can leave it out and
allow agent-specific behavior?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this can be agent specific.

Related to this, I think a name string could be useful on the PackageAvailable or DownloadableFile message identifying the package. This may not necessarily be determined from the download_url.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think this can be agent specific.

I agree, I thought the same way. I will delete the TODO.

Related to this, I think a name string could be useful on the PackageAvailable or DownloadableFile message identifying the package. This may not necessarily be determined from the download_url.

PackageAvailable is only referenced from packages map in PackagesAvailable field, where the keys of the map are the package names. Adding the name to PackageAvailable would be a duplicate. Or are you thinking about something else?

For DownloadableFile: are you looking for the package name or the file name here?

Copy link
Contributor

Choose a reason for hiding this comment

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

That makes sense. I think the key in the map is fine.

Copy link
Contributor

@andykellr andykellr left a comment

Choose a reason for hiding this comment

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

I like this change.

@tigrannajaryan
Copy link
Member Author

@pmm-sumo it would be great if you could also have a look at this.

Copy link
Contributor

@pmm-sumo pmm-sumo left a comment

Choose a reason for hiding this comment

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

Less is more, I like the unification too

@tigrannajaryan tigrannajaryan merged commit c4453e8 into open-telemetry:main Apr 28, 2022
@tigrannajaryan tigrannajaryan deleted the feature/unify-addons-and-packages branch April 28, 2022 18:02
tigrannajaryan added a commit to tigrannajaryan/opamp-go that referenced this pull request Apr 28, 2022
tigrannajaryan added a commit to tigrannajaryan/opamp-go that referenced this pull request May 3, 2022
tigrannajaryan added a commit to tigrannajaryan/opamp-go that referenced this pull request May 3, 2022
tigrannajaryan added a commit to tigrannajaryan/opamp-go that referenced this pull request May 3, 2022
tigrannajaryan added a commit to tigrannajaryan/opamp-go that referenced this pull request May 3, 2022
tigrannajaryan added a commit to open-telemetry/opamp-go that referenced this pull request May 3, 2022
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.

Is it possible to unify addons and agent package such that we don't have 2 different concepts to deal wiith
3 participants