virtualization icon indicating copy to clipboard operation
virtualization copied to clipboard

chore(vm): reduce noise in logs about "namespaces not found"

Open diafour opened this issue 2 months ago • 2 comments

Description

Do not requeue reconcile if status was not updated with error "namespaces ... not found". Just print Warning in this situation.

Why do we need it, and what problem does it solve?

This situation is not an error, but it fails e2e tests with this messages:

  this is the `Virtualization-controller` error! not the current `Ginkgo` context error:
  {
    "level": "error",
    "msg": "Failed to update resource",
    "err": "error updating status subresource: namespaces \"dvp-e2e-m-sds-20251008-145944-724\" not found",
    "controller": "vm-controller",
    "handler": "",
    "ds": "",
    "collector": "",
    "name": "x-559ce0-worker-afad0dff-t78m8-hmnl8",
    "namespace": "dvp-e2e-m-sds-20251008-145944-724",
    "reconcileID": "d2587a50-d711-47b6-83a7-ff620e39706f",
    "time": "2025-10-13T02:03:39Z"
  }
  

What is the expected result?

Reduce number of false-negative e2e runs.

Checklist

  • [ ] The code is covered by unit tests.
  • [ ] e2e tests passed.
  • [ ] Documentation updated according to the changes.
  • [ ] Changes were tested in the Kubernetes cluster manually.

Changelog entries

section: vm
type: chore
summary: Reduce noise in logs about "namespaces not found".

diafour avatar Oct 13 '25 18:10 diafour

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Introduce a new branch in the reconcile handler that intercepts namespace-not-found errors, logs them as warnings, and suppresses requeueing, reducing log noise during e2e tests.

Sequence diagram for updated error handling in VM reconcile process

sequenceDiagram
participant Controller
participant Logger
participant KubernetesAPI
Controller->KubernetesAPI: Update resource status
KubernetesAPI-->>Controller: Error (namespace not found)
Controller->Logger: Warn("Namespace is gone while reconcile the object")
Note over Controller: No requeue triggered

Class diagram for updated error handling in Reconciler

classDiagram
class Reconciler {
  +reconcile()
}
Reconciler : +handlersLoop
Reconciler : -case k8serrors.IsNotFound(err) && strings.Contains(err.Error(), "namespaces")
Reconciler : +Warn("Namespace is gone while reconcile the object")

File-Level Changes

Change Details Files
Add conditional handling for namespace-not-found errors to log a warning and skip requeue
  • Added a new case checking for k8serrors.IsNotFound(err) && error message containing "namespaces"
  • Replaced error log with logger.Warn for this specific condition
  • Removed explicit requeue or error accumulation when namespace is gone
images/virtualization-artifact/pkg/controller/reconciler/reconciler.go

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an issue from a review comment by replying to it. You can also reply to a review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull request title to generate a title at any time. You can also comment @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment @sourcery-ai summary on the pull request to (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

  • Contact our support team for questions or feedback.
  • Visit our documentation for detailed guides and information.
  • Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai[bot] avatar Oct 13 '25 18:10 sourcery-ai[bot]

Warning is not enough here. May be we should add metric and alert for such cases.

The problem was that VM stuck in Terminating state but NS was forced to delete.

diafour avatar Oct 14 '25 11:10 diafour