Add name to reconciler logs. (grafana#1033)

smuda · web-flow · commit 59de076348a2 · 2023-05-08T08:47:04.000+02:00
diff --git a/controllers/dashboard_controller.go b/controllers/dashboard_controller.go
@@ -61,7 +61,7 @@ type GrafanaDashboardReconciler struct {
 //+kubebuilder:rbac:groups=grafana.integreatly.org,resources=grafanadashboards/finalizers,verbs=update
 
 func (r *GrafanaDashboardReconciler) syncDashboards(ctx context.Context) (ctrl.Result, error) {
-	syncLog := log.FromContext(ctx)
+	syncLog := log.FromContext(ctx).WithName("GrafanaDashboardReconciler")
 	dashboardsSynced := 0
 
 	// get all grafana instances
@@ -148,7 +148,7 @@ func getDashboardsToDelete(allDashboards *v1beta1.GrafanaDashboardList, grafanas
 }
 
 func (r *GrafanaDashboardReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	controllerLog := log.FromContext(ctx)
+	controllerLog := log.FromContext(ctx).WithName("GrafanaDashboardReconciler")
 	r.Log = controllerLog
 
 	// periodic sync reconcile
diff --git a/controllers/datasource_controller.go b/controllers/datasource_controller.go
@@ -51,7 +51,7 @@ type GrafanaDatasourceReconciler struct {
 //+kubebuilder:rbac:groups=grafana.integreatly.org,resources=grafanadatasources/finalizers,verbs=update
 
 func (r *GrafanaDatasourceReconciler) syncDatasources(ctx context.Context) (ctrl.Result, error) {
-	syncLog := log.FromContext(ctx)
+	syncLog := log.FromContext(ctx).WithName("GrafanaDatasourceReconciler")
 	datasourcesSynced := 0
 
 	// get all grafana instances
@@ -139,7 +139,7 @@ func (r *GrafanaDatasourceReconciler) syncDatasources(ctx context.Context) (ctrl
 }
 
 func (r *GrafanaDatasourceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	controllerLog := log.FromContext(ctx)
+	controllerLog := log.FromContext(ctx).WithName("GrafanaDatasourceReconciler")
 	r.Log = controllerLog
 
 	// periodic sync reconcile
diff --git a/controllers/grafana_controller.go b/controllers/grafana_controller.go
@@ -61,7 +61,7 @@ type GrafanaReconciler struct {
 //+kubebuilder:rbac:groups=networking.k8s.io,resources=ingresses,verbs=get;list;watch;create;update;patch;delete
 
 func (r *GrafanaReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	controllerLog := log.FromContext(ctx)
+	controllerLog := log.FromContext(ctx).WithName("GrafanaReconciler")
 
 	grafana := &grafanav1beta1.Grafana{}
 	err := r.Get(ctx, req.NamespacedName, grafana)
diff --git a/controllers/grafanafolder_controller.go b/controllers/grafanafolder_controller.go
@@ -50,7 +50,7 @@ type GrafanaFolderReconciler struct {
 //+kubebuilder:rbac:groups=grafana.integreatly.org,resources=grafanafolders/finalizers,verbs=update
 
 func (r *GrafanaFolderReconciler) syncFolders(ctx context.Context) (ctrl.Result, error) {
-	syncLog := log.FromContext(ctx)
+	syncLog := log.FromContext(ctx).WithName("GrafanaFolderReconciler")
 	foldersSynced := 0
 
 	// get all grafana instances
@@ -141,7 +141,7 @@ func (r *GrafanaFolderReconciler) syncFolders(ctx context.Context) (ctrl.Result,
 // For more details, check Reconcile and its Result here:
 // - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.9.2/pkg/reconcile
 func (r *GrafanaFolderReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	controllerLog := log.FromContext(ctx)
+	controllerLog := log.FromContext(ctx).WithName("GrafanaFolderReconciler")
 	r.Log = controllerLog
 
 	// periodic sync reconcile
diff --git a/controllers/reconcilers/grafana/complete_reconciler.go b/controllers/reconcilers/grafana/complete_reconciler.go
@@ -16,7 +16,7 @@ func NewCompleteReconciler() reconcilers.OperatorGrafanaReconciler {
 }
 
 func (r *CompleteReconciler) Reconcile(ctx context.Context, cr *v1beta1.Grafana, status *v1beta1.GrafanaStatus, vars *v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {
-	logger := log.FromContext(ctx)
+	logger := log.FromContext(ctx).WithName("CompleteReconciler")
 	logger.Info("grafana installation complete")
 	return v1beta1.OperatorStageResultSuccess, nil
 }
diff --git a/controllers/reconcilers/grafana/deployment_reconciler.go b/controllers/reconcilers/grafana/deployment_reconciler.go
@@ -45,7 +45,7 @@ func NewDeploymentReconciler(client client.Client, isOpenShift bool) reconcilers
 }
 
 func (r *DeploymentReconciler) Reconcile(ctx context.Context, cr *v1beta1.Grafana, status *v1beta1.GrafanaStatus, vars *v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {
-	logger := log.FromContext(ctx)
+	logger := log.FromContext(ctx).WithName("DeploymentReconciler")
 
 	openshiftPlatform := r.isOpenShift
 	logger.Info("reconciling deployment", "openshift", openshiftPlatform)
diff --git a/controllers/reconcilers/grafana/ingress_reconciler.go b/controllers/reconcilers/grafana/ingress_reconciler.go
@@ -33,7 +33,7 @@ func NewIngressReconciler(client client.Client, isOpenShift bool) reconcilers.Op
 }
 
 func (r *IngressReconciler) Reconcile(ctx context.Context, cr *v1beta1.Grafana, status *v1beta1.GrafanaStatus, vars *v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {
-	logger := log.FromContext(ctx)
+	logger := log.FromContext(ctx).WithName("IngressReconciler")
 
 	if r.isOpenShift {
 		logger.Info("reconciling route", "platform", "openshift")
diff --git a/controllers/reconcilers/grafana/plugins_reconciler.go b/controllers/reconcilers/grafana/plugins_reconciler.go
@@ -24,7 +24,7 @@ func NewPluginsReconciler(client client.Client) reconcilers.OperatorGrafanaRecon
 }
 
 func (r *PluginsReconciler) Reconcile(ctx context.Context, cr *v1beta1.Grafana, status *v1beta1.GrafanaStatus, vars *v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {
-	logger := log.FromContext(ctx)
+	logger := log.FromContext(ctx).WithName("PluginsReconciler")
 
 	plugins := model.GetPluginsConfigMap(cr, scheme)
 	selector := client.ObjectKey{
diff --git a/controllers/reconcilers/grafana/pvc_reconciler.go b/controllers/reconcilers/grafana/pvc_reconciler.go
@@ -23,7 +23,7 @@ func NewPvcReconciler(client client.Client) reconcilers.OperatorGrafanaReconcile
 }
 
 func (r *PvcReconciler) Reconcile(ctx context.Context, cr *v1beta1.Grafana, status *v1beta1.GrafanaStatus, vars *v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {
-	logger := log.FromContext(ctx)
+	logger := log.FromContext(ctx).WithName("PvcReconciler")
 
 	if cr.Spec.PersistentVolumeClaim == nil {
 		logger.Info("skip creating persistent volume claim")
diff --git a/main.go b/main.go
@@ -153,15 +153,15 @@ func main() {
 	if err = (&controllers.GrafanaDashboardReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
-		Log:    ctrl.Log,
+		Log:    ctrl.Log.WithName("DashboardReconciler"),
 	}).SetupWithManager(mgr, ctx); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "GrafanaDashboard")
 		os.Exit(1)
 	}
 	if err = (&controllers.GrafanaDatasourceReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
-		Log:    ctrl.Log,
+		Log:    ctrl.Log.WithName("DatasourceReconciler"),
 	}).SetupWithManager(mgr, ctx); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "GrafanaDatasource")
 		os.Exit(1)

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ func NewCompleteReconciler() reconcilers.OperatorGrafanaReconciler {`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`func (r CompleteReconciler) Reconcile(ctx context.Context, cr v1beta1.Grafana, status v1beta1.GrafanaStatus, vars v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {`
`19`		`- logger := log.FromContext(ctx)`
	`19`	`+ logger := log.FromContext(ctx).WithName("CompleteReconciler")`
`20`	`20`	`logger.Info("grafana installation complete")`
`21`	`21`	`return v1beta1.OperatorStageResultSuccess, nil`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ func NewDeploymentReconciler(client client.Client, isOpenShift bool) reconcilers`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`func (r DeploymentReconciler) Reconcile(ctx context.Context, cr v1beta1.Grafana, status v1beta1.GrafanaStatus, vars v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {`
`48`		`- logger := log.FromContext(ctx)`
	`48`	`+ logger := log.FromContext(ctx).WithName("DeploymentReconciler")`
`49`	`49`
`50`	`50`	`openshiftPlatform := r.isOpenShift`
`51`	`51`	`logger.Info("reconciling deployment", "openshift", openshiftPlatform)`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ func NewIngressReconciler(client client.Client, isOpenShift bool) reconcilers.Op`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`func (r IngressReconciler) Reconcile(ctx context.Context, cr v1beta1.Grafana, status v1beta1.GrafanaStatus, vars v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {`
`36`		`- logger := log.FromContext(ctx)`
	`36`	`+ logger := log.FromContext(ctx).WithName("IngressReconciler")`
`37`	`37`
`38`	`38`	`if r.isOpenShift {`
`39`	`39`	`logger.Info("reconciling route", "platform", "openshift")`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ func NewPluginsReconciler(client client.Client) reconcilers.OperatorGrafanaRecon`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`func (r PluginsReconciler) Reconcile(ctx context.Context, cr v1beta1.Grafana, status v1beta1.GrafanaStatus, vars v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {`
`27`		`- logger := log.FromContext(ctx)`
	`27`	`+ logger := log.FromContext(ctx).WithName("PluginsReconciler")`
`28`	`28`
`29`	`29`	`plugins := model.GetPluginsConfigMap(cr, scheme)`
`30`	`30`	`selector := client.ObjectKey{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ func NewPvcReconciler(client client.Client) reconcilers.OperatorGrafanaReconcile`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`func (r PvcReconciler) Reconcile(ctx context.Context, cr v1beta1.Grafana, status v1beta1.GrafanaStatus, vars v1beta1.OperatorReconcileVars, scheme *runtime.Scheme) (v1beta1.OperatorStageStatus, error) {`
`26`		`- logger := log.FromContext(ctx)`
	`26`	`+ logger := log.FromContext(ctx).WithName("PvcReconciler")`
`27`	`27`
`28`	`28`	`if cr.Spec.PersistentVolumeClaim == nil {`
`29`	`29`	`logger.Info("skip creating persistent volume claim")`