Skip to content

feat: support disabling monitoring for RootSync and RepoSync#2233

Open
cowsking wants to merge 1 commit into
GoogleContainerTools:mainfrom
cowsking:feat/disable-monitoring-1-25
Open

feat: support disabling monitoring for RootSync and RepoSync#2233
cowsking wants to merge 1 commit into
GoogleContainerTools:mainfrom
cowsking:feat/disable-monitoring-1-25

Conversation

@cowsking

Copy link
Copy Markdown
Contributor

This commit introduces the ability to opt-out of monitoring sidecars (specifically otel-agent) for RootSync and RepoSync objects via the spec.monitoring.enabled field in the declarative API.

When monitoring is disabled, the config-sync controllers will omit the otel-agent container from the reconciler pods and set the environment variable DISABLE_MONITORING=true in the remaining vital containers to silence telemetry exporter logic. All Unit and E2E tests for this logic have been implemented accordingly.

@google-oss-prow

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from cowsking. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces the ability to disable monitoring in Config Sync by adding a monitoring field to the RepoSync and RootSync CRD specs, and conditionally omitting the otel-agent container and its volumes when disabled. However, a critical issue was identified in the metrics registration logic across pkg/metrics/register.go, pkg/kmetrics/register.go, and pkg/resourcegroup/controllers/metrics/register.go. Returning a nil exporter when DISABLE_MONITORING is active will cause runtime panics (nil pointer dereferences) in callers that invoke defer exporter.Shutdown(ctx) or use the exporter without a nil check. To resolve this, all callers must be updated to handle a nil exporter safely, or a safe no-op exporter should be returned.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread pkg/metrics/register.go
Comment thread pkg/kmetrics/register.go
Comment thread pkg/resourcegroup/controllers/metrics/register.go
Comment thread e2e/testcases/disable_monitoring_test.go
Comment thread e2e/testcases/disable_monitoring_test.go
@cowsking
cowsking force-pushed the feat/disable-monitoring-1-25 branch from d603b59 to e458faf Compare July 21, 2026 21:54
@cowsking
cowsking force-pushed the feat/disable-monitoring-1-25 branch 2 times, most recently from bf2f2f0 to 8651415 Compare July 21, 2026 22:38
This commit introduces the ability to opt-out of monitoring sidecars
(specifically otel-agent) for RootSync and RepoSync objects via the
spec.monitoring.enabled field in the declarative API.

When monitoring is disabled, the config-sync controllers will omit the
otel-agent container from the reconciler pods and set the environment
variable DISABLE_MONITORING=true in the remaining vital containers to
silence telemetry exporter logic. All Unit and E2E tests for this logic
have been implemented accordingly.

TAG=agy
@cowsking
cowsking force-pushed the feat/disable-monitoring-1-25 branch from 8651415 to 1df8436 Compare July 22, 2026 17:04
@cowsking

Copy link
Copy Markdown
Contributor Author

/retest

@cowsking

Copy link
Copy Markdown
Contributor Author

/test kpt-config-sync-presubmit-e2e-multi-repo-test-group3

@cowsking

Copy link
Copy Markdown
Contributor Author

/test kpt-config-sync-presubmit-e2e-multi-repo-test-group1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants