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

dmitryax · 2022-12-13T00:30:07Z

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

The text was updated successfully, but these errors were encountered:

bogdandrutu · 2023-12-12T23:11:24Z

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

atoulme · 2024-01-25T07:55:04Z

List of renames:

[configgrpc] Deprecate GRPCClientSettings, use ClientConfig instead #9402
[configgrpc] Deprecate GRPCServerSettings, use ServerConfig instead #9403
[confighttp] Deprecate HTTPClientSettings, use HTTPClientConfig instead #9404
[confighttp] Deprecate HTTPServerSettings, use HTTPServerConfig instead #9405
[config/confighttp] Deprecate CORSSettings, use CORSConfig instead #9392
[exporterhelper] Deprecate QueueSettings, use QueueConfig instead #9393 - on hold, might be part of bigger refactor
[exporterhelper] Deprecate TimeoutSettings, use TimeoutConfig instead #9391 - on hold, might be part of bigger refactor
[scraperhelper] Deprecate ScraperControllerSettings, use ControllerConfig instead #9401

…9392) **Description:** Deprecate CORSSettings, use CORSConfig instead **Link to tracking Issue:** #6767

…ad (#9405) **Description:** Deprecate HTTPServerSettings, use HTTPServerConfig instead **Link to tracking Issue:** #6767

…ad (#9404) **Description:** Deprecate HTTPClientSettings, use HTTPClientConfig instead **Link to tracking Issue:** #6767

…9403) **Description:** Deprecate GRPCServerSettings, use ~GRPC~ServerConfig instead **Link to tracking Issue:** #6767

…9402) **Description:** Deprecate GRPCClientSettings, use ClientConfig instead **Link to tracking Issue:** #6767

