webhook: switch to contextual logger

[ykaliuta]

Jira: https://issues.redhat.com/browse/RHOAIENG-14419

Use k8s contextual logger instead of own. Comparing to other parts of the operator webhook is a bit special since it serves own endpoints and has context independent from controllers.

Include more info (operation), just to get more details. Do not add kind since it's clear from "resource" field.

Since controller-framework adds "admission" to the name, use own LogConstructor with own base logger for the framework's DefaultLogConstructor.

Add name locally to distinguish from framework's messages.

Add Name field to the structures to avoid copying string literal for both WithName() and WithValues().

The output changes and it looks like

{"level":"info","ts":"2024-10-11T05:17:20Z","logger":"ValidatingWebhook","msg":"Validation request","object":{"name":"default-dsci"},"namespace":"","name":"default-dsci","resource":{"group":"dscinitialization.opendatahub.io","version":"v1","resource":"dscinitializations"},"user":"kube:admin","requestID":"e5bf3768-6faa-4e14-9004-e54ee84ad8b7","webhook":"ValidatingWebhook","operation":"CREATE"}

or for the defaulter:

{"level":"info","ts":"2024-10-11T04:50:48Z","logger":"DefaultingWebhook","msg":"Defaulting DSC","object":{"name":"default-dsc"},"namespace":"","name":"default-dsc","resource":{"group":"datasciencecluster.opendatahub.io","version":"v1","resource":"datascienceclusters"},"user":"kube:admin","requestID":"c9213ff3-80ee-40c0-9f15-12188dece68e","webhook":"DefaultingWebhook"}

(the messages are not from the current codebase, was added for demo only)

Description

How Has This Been Tested?

Screenshot or short clip

Merge criteria

• You have read the contributors guide.
• Commit messages are meaningful - have a clear and concise summary and detailed explanation of what was changed and why.
• Pull Request contains a description of the solution, a link to the JIRA issue, and to any dependent or related Pull Request.
• Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
• The developer has manually tested the changes and verified that the changes work

[ykaliuta]

/cc @lburgazzoli @zdtsw

[ykaliuta]

I can add "webhook" to the name, may be it will make filtering a bit easy( .WithName("webhook") should make "logger": "admission.webhook"). What do you think?

{"level":"info","ts":"2024-10-10T07:10:07Z","logger":"admission.webhook","msg":"Got request","object":{"name":"default-dsc"},"namespace":"","name":"default-dsc","resource":{"group":"datasciencecluster.opendatahub.io","version":"v1","resource":"datascienceclusters"},"user":"kube:admin","requestID":"031bd339-2da2-4c42-aa76-44bc6f571ce2"}

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 73.33333% with 4 lines in your changes missing coverage. Please review.

Please upload report for BASE (incubation@e8e266f). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
controllers/webhook/webhook.go	73.33%	4 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             incubation    #1295   +/-   ##
=============================================
  Coverage              ?   19.24%           
=============================================
  Files                 ?       30           
  Lines                 ?     2676           
  Branches              ?        0           
=============================================
  Hits                  ?      515           
  Misses                ?     2099           
  Partials              ?       62           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[lburgazzoli]

+1 to add webhook to the name

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zdtsw

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:

• OWNERS [zdtsw]

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

[zdtsw]

/onhold

[zdtsw]

did not see the comments that you wanna add the name

[openshift-ci]

New changes are detected. LGTM label has been removed.

[ykaliuta]

Updated. Wondering, would it be better to move newLogConstructor to logger package.

[ykaliuta]

/cc @bartoszmajsak

[lburgazzoli]

LGTM, I let @zdtsw for final review

[zdtsw]

i am fine with the change, only one part i am not sure is Name: "DSCDefaulter",
when i added the DSCDefaulter, it was used for internal type/variable, but if we want it be in the logger , it could get confused for the one does not know the detail of code.
can it be something maybe MutatingDefaultWebhook ?

[ykaliuta]

i am fine with the change, only one part i am not sure is Name: "DSCDefaulter", when i added the DSCDefaulter, it was used for internal type/variable, but if we want it be in the logger , it could get confused for the one does not know the detail of code. can it be something maybe MutatingDefaultWebhook ?

Good point. Will "DefaultingWebhook" work?

[ykaliuta]

/unhold