Use the controller-runtime logger in the cert-generator #2219
Conversation
This file contains 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
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: tenzen-y 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
requested review from
andreyvelich,
anencore94 and
johnugeorge
| } | ||
| return false, nil | ||
| } | ||
| keyFile := filepath.Join(consts.CertDir, serverKeyName) | ||
| if _, err := os.Stat(keyFile); err != nil { | ||
| if outputLog { | ||
| klog.Infof("Private key file %q doesn't exist in the container yet", keyFile) | ||
| log.Info("Private key file %q doesn't exist in the container yet", "privateKeyFile", keyFile) |
There was a problem hiding this comment.
Suggested change
| log.Info("Private key file %q doesn't exist in the container yet", "privateKeyFile", keyFile) | |
| log.Info("Private key file doesn't exist in the container yet.", "privateKeyFile", keyFile) |
| @@ -98,18 +100,18 @@ func ensureCertMounted(start time.Time) func(context.Context) (bool, error) { | |||
| certFile := filepath.Join(consts.CertDir, serverCertName) | |||
| if _, err := os.Stat(certFile); err != nil { | |||
| if outputLog { | |||
| klog.Infof("Public key file %q doesn't exist in the container yet", certFile) | |||
| log.Info("Public key file %q doesn't exist in the container yet.", "publicKeyFile", certFile) | |||
There was a problem hiding this comment.
Suggested change
| log.Info("Public key file %q doesn't exist in the container yet.", "publicKeyFile", certFile) | |
| log.Info("Public key file doesn't exist in the container yet.", "publicKeyFile", certFile) |
Signed-off-by: Yuki Iwai <yuki.iwai.tz@gmail.com>
tenzen-y
force-pushed
the
use-the-same-logger
branch
from
2306c5a
to
c3d9828
Compare
|
Thank you @tenzen-y! |
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.
What this PR does / why we need it:
Currently, we use the klog in the cert-generator and the controller-runtime logger in other controllers, such as the experiment-controller. So the manager output logs using a different format from the other controllers for the cert-generator, as shown below:
... {"level":"info","ts":"2023-08-18T04:36:53Z","msg":"Starting server","kind":"health probe","addr":"[::]:18080"} {"level":"info","ts":"2023-08-18T04:36:53Z","msg":"starting server","path":"/metrics","kind":"metrics","addr":"[::]:8080"} I0818 04:36:54.087010 1 generator.go:199] Generating self-signed public certificate and private key. {"level":"info","ts":"2023-08-18T04:36:54Z","logger":"controller-runtime.healthz","msg":"healthz check failed","statuses":[{}]} I0818 04:36:54.334683 1 generator.go:255] Trying to patch ValidatingWebhookConfiguration adding the caBundle. I0818 04:36:54.441560 1 generator.go:282] Trying to patch MutatingWebhookConfiguration adding the caBundle. ...However, we should use the same format to improve the visibility of the logs in the manager.
So I replaced the cert-generator logger with the same as the other controllers one:
katib/pkg/controller.v1beta1/experiment/experiment_controller.go
Lines 56 to 58 in 1f5fb48
After applying this patch, the manager will output logs in the following:
... {"level":"info","ts":"2023-08-18T04:38:16Z","msg":"Starting server","kind":"health probe","addr":"[::]:18080"} {"level":"info","ts":"2023-08-18T04:38:16Z","msg":"starting server","path":"/metrics","kind":"metrics","addr":"[::]:8080"} {"level":"info","ts":"2023-08-18T04:38:16Z","logger":"controller-runtime.healthz","msg":"healthz check failed","statuses":[{}]} {"level":"info","ts":"2023-08-18T04:38:16Z","logger":"cert-generator","msg":"Waiting for certs to get ready."} {"level":"info","ts":"2023-08-18T04:38:16Z","logger":"cert-generator","msg":"Succeeded to be mounted certs inside the container."} ...Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #
Checklist: