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.

Sign up for GitHub

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

Jump to bottom

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

Closed
3 tasks done
dmitryax opened this issue Dec 13, 2022 · 9 comments
Closed
3 tasks done

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

dmitryax opened this issue Dec 13, 2022 · 9 comments
Assignees
@dmitryax @jade-guiton-dd
Labels
good first issue Good for newcomers release:required-for-ga Must be resolved before GA release
Milestone
go.opentelemetry....

Comments

@dmitryax
Copy link
Member

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

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
@dmitryax dmitryax added bug Something isn't working and removed bug Something isn't working labels Dec 13, 2022
@dmitryax dmitryax mentioned this issue May 6, 2023
Merged
@dmitryax dmitryax mentioned this issue Aug 8, 2023
Merged
@dmitryax dmitryax mentioned this issue Dec 12, 2023
Merged
@bogdandrutu
Copy link
Member

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

@dmitryax dmitryax mentioned this issue Dec 20, 2023
Open
3 tasks
@atoulme atoulme added the release:required-for-ga Must be resolved before GA release label Jan 25, 2024
@atoulme
Copy link
Contributor

atoulme commented Jan 25, 2024 •
edited
Loading

List of renames:

This was referenced Jan 25, 2024
Closed
Merged
Closed
dmitryax pushed a commit that referenced this issue Jan 26, 2024
@atoulme
[config/confighttp] Deprecate CORSSettings, use CORSConfig instead (#…
9082cb1 
…9392)

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

**Link to tracking Issue:**
#6767
This was referenced Jan 26, 2024
Merged
Merged
Merged
Merged
Merged
dmitryax pushed a commit that referenced this issue Jan 26, 2024
@atoulme
[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
@atoulme
[confighttp] Deprecate HTTPClientSettings, use HTTPClientConfig inste…
1ed45ec 
…ad (#9404)

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

**Link to tracking Issue:**
#6767
@TylerHelmuth TylerHelmuth mentioned this issue Jan 30, 2024
Open
2 tasks
dmitryax pushed a commit that referenced this issue Feb 1, 2024
@atoulme
[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
@atoulme
[configgrpc] Deprecate GRPCClientSettings, use ClientConfig instead (#…
3665732 
…9402)

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

**Link to tracking Issue:**
#6767
dmitryax pushed a commit that referenced this issue Feb 16, 2024
@atoulme
[scraperhelper] Deprecate ScraperControllerSettings, use ControllerCo…
0ab8f44 
…nfig instead (#9401)

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

**Link to tracking Issue:**
#6767
@TylerHelmuth TylerHelmuth mentioned this issue Feb 21, 2024
Merged
dmitryax pushed a commit that referenced this issue Feb 23, 2024
@TylerHelmuth
[confighttp] Remove deprecated items (#9625)
063f5dd 
**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.

@atoulme atoulme mentioned this issue Mar 17, 2024
Merged
dmitryax pushed a commit that referenced this issue Mar 20, 2024
@atoulme
[receiver] Remove deprecated ScraperControllerSettings and `NewDefa…
ef4fb3a 
…ultScraperControllerSettings` (#9783)

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

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

Closing this in favour of #9428

@dmitryax dmitryax reopened this Jun 5, 2024
@codeboten
Copy link
Contributor

exporterhelper still needs updating

@dmitryax dmitryax self-assigned this Jun 5, 2024
@mx-psi mx-psi added the good first issue Good for newcomers label Aug 21, 2024
@mx-psi
Copy link
Member

mx-psi commented Sep 9, 2024

We still need to update:

  • exporterhelper.TimeoutSettings
  • NewDefaultTimeoutSettings
  • exporterhelper.QueueSettings
  • NewDefaultQueueSettings

@jade-guiton-dd
Copy link
Contributor

I'll work on this.

@jade-guiton-dd jade-guiton-dd mentioned this issue Sep 11, 2024
Merged
mx-psi pushed a commit that referenced this issue Sep 11, 2024
@jade-guiton-dd
[exporterhelper] Rename Timeout/QueueSettings to Config (#11132)
6c2697c 
#### 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.
@jade-guiton-dd jade-guiton-dd mentioned this issue Sep 12, 2024
Merged
mx-psi pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this issue Sep 13, 2024
@jade-guiton-dd
Update references to newly-deprecated exporterhelper.Timeout/QueueSet…
9f56cf0 
…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.
@jade-guiton-dd jade-guiton-dd mentioned this issue Sep 16, 2024
Merged
mx-psi pushed a commit that referenced this issue Sep 16, 2024
@jade-guiton-dd
[otlpexporter] Document incidental breaking change on Config struct (#…
232dff7 
…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
@jade-guiton-dd jade-guiton-dd mentioned this issue Sep 24, 2024
Merged
bogdandrutu pushed a commit that referenced this issue Sep 25, 2024
@jade-guiton-dd
[exporterhelper] Remove deprecated aliases for Queue/TimeoutSettings (#…
368cdd0 
…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
Copy link
Contributor

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

@mx-psi
Copy link
Member

mx-psi commented Oct 1, 2024

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

@mx-psi mx-psi closed this as completed Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dmitryax dmitryax

@jade-guiton-dd jade-guiton-dd

Labels
good first issue Good for newcomers release:required-for-ga Must be resolved before GA release
Projects
Collector: v1
Archived in project
Milestone
go.opentelemetry.io/exporter 1.0
Development

No branches or pull requests
7 participants
@atoulme @codeboten @bogdandrutu @mx-psi @dmitryax @TylerHelmuth @jade-guiton-dd