[configgrpc] wrap gRPC client/server options in extensible interface #11069
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #11069 +/- ##
==========================================
- Coverage 91.89% 91.87% -0.03%
==========================================
Files 416 416
Lines 19911 19932 +21
==========================================
+ Hits 18297 18312 +15
- Misses 1239 1243 +4
- Partials 375 377 +2 ☔ View full report in Codecov by Sentry. |
codeboten
reviewed
Sep 9, 2024
codeboten
reviewed
Sep 9, 2024
There was a problem hiding this comment.
Thanks @jade-guiton-dd for taking this on! some initial comments
|
I applied your suggestions, and added some clickable links in my doc comments while I was at it. Feel free to tell me if there are remaining issues. |
mx-psi
reviewed
Sep 10, 2024
mx-psi
approved these changes
Sep 10, 2024
codeboten
reviewed
Sep 12, 2024
Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>
|
@codeboten will merge this tomorrow unless you have further comments |
jpkrohling
approved these changes
Sep 19, 2024
codeboten
approved these changes
Sep 19, 2024
bogdandrutu
pushed a commit
that referenced
this pull request
Sep 27, 2024
#11271) #### Description `ClientConfig.ToClientConn` and `ServerConfig.ToServer` were deprecated in v0.110.0 in favor of `ClientConfig.ToClientConnWithOptions` and `ServerConfig.ToServerWithOptions` which use a more flexible option type (#11069). The original functions are now removed, and the new ones are renamed to the old names. The `WithOptions` names are kept as deprecated aliases for now. Note: The "4 lines missing coverage" are from the `WithOptions` function aliases. #### Link to tracking issue Updates #9480 #### Next steps - `collector-contrib` will need to be updated to rename uses of the `WithOptions` functions - The newly deprecated aliases will then need to be removed in the next release
jackgopack4
pushed a commit
to jackgopack4/opentelemetry-collector
that referenced
this pull request
Oct 8, 2024
open-telemetry#11271) #### Description `ClientConfig.ToClientConn` and `ServerConfig.ToServer` were deprecated in v0.110.0 in favor of `ClientConfig.ToClientConnWithOptions` and `ServerConfig.ToServerWithOptions` which use a more flexible option type (open-telemetry#11069). The original functions are now removed, and the new ones are renamed to the old names. The `WithOptions` names are kept as deprecated aliases for now. Note: The "4 lines missing coverage" are from the `WithOptions` function aliases. #### Link to tracking issue Updates open-telemetry#9480 #### Next steps - `collector-contrib` will need to be updated to rename uses of the `WithOptions` functions - The newly deprecated aliases will then need to be removed in the next release
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
To allow extending the possible option types provided to
configgrpc.ClientConfig.ToClientConnandconfiggrpc.ServerConfig.ToServerin the future, we want to wrap thegrpc.DialOptionandgrpc.ServerOptionparameters in more genericToClientConnOptionandToServerOptioninterfaces.For compatibility, we start by adding new
ToClientConnWithOptionsandToServerWithOptionsmethods, to which the now deprecatedToClientConnandToServerdefer. A second PR will be needed to fully replace the original methods.Link to tracking issue
Fixes #9480
Testing
No tests have been added. Feel free to tell me if I should add some.
Documentation
No documentation has been added.