…nfig instead (#9401) **Description:** Deprecate ScraperControllerSettings, use ~Scraper~ControllerConfig instead **Link to tracking Issue:** #6767

**Description:** Removes deprecated items from `confighttp` **Link to tracking Issue:** Related to #6767

TylerHelmuth · 2024-02-23T20:13:09Z

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

…ultScraperControllerSettings` (#9783) **Description:** Remove deprecated `ScraperControllerSettings` and `NewDefaultScraperControllerSettings` **Link to tracking Issue:** #6767

codeboten · 2024-04-17T18:29:11Z

Closing this in favour of #9428

codeboten · 2024-06-05T16:06:12Z

exporterhelper still needs updating

mx-psi · 2024-09-09T12:25:19Z

We still need to update:

exporterhelper.TimeoutSettings
NewDefaultTimeoutSettings
exporterhelper.QueueSettings
NewDefaultQueueSettings

jade-guiton-dd · 2024-09-09T12:26:46Z

I'll work on this.

@mx-psi

#### Description This PR renames `TimeoutSettings` and `QueueSettings` (as well as the corresponding `NewDefault` functions) to `TimeoutConfig` and `QueueConfig`, for naming consistency reasons. The previous struct/function names are kept as deprecated aliases of the new ones for now. #### Link to tracking issue Updates #6767 (edit: reworded by @mx-psi) #### Testing No behavior changes were made, so no additional testing should be necessary. The references to the aforementioned structs/functions in existing tests have been renamed as well. This means the deprecated function aliases are not tested, lowering the coverage a bit. #### Documentation The new functions are documented identically to the previous ones.

…tings (#35158) **Description:** `TimeoutSettings` and `QueueSettings` in the `exporterhelper` core collector package were renamed to `TimeoutConfig` and `QueueConfig` for naming consistency reasons, and the related `NewDefault` functions were renamed as well. This PR updates the core libraries to a prerelease version with those changes, and updates opentelemetry-collector-contrib modules to the new names, to plan for the deprecation of the old names in v0.110.0. **Link to tracking Issue:** Related to [this PR](open-telemetry/opentelemetry-collector#11132) and [this issue](open-telemetry/opentelemetry-collector#6767) on the core collector. **Notes:** - `go.opentelemetry.io/collector/cmd/mdatagen` is specifically *not* updated, as it currently has a bug causing a CI test failure. - The `prometheus-compliance-tests` CI failure is unrelated to this PR.

…11178) #### Description My PR #11132 introduced a small breaking change in the API of `otlpexporter`, which I failed to notice at the time. This PR adds a release note about this. Specifically, the `TimeoutSettings` field in `otlpexporter.Config` was renamed to `TimeoutConfig` ([link to the new code](https://github.com/jade-guiton-dd/opentelemetry-collector/blob/543c4f510d3bbcd50e914f4e5d7f22c5fcbda92d/exporter/otlpexporter/config.go#L23)). As this is an embedded field, renaming the type of the field renamed the field itself. (Another option would have been to de-embed the field, and keep the old name. This has less potential for breakage, but would technically also be a breaking change.) #### Link to tracking issue Indirectly related to #6767

…11264) #### Description Follow-up to #11132 now that 0.110 has been released. #### Link to tracking issue Should be the final step for #6767.

jade-guiton-dd · 2024-10-01T13:25:19Z

If I'm not mistaken, #11264 was the last step for this issue, so it can probably be closed.

mx-psi · 2024-10-01T14:47:29Z

Taking a look at the output of rg 'type \w*Setting' -tgo -i it looks like this is indeed the case 🚀

…tings (open-telemetry#35158) **Description:** `TimeoutSettings` and `QueueSettings` in the `exporterhelper` core collector package were renamed to `TimeoutConfig` and `QueueConfig` for naming consistency reasons, and the related `NewDefault` functions were renamed as well. This PR updates the core libraries to a prerelease version with those changes, and updates opentelemetry-collector-contrib modules to the new names, to plan for the deprecation of the old names in v0.110.0. **Link to tracking Issue:** Related to [this PR](open-telemetry/opentelemetry-collector#11132) and [this issue](open-telemetry/opentelemetry-collector#6767) on the core collector. **Notes:** - `go.opentelemetry.io/collector/cmd/mdatagen` is specifically *not* updated, as it currently has a bug causing a CI test failure. - The `prometheus-compliance-tests` CI failure is unrelated to this PR.

…pen-telemetry#11264) #### Description Follow-up to open-telemetry#11132 now that 0.110 has been released. #### Link to tracking issue Should be the final step for open-telemetry#6767.

…n coding guidelines (#11549)  #### Description  Reflects existing practice in coding guidelines. #### Link to tracking issue Relates to #6767, fixes #9428

dmitryax added bug Something isn't working and removed bug Something isn't working labels Dec 13, 2022

dmitryax mentioned this issue May 6, 2023

[chore] [cmd/mdatagen] Rename structs with Settings suffix to Config open-telemetry/opentelemetry-collector-contrib#21522

Merged

dmitryax mentioned this issue Aug 8, 2023

fix(receiver/otlpreceiver): make the configuration HttpServerSettings public #8176

Merged

dmitryax mentioned this issue Dec 12, 2023

Deprecate exporterhelper.RetrySettings in favor of configretry.BackOffConfig #9091

Merged

dmitryax mentioned this issue Dec 20, 2023

Uniform defaults for exporterhelper #4455

Open

3 tasks

atoulme added the release:required-for-ga Must be resolved before GA release label Jan 25, 2024

atoulme modified the milestones: `go.opentelemetry.io/collector/config/configgrpc` 1.0, `go.opentelemetry.io/collector/confighttp` 1.0 Jan 25, 2024

This was referenced Jan 25, 2024

[exporterhelper] Deprecate TimeoutSettings, use TimeoutConfig instead #9391

Closed

[config/confighttp] Deprecate CORSSettings, use CORSConfig instead #9392

Merged

[exporterhelper] Deprecate QueueSettings, use QueueConfig instead #9393

Closed

dmitryax pushed a commit that referenced this issue Jan 26, 2024

[config/confighttp] Deprecate CORSSettings, use CORSConfig instead (#…

9082cb1

…9392) **Description:** Deprecate CORSSettings, use CORSConfig instead **Link to tracking Issue:** #6767

dmitryax pushed a commit that referenced this issue Jan 26, 2024

[confighttp] Deprecate HTTPServerSettings, use HTTPServerConfig inste…

8b95295

…ad (#9405) **Description:** Deprecate HTTPServerSettings, use HTTPServerConfig instead **Link to tracking Issue:** #6767

dmitryax pushed a commit that referenced this issue Jan 29, 2024

[confighttp] Deprecate HTTPClientSettings, use HTTPClientConfig inste…

1ed45ec

…ad (#9404) **Description:** Deprecate HTTPClientSettings, use HTTPClientConfig instead **Link to tracking Issue:** #6767

TylerHelmuth mentioned this issue Jan 30, 2024

Decide on naming rules for Settings structs #9428

Closed

2 tasks

dmitryax pushed a commit that referenced this issue Feb 1, 2024

[configgrpc] Deprecate GRPCServerSettings, use ServerConfig instead (#…

421c655

…9403) **Description:** Deprecate GRPCServerSettings, use ~GRPC~ServerConfig instead **Link to tracking Issue:** #6767

dmitryax pushed a commit that referenced this issue Feb 2, 2024

[configgrpc] Deprecate GRPCClientSettings, use ClientConfig instead (#…

3665732

…9402) **Description:** Deprecate GRPCClientSettings, use ClientConfig instead **Link to tracking Issue:** #6767

TylerHelmuth mentioned this issue Feb 21, 2024

[confighttp] Remove deprecated items #9625

Merged

dmitryax pushed a commit that referenced this issue Feb 23, 2024

[confighttp] Remove deprecated items (#9625)

063f5dd

**Description:** Removes deprecated items from `confighttp` **Link to tracking Issue:** Related to #6767

codeboten closed this as completed Apr 17, 2024

github-project-automation bot moved this to Done in Collector: v1 Apr 17, 2024

dmitryax reopened this Jun 5, 2024

dmitryax self-assigned this Jun 5, 2024

mx-psi modified the milestones: Collector v1 distro, go.opentelemetry.io/exporter 1.0 Jul 23, 2024

mx-psi added the good first issue Good for newcomers label Aug 21, 2024

mx-psi assigned jade-guiton-dd Sep 9, 2024

jade-guiton-dd mentioned this issue Sep 11, 2024

[exporterhelper] Rename Timeout/QueueSettings to Config #11132

Merged

jade-guiton-dd mentioned this issue Sep 12, 2024

Update references to newly-deprecated exporterhelper.Timeout/QueueSettings open-telemetry/opentelemetry-collector-contrib#35158

Merged

jade-guiton-dd mentioned this issue Sep 16, 2024

[otlpexporter] Document incidental breaking change on Config struct #11178

Merged

jade-guiton-dd mentioned this issue Sep 24, 2024

[exporterhelper] Remove deprecated aliases for Queue/TimeoutSettings #11264

Merged

mx-psi closed this as completed Oct 1, 2024

jade-guiton-dd mentioned this issue Oct 14, 2024

REQUEST: New membership for jade-guiton-dd open-telemetry/community#2394

Closed

6 tasks

mx-psi mentioned this issue Oct 28, 2024

[chore][docs] Reflect current practices about configuration structs in coding guidelines #11549

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

dmitryax commented Dec 13, 2022 •

edited by mx-psi

Loading

bogdandrutu commented Dec 12, 2023

atoulme commented Jan 25, 2024 •

edited

Loading

TylerHelmuth commented Feb 23, 2024

codeboten commented Apr 17, 2024

codeboten commented Jun 5, 2024

mx-psi commented Sep 9, 2024

jade-guiton-dd commented Sep 9, 2024

jade-guiton-dd commented Oct 1, 2024

mx-psi commented Oct 1, 2024

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

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

Comments

dmitryax commented Dec 13, 2022 • edited by mx-psi Loading

bogdandrutu commented Dec 12, 2023

atoulme commented Jan 25, 2024 • edited Loading

TylerHelmuth commented Feb 23, 2024

codeboten commented Apr 17, 2024

codeboten commented Jun 5, 2024

mx-psi commented Sep 9, 2024

jade-guiton-dd commented Sep 9, 2024

jade-guiton-dd commented Oct 1, 2024

mx-psi commented Oct 1, 2024

dmitryax commented Dec 13, 2022 •

edited by mx-psi

Loading

atoulme commented Jan 25, 2024 •

edited

Loading