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

[configgrpc] Deprecate GRPCServerSettings, use ServerConfig instead #9403

Merged

Conversation

atoulme
Copy link
Contributor

@atoulme atoulme commented Jan 26, 2024

Description:
Deprecate GRPCServerSettings, use GRPCServerConfig instead

Link to tracking Issue:
#6767

Copy link

codecov bot commented Jan 26, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (5bcd109) 90.46% compared to head (98f9962) 90.46%.

Files Patch % Lines
config/configgrpc/configgrpc.go 75.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #9403   +/-   ##
=======================================
  Coverage   90.46%   90.46%           
=======================================
  Files         344      344           
  Lines       18024    18024           
=======================================
  Hits        16306    16306           
  Misses       1390     1390           
  Partials      328      328           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

type GRPCServerSettings = GRPCServerConfig

// GRPCServerConfig defines common settings for a gRPC server configuration.
type GRPCServerConfig struct {
Copy link
Member

Choose a reason for hiding this comment

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

qq: Should we also make this ServerConfig since it will be used as configgrpc.ServerConfig? I personally like the shorter name.

Copy link
Member

Choose a reason for hiding this comment

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

Even configgrpc.Server seems clear enough to me, since config is also redundant.

Copy link
Member

Choose a reason for hiding this comment

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

I like configgrpc.ServerConfig. configgrpc.Server sounds a bit unclear.

@open-telemetry/collector-approvers WDYT?

We already did this change to confighttp. If we think that it's a good option we should drop HTTP from HTTPServerConfig and HTTPServerConfig before the next release

Copy link
Member

Choose a reason for hiding this comment

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

ServerConfig makes more sense to me, it's weird to have a ToServer method on a struct called Server

Copy link
Member

Choose a reason for hiding this comment

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

I also like configgrcp.ServerConfig

Copy link
Member

Choose a reason for hiding this comment

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

That an implementation detail for that receiver not for this thread.

Copy link
Member

@dmitryax dmitryax Feb 1, 2024

Choose a reason for hiding this comment

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

It's actually part of this PR so we need to decide

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Pushing GRPCServerConfig -> ServerConfig now.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, I was wrong this doesn't introduce the breaking chance since ServerConfig isn't embedded in this receiver. So no more changes are needed

Copy link
Member

Choose a reason for hiding this comment

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

I pushed a PR to update confighttp accordingly #9453

@dmitryax dmitryax added the release:blocker The issue must be resolved before cutting the next release label Jan 31, 2024
@dmitryax
Copy link
Member

dmitryax commented Jan 31, 2024

Putting the blocker label to avoid breaking the merged HTTP configs again after the discussion is resolved

@atoulme atoulme changed the title [configgrpc] Deprecate GRPCServerSettings, use GRPCServerConfig instead [configgrpc] Deprecate GRPCServerSettings, use ServerConfig instead Feb 1, 2024
@atoulme atoulme force-pushed the grpcserversettings_grpcserverconfig branch from 29b4926 to 98f9962 Compare February 1, 2024 21:32
@dmitryax dmitryax merged commit 421c655 into open-telemetry:main Feb 1, 2024
45 of 46 checks passed
@github-actions github-actions bot added this to the next release milestone Feb 1, 2024
@atoulme atoulme deleted the grpcserversettings_grpcserverconfig branch February 1, 2024 21:58
dmitryax added a commit that referenced this pull request Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:blocker The issue must be resolved before cutting the next release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants