Refactor Otel Collector Googlecloud ConfigMap Generation #1665
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Skipping CI for Draft Pull Request. |
|
/test all |
janetkuo
reviewed
May 12, 2025
janetkuo
reviewed
May 16, 2025
tiffanny29631
force-pushed
the
otel-cm
branch
4 times, most recently
from
ad2bcb3 to
10f68b7
Compare
sdowell
reviewed
May 20, 2025
sdowell
reviewed
May 20, 2025
sdowell
reviewed
May 27, 2025
tiffanny29631
force-pushed
the
otel-cm
branch
2 times, most recently
from
6a746be to
4d45a08
Compare
sdowell
reviewed
May 27, 2025
|
|
||
| // Compare the YAML content as strings | ||
| gotYAML := gotConfigMapToYAML(gotConfigMap) | ||
| if configYAML != gotYAML { |
There was a problem hiding this comment.
Suggest using cmp.Diff to compare strings and print a diff. That will be easier to view the difference compared to the full expected yaml. in other words:
- print the
cmp.Diffoutput for easy human readable diff - print the full actual yaml for easy copy/paste if the developer wants to update the expected yaml
There was a problem hiding this comment.
a few minor nits:
- the typical pattern is
if diff := cmp.Diff(wantYAML, gotYAML); diff != "" { ... - use
fmt.Printf, becausefmt.Printlnprints an unintended space between args - use
t.Fatalfto fail immediately
|
/retest-required |
…ruct and YAML Marshaling Refactor the generation of the otel-collector Googlecloud ConfigMap to construct the configuration using a Go map and marshal it to YAML, replacing the previous approach of using a static YAML string. This change improves maintainability and reduces the risk of formatting errors in the generated config. Add GooglecloudCollectorConfigYAML() in pkg/metrics/otel.go to build the config as a Go map and marshal it to YAML. Update OtelReconciler in pkg/reconcilermanager/controllers/otel_controller.go to use the new function when creating/updating the ConfigMap. Update related tests to use the new function for expected config values. Deprecate the old CollectorConfigGooglecloud string constant. This refactor makes the config generation more robust and easier to extend or validate in the future.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sdowell The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
google-oss-prow
bot
merged commit 99ffa7b
into
GoogleContainerTools:main
6 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To Use Go Struct and YAML Marshaling
Refactor the generation of the otel-collector Googlecloud ConfigMap to construct the configuration using a Go map and marshal it to YAML, replacing the previous approach of using a static YAML string. This change improves maintainability and reduces the risk of formatting errors in the generated config. Add GooglecloudCollectorConfigYAML() and deprecate the old CollectorConfigGooglecloud string constant. This refactor makes the config generation more robust and easier to extend or validate in the future.