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

Clearly separate Config and Settings terms used in struct names throughout the codebase #6767

Closed
dmitryax opened this issue Dec 13, 2022 · 4 comments
Labels
release:required-for-ga Must be resolved before GA release

Comments

@dmitryax
Copy link
Member

dmitryax commented Dec 13, 2022

Currently, we use the Config term for collector configuration as a whole and parts of it defined for receivers/processors/exporters/extensions. Examples:

  • otelcol.Config
  • component.Config
  • otlpexporter.Config

But for unmarshalling some deeper parts of the user config, we use Settings structs, for example:

  • exporterhelper.QueueSettings
  • configgrpc.GRPCClientSettings
  • configtls.TLSSetting

At the same time service/telemetry package still uses Config, e.g. MetricsConfig, LogsSamplingConfig, and TracesConfig.

The suggestion is to use Config term for all the structs used to unmarshal any parts of the YAML config provided by users. We will keep Settings only for structs that are populated programmatically, like:

  • component.TelemetrySettings
  • component.ReceiverSettings
@bogdandrutu
Copy link
Member

I think we should start working on this, because we cannot delay until the stability.

@atoulme atoulme added the release:required-for-ga Must be resolved before GA release label Jan 25, 2024
dmitryax pushed a commit that referenced this issue Jan 26, 2024
…9392)

**Description:**
Deprecate CORSSettings, use CORSConfig instead

**Link to tracking Issue:**
#6767
dmitryax pushed a commit that referenced this issue Jan 26, 2024
…ad (#9405)

**Description:**
Deprecate HTTPServerSettings, use HTTPServerConfig instead

**Link to tracking Issue:**
#6767
dmitryax pushed a commit that referenced this issue Jan 29, 2024
…ad (#9404)

**Description:**
Deprecate HTTPClientSettings, use HTTPClientConfig instead

**Link to tracking Issue:**
#6767
dmitryax pushed a commit that referenced this issue Feb 1, 2024
…9403)

**Description:**
Deprecate GRPCServerSettings, use ~GRPC~ServerConfig instead

**Link to tracking Issue:**
#6767
dmitryax pushed a commit that referenced this issue Feb 2, 2024
…9402)

**Description:**
Deprecate GRPCClientSettings, use ClientConfig instead

**Link to tracking Issue:**
#6767
dmitryax pushed a commit that referenced this issue Feb 16, 2024
…nfig instead (#9401)

**Description:**
Deprecate ScraperControllerSettings, use ~Scraper~ControllerConfig
instead

**Link to tracking Issue:**
#6767
dmitryax pushed a commit that referenced this issue Feb 23, 2024
**Description:** 
Removes deprecated items from `confighttp` 

**Link to tracking Issue:** Related to
#6767
@TylerHelmuth
Copy link
Member

Removing from the confighttp milestone as the public structs now use Config.

dmitryax pushed a commit that referenced this issue Mar 20, 2024
…ultScraperControllerSettings` (#9783)

**Description:** 
Remove deprecated `ScraperControllerSettings` and
`NewDefaultScraperControllerSettings`

**Link to tracking Issue:**
#6767
@codeboten
Copy link
Contributor

Closing this in favour of #9428

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:required-for-ga Must be resolved before GA release
Projects
Status: Done
Development

No branches or pull requests

5 participants