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

Decide on naming rules for Settings structs #9428

Open
2 tasks
mx-psi opened this issue Jan 30, 2024 · 1 comment
Open
2 tasks

Decide on naming rules for Settings structs #9428

mx-psi opened this issue Jan 30, 2024 · 1 comment
Labels
area:config release:required-for-ga Must be resolved before GA release

Comments

@mx-psi
Copy link
Member

mx-psi commented Jan 30, 2024

Per #9406 (comment) we want to have a set of naming rules for structs ending in Settings. Current (as of 1ed45ec) structs that have this are the following:

Output for rg 'type ([A-Z].*Settings|Settings) struct' -tgo --glob '!internal' (click to expand)
otelcol/collector.go
56:type CollectorSettings struct {

otelcol/configprovider.go
74:type ConfigProviderSettings struct {

extension/extension.go
66:type CreateSettings struct {

receiver/scraperhelper/obsreport.go
43:type ObsReportSettings struct {

receiver/receiverhelper/obsreport.go
47:type ObsReportSettings struct {

receiver/scraperhelper/settings.go
23:type ScraperControllerSettings struct {

connector/connector.go
65:type CreateSettings struct {

confmap/resolver.go
31:type ResolverSettings struct {

receiver/receiver.go
44:type CreateSettings struct {

processor/processor.go
35:type CreateSettings struct {

config/configgrpc/configgrpc.go
51:type GRPCClientSettings struct {
120:type GRPCServerSettings struct {

processor/processorhelper/obsreport.go
59:type ObsReportSettings struct {

service/extensions/extensions.go
165:type Settings struct {

component/telemetry.go
20:type TelemetrySettings struct {

service/service.go
37:type Settings struct {

exporter/exporter.go
35:type CreateSettings struct {

service/telemetry/telemetry.go
37:type Settings struct {

exporter/exporterhelper/queue_sender.go
31:type QueueSettings struct {

exporter/exporterhelper/timeout_sender.go
13:type TimeoutSettings struct {

exporter/exporterhelper/obsexporter.go
46:type ObsReportSettings struct {

Questions that arise to me are:

  • Can we remove the Create prefix from CreateSettings?
  • Can we remove other prefixes (e.g. GRPC from structs within configgrpc, Collector from otelcol...)?

cc @dmitryax to fill in other rules.

Adding this to configgrpc milestone per the question above.

@TylerHelmuth
Copy link
Member

Very related issue: #6767. @atoulme has been submitting lots of PRs to switch from Settings to Config where appropriate.

dmitryax pushed a commit that referenced this issue Feb 27, 2024
**Description:**
Removes deprecated functions/structs

**Link to tracking Issue:** 
Related to
#9428
Related to
#9482
Closes
#9481
mx-psi pushed a commit that referenced this issue Mar 27, 2024
**Description:** <Describe what has changed.>
Removed deprecated structs

**Link to tracking Issue:** <Issue number if applicable>
Related to
#9428
Related to
#9474
Closes
#9548
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:config release:required-for-ga Must be resolved before GA release
Projects
Status: In Progress
Development

No branches or pull requests

2 participants