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

feat: add logs for policy ignores #4816

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: add logs for policy ignores #4816

wants to merge 3 commits into from

Conversation

davhdavh
Copy link
Contributor

Description

Log when endpoints changes are dropped due to policy

Fixes #4815

Checklist

  • Unit tests updated
  • End user documentation updated

@k8s-ci-robot
Copy link
Contributor

[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 assign raffo for approval. For more information see the Kubernetes Code Review Process.

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

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

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 17, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @davhdavh. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 17, 2024
@mloiseleur
Copy link
Contributor

At first glance, it looks like it will generate (potentially) many logs for the same CLI switch.
Since this is the explicit purpose of this policy, I am not sure to see the value of this one.
Did I miss something ?

@davhdavh
Copy link
Contributor Author

Don't think you missed anything. External-dns is already extremely spammy at debug level, and this certainly would not help with that.
There is however no current way to evaluate what the choosen policy actually does, and therefore there is great value in having it output what it actually does.

@davhdavh
fix: add check for log level
426ba9d
@davhdavh
fix: since policy now logs what it would have done, it makes sense to…
30a5274 
… do them after the endpoint filtering, so that the logs does not contain things that get filtered out anyway
@mloiseleur
Copy link
Contributor

The code lgtm. I'm unsure if we should do it or not. I have not a strong opinion on this subject.
I'll let @Raffo make a final decision on this.
/lgtm
/assign @Raffo

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 22, 2024
@mloiseleur
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 22, 2024
@mloiseleur mloiseleur removed their assignment Dec 22, 2024
ivankatliarchuk
ivankatliarchuk reviewed Jan 22, 2025
View reviewed changes
plan/policy.go
@@ -53,6 +62,17 @@ type CreateOnlyPolicy struct{}

// Apply applies the create-only policy which strips out updates and deletions.
func (p *CreateOnlyPolicy) Apply(changes *Changes) *Changes {
if log.GetLevel() == log.DebugLevel {
Copy link
Contributor

Choose a reason for hiding this comment

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

Shell we consider something like that. To avoid code duplication and improve readability, you can extract the logging logic to a separate function.

if log.GetLevel() == log.DebugLevel {
	logSkippedEndpoints("deletion", changes.Delete)
	logSkippedEndpoints("update-old", changes.UpdateOld)
	logSkippedEndpoints("update-new", changes.UpdateNew)
}

func logSkippedEndpoints(action string, endpoints []*endpoint.Endpoint) {
	for _, ep := range endpoints {
		log.Debugf(`Skipping %s of endpoint %v due to "create-only" policy`, action, ep)
	}
}

plan/plan.go
@@ -257,6 +253,10 @@ func (p *Plan) Calculate() *Plan {
changes.UpdateNew = endpoint.FilterEndpointsByOwnerID(p.OwnerID, changes.UpdateNew)
}

for _, pol := range p.Policies {
Copy link
Contributor

Choose a reason for hiding this comment

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

is order matter?

plan/policy.go
@@ -41,6 +45,11 @@ type UpsertOnlyPolicy struct{}

// Apply applies the upsert-only policy which strips out any deletions.
func (p *UpsertOnlyPolicy) Apply(changes *Changes) *Changes {
if log.GetLevel() == log.DebugLevel {
Copy link
Contributor

Choose a reason for hiding this comment

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

Any chance to cover all this changes with tests?

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

@ivankatliarchuk ivankatliarchuk ivankatliarchuk left review comments

@mloiseleur mloiseleur Awaiting requested review from mloiseleur

@szuecs szuecs Awaiting requested review from szuecs

Assignees

@Raffo Raffo

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Log when upsert or create ignores a command
5 participants
@davhdavh @k8s-ci-robot @mloiseleur @ivankatliarchuk @Raffo