Skip to content

🌱 Switch logging implementation to klog #2810

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

Open
fmuyassarov wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −29
Open

🌱 Switch logging implementation to klog #2810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ require (
github.com/prometheus/client_golang v1.23.2
github.com/stretchr/testify v1.11.1
go.etcd.io/etcd/client/pkg/v3 v3.6.6
go.uber.org/zap v1.27.1
k8s.io/api v0.34.2
k8s.io/apimachinery v0.34.2
k8s.io/client-go v0.34.2
Expand Down Expand Up @@ -77,6 +76,7 @@ require (
go.opentelemetry.io/otel/trace v1.35.0 // indirect
go.opentelemetry.io/proto/otlp v1.5.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.27.0 // indirect
go.yaml.in/yaml/v2 v2.4.2 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,8 @@ go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
go.uber.org/zap v1.27.1 h1:08RqriUEv8+ArZRYSTXy1LeBScaMpVSTBhCeaZYfMYc=
go.uber.org/zap v1.27.1/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=
go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
go.yaml.in/yaml/v2 v2.4.2 h1:DzmwEr2rDGHl7lsFgAHxmNz/1NlQ7xLIrlN2h5d1eGI=
go.yaml.in/yaml/v2 v2.4.2/go.mod h1:081UH+NErpNdqlCXm3TtEran0rJZGxAYx9hb/ELlsPU=
go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc=
Expand Down
38 changes: 15 additions & 23 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,15 @@ import (
"github.com/metal3-io/baremetal-operator/pkg/secretutils"
"github.com/metal3-io/baremetal-operator/pkg/version"
ironicv1alpha1 "github.com/metal3-io/ironic-standalone-operator/api/v1alpha1"
"go.uber.org/zap/zapcore"
k8sruntime "k8s.io/apimachinery/pkg/runtime"
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
cliflag "k8s.io/component-base/cli/flag"
"k8s.io/klog/v2"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/healthz"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
"sigs.k8s.io/controller-runtime/pkg/metrics/filters"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
"sigs.k8s.io/controller-runtime/pkg/webhook"
Expand Down Expand Up @@ -75,7 +74,6 @@ const leaderElectionID = "baremetal-operator"

func init() {
_ = clientgoscheme.AddToScheme(scheme)

_ = metal3api.AddToScheme(scheme)
_ = ironicv1alpha1.AddToScheme(scheme)
}
Expand Down Expand Up @@ -177,14 +175,7 @@ func main() {

flag.Parse()

logOpts := zap.Options{}
if devLogging {
logOpts.Development = true
logOpts.TimeEncoder = zapcore.ISO8601TimeEncoder
} else {
logOpts.TimeEncoder = zapcore.EpochTimeEncoder
}
ctrl.SetLogger(zap.New(zap.UseFlagOptions(&logOpts)))
ctrl.SetLogger(klog.Background())

printVersion()

Expand Down Expand Up @@ -302,13 +293,14 @@ func main() {

var provisionerFactory provisioner.Factory
if runInTestMode {
ctrl.Log.Info("using test provisioner")
klog.Info("using test provisioner")
provisionerFactory = &fixture.Fixture{}
} else if runInDemoMode {
ctrl.Log.Info("using demo provisioner")
klog.Info("using demo provisioner")
provisionerFactory = &demo.Demo{}
} else {
provLog := zap.New(zap.UseFlagOptions(&logOpts)).WithName("provisioner")
provLog := klog.NewKlogr().WithName("provisioner")
ctrl.SetLogger(provLog)
// Check if we should use Ironic CR integration
if ironicName != "" && ironicNamespace != "" {
provisionerFactory, err = ironic.NewProvisionerFactoryWithClient(provLog, preprovImgEnable,
Expand All @@ -330,7 +322,7 @@ func main() {

if err = (&metal3iocontroller.BareMetalHostReconciler{
Client: mgr.GetClient(),
Log: ctrl.Log.WithName("controllers").WithName("BareMetalHost"),
Log: ctrl.Log.WithName("BareMetalHost"),
ProvisionerFactory: provisionerFactory,
APIReader: mgr.GetAPIReader(),
}).SetupWithManager(mgr, preprovImgEnable, maxConcurrency); err != nil {
Expand All @@ -341,7 +333,7 @@ func main() {
if preprovImgEnable {
imgReconciler := metal3iocontroller.PreprovisioningImageReconciler{
Client: mgr.GetClient(),
Log: ctrl.Log.WithName("controllers").WithName("PreprovisioningImage"),
Log: ctrl.Log.WithName("PreprovisioningImage"),
APIReader: mgr.GetAPIReader(),
Scheme: mgr.GetScheme(),
ImageProvider: imageprovider.NewDefaultImageProvider(),
Expand All @@ -357,7 +349,7 @@ func main() {

if err = (&metal3iocontroller.HostFirmwareSettingsReconciler{
Client: mgr.GetClient(),
Log: ctrl.Log.WithName("controllers").WithName("HostFirmwareSettings"),
Log: ctrl.Log.WithName("HostFirmwareSettings"),
ProvisionerFactory: provisionerFactory,
}).SetupWithManager(mgr, maxConcurrency); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "HostFirmwareSettings")
Expand All @@ -366,7 +358,7 @@ func main() {

if err = (&metal3iocontroller.BMCEventSubscriptionReconciler{
Client: mgr.GetClient(),
Log: ctrl.Log.WithName("controllers").WithName("BMCEventSubscription"),
Log: ctrl.Log.WithName("BMCEventSubscription"),
ProvisionerFactory: provisionerFactory,
}).SetupWithManager(mgr, maxConcurrency); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "BMCEventSubscription")
Expand All @@ -375,7 +367,7 @@ func main() {

if err = (&metal3iocontroller.HostFirmwareComponentsReconciler{
Client: mgr.GetClient(),
Log: ctrl.Log.WithName("controllers").WithName("HostFirmwareComponents"),
Log: ctrl.Log.WithName("HostFirmwareComponents"),
ProvisionerFactory: provisionerFactory,
}).SetupWithManager(mgr, maxConcurrency); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "HostFirmwareComponents")
Expand All @@ -384,7 +376,7 @@ func main() {

if err = (&metal3iocontroller.DataImageReconciler{
Client: mgr.GetClient(),
Log: ctrl.Log.WithName("controllers").WithName("DataImage"),
Log: ctrl.Log.WithName("DataImage"),
ProvisionerFactory: provisionerFactory,
}).SetupWithManager(mgr, maxConcurrency); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "DataImage")
Expand All @@ -397,7 +389,7 @@ func main() {
setupWebhooks(mgr)
}

setupLog.Info("starting manager")
klog.Info("starting manager")
if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
setupLog.Error(err, "problem running manager")
os.Exit(1)
Expand Down Expand Up @@ -439,7 +431,7 @@ func GetTLSOptionOverrideFuncs(options TLSOptions) ([]func(*tls.Config), error)
// Cipher suites should not be set if empty.
if tlsMinVersion >= tls.VersionTLS13 &&
options.TLSCipherSuites != "" {
setupLog.Info("warning: Cipher suites should not be set for TLS version 1.3. Ignoring ciphers")
klog.Info("warning: Cipher suites should not be set for TLS version 1.3. Ignoring ciphers")
options.TLSCipherSuites = ""
}

Expand All @@ -454,7 +446,7 @@ func GetTLSOptionOverrideFuncs(options TLSOptions) ([]func(*tls.Config), error)
for _, cipher := range tlsCipherSuites {
for _, insecureCipherName := range insecureCipherValues {
if insecureCipherName == cipher {
setupLog.Info(fmt.Sprintf("warning: use of insecure cipher '%s' detected.", cipher))
klog.Infof("warning: use of insecure cipher '%s' detected.", cipher)
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/provisioner/fixture/fixture.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ import (
metal3api "github.com/metal3-io/baremetal-operator/apis/metal3.io/v1alpha1"
"github.com/metal3-io/baremetal-operator/pkg/hardwareutils/bmc"
"github.com/metal3-io/baremetal-operator/pkg/provisioner"
logz "sigs.k8s.io/controller-runtime/pkg/log/zap"
"k8s.io/klog/v2"
)

var log = logz.New().WithName("provisioner").WithName("fixture")
var log = klog.NewKlogr().WithName("provisioner").WithName("fixture")
var deprovisionRequeueDelay = time.Second * 10
var provisionRequeueDelay = time.Second * 10
var inspectionRequeueDelay = time.Second * 2
Expand Down
1 change: 0 additions & 1 deletion pkg/provisioner/ironic/factory.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ func (f *ironicProvisionerFactory) init(havePreprovImgBuilder bool) error {
}

tlsConf := loadTLSConfigFromEnv()

f.log.Info("ironic settings from environment variables",
"endpoint", ironicEndpoint,
"ironicAuthType", ironicAuth.Type,
Expand Down