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

[cmd/opampsupervisor] Strictly unmarshal the supervisor configuration #35838

Closed
BinaryFissionGames opened this issue Oct 16, 2024 · 3 comments · Fixed by #36148
Closed

[cmd/opampsupervisor] Strictly unmarshal the supervisor configuration #35838

BinaryFissionGames opened this issue Oct 16, 2024 · 3 comments · Fixed by #36148
Labels
cmd/opampsupervisor good first issue Good for newcomers

Comments

@BinaryFissionGames
Copy link
Contributor

Component(s)

cmd/opampsupervisor

Describe the issue you're reporting

The supervisor configuration currently may contain keys that aren't actually configuring anything. These keys are currently ignored, and the supervisor starts happily.

The issue here is that if you typo a setting, the supervisor will not notify you of your error and the setting will be silently ignored.

Instead, we should do a strict unmarshal of the config in order to error on any extra/unknown keys being present.
@BinaryFissionGames BinaryFissionGames added the needs triage New item requiring triage label Oct 16, 2024
@github-actions GitHub Actions
Copy link
Contributor

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@BinaryFissionGames
Copy link
Contributor Author

/label good-first-issue -needs-triage

@github-actions github-actions bot added good first issue Good for newcomers and removed needs triage New item requiring triage labels Oct 16, 2024
@Annosha
Copy link

Annosha commented Oct 17, 2024

As a beginner, I'm willing to work on it once the maintainers approve!

@github-actions github-actions bot mentioned this issue Oct 22, 2024
Closed
@akstron akstron mentioned this issue Nov 2, 2024
Merged
shivanthzen pushed a commit to shivanthzen/opentelemetry-collector-contrib that referenced this issue Dec 5, 2024
@akstron @evan-bradley @shivanthzen
[cmd/opampsupervisor] Enable Strict Unmarshal for Supervisor Configur…
dc3f1ce 
…ation (open-telemetry#36148)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
The changes includes providing a custom `DecoderConfig` with
`ErrorUnused` enabled instead of using the default `DecoderConfig`
provided by `koanf`

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes: open-telemetry#35838 

<!--Describe what testing was performed and which tests were added.-->

<!--Describe the documentation added.-->

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Signed-off-by: Alok Kumar Singh <dev.alok.singh123@gmail.com>
Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
ZenoCC-Peng pushed a commit to ZenoCC-Peng/opentelemetry-collector-contrib that referenced this issue Dec 6, 2024
@akstron @evan-bradley @ZenoCC-Peng
[cmd/opampsupervisor] Enable Strict Unmarshal for Supervisor Configur…
76082cf 
…ation (open-telemetry#36148)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
The changes includes providing a custom `DecoderConfig` with
`ErrorUnused` enabled instead of using the default `DecoderConfig`
provided by `koanf`

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes: open-telemetry#35838 

<!--Describe what testing was performed and which tests were added.-->

<!--Describe the documentation added.-->

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Signed-off-by: Alok Kumar Singh <dev.alok.singh123@gmail.com>
Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
sbylica-splunk pushed a commit to sbylica-splunk/opentelemetry-collector-contrib that referenced this issue Dec 17, 2024
@akstron @evan-bradley @sbylica-splunk
[cmd/opampsupervisor] Enable Strict Unmarshal for Supervisor Configur…
e531594 
…ation (open-telemetry#36148)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
The changes includes providing a custom `DecoderConfig` with
`ErrorUnused` enabled instead of using the default `DecoderConfig`
provided by `koanf`

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes: open-telemetry#35838 

<!--Describe what testing was performed and which tests were added.-->

<!--Describe the documentation added.-->

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Signed-off-by: Alok Kumar Singh <dev.alok.singh123@gmail.com>
Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cmd/opampsupervisor good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
2 participants
@BinaryFissionGames @Annosha