From 4b35c88740c93689dd7270079f962a79cc77d27f Mon Sep 17 00:00:00 2001
From: ldelossa <ldelossa@redhat.com>
Date: Fri, 21 Aug 2020 13:59:07 -0400
Subject: [PATCH] notifier: log better

commit adds better logging to the notifier's processors and delivery

Signed-off-by: ldelossa <ldelossa@redhat.com>
---
 notifier/delivery.go  | 16 ++++++++++++----
 notifier/processor.go |  9 +++++----
 2 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/notifier/delivery.go b/notifier/delivery.go
index 603f97807e..98be245a2d 100644
--- a/notifier/delivery.go
+++ b/notifier/delivery.go
@@ -9,7 +9,6 @@ import (
 	clairerror "github.com/quay/clair/v4/clair-error"
 	"github.com/quay/claircore/pkg/distlock"
 	"github.com/rs/zerolog"
-	"github.com/rs/zerolog/log"
 )
 
 // Delivery handles the business logic of delivering
@@ -79,7 +78,7 @@ func (d *Delivery) RunDelivery(ctx context.Context) error {
 	log := zerolog.Ctx(ctx).With().
 		Str("deliverer", d.Deliverer.Name()).
 		Uint8("id", d.id).
-		Str("component", "notifier/delivery/Delivery.onTick").Logger()
+		Str("component", "notifier/delivery/Delivery.RunDelivery").Logger()
 
 	toDeliver := []uuid.UUID{}
 	// get created
@@ -105,7 +104,7 @@ func (d *Delivery) RunDelivery(ctx context.Context) error {
 			return err
 		}
 		if !ok {
-			log.Debug().Msg("another process is deliverying this notification")
+			log.Debug().Str("notification_id", nID.String()).Msg("another process is deliverying this notification")
 			// another process is working on this notification
 			continue
 		}
@@ -124,6 +123,11 @@ func (d *Delivery) RunDelivery(ctx context.Context) error {
 //
 // do's actions should be performed under a distributed lock.
 func (d *Delivery) do(ctx context.Context, nID uuid.UUID) error {
+	log := zerolog.Ctx(ctx).With().
+		Str("deliverer", d.Deliverer.Name()).
+		Uint8("id", d.id).
+		Str("component", "notifier/delivery/Delivery.do").Logger()
+
 	// if we have a direct deliverer provide the notifications to it.
 	if dd, ok := d.Deliverer.(DirectDeliverer); ok {
 		log.Debug().Msg("providing direct deliverer notifications")
@@ -144,6 +148,7 @@ func (d *Delivery) do(ctx context.Context, nID uuid.UUID) error {
 		if errors.As(err, &dErr) {
 			// OK for this to fail, notification will stay in Created status.
 			// store is failing, lets back off it tho until next tick.
+			log.Info().Str("notifcation_id", nID.String()).Msg("failed to deliver notifications")
 			err := d.store.SetDeliveryFailed(ctx, nID)
 			if err != nil {
 				return err
@@ -163,7 +168,10 @@ func (d *Delivery) do(ctx context.Context, nID uuid.UUID) error {
 	// we can delete notification id
 	if _, ok := d.Deliverer.(DirectDeliverer); ok {
 		err := d.store.SetDeleted(ctx, nID)
-		return err
+		if err != nil {
+			return err
+		}
 	}
+	log.Info().Str("notifcation_id", nID.String()).Msg("successfully delivered notifications")
 	return nil
 }
diff --git a/notifier/processor.go b/notifier/processor.go
index dda2974920..422a79420d 100644
--- a/notifier/processor.go
+++ b/notifier/processor.go
@@ -3,6 +3,7 @@ package notifier
 import (
 	"context"
 	"errors"
+	"fmt"
 
 	"github.com/google/uuid"
 	clairerror "github.com/quay/clair/v4/clair-error"
@@ -112,16 +113,16 @@ func (p *Processor) create(ctx context.Context, e Event, prev uuid.UUID) error {
 	log.Debug().Str("prev", prev.String()).Str("cur", uoid).Msg("retrieving diff")
 	diff, err := p.matcher.UpdateDiff(ctx, prev, e.uo.Ref)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to get update diff: %v", err)
 	}
 	log.Debug().Int("removed", len(diff.Removed)).Int("added", len(diff.Added)).Msg("diff results")
 	added, err := p.indexer.AffectedManifests(ctx, diff.Added)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to get added affected manifests: %v", err)
 	}
 	removed, err := p.indexer.AffectedManifests(ctx, diff.Removed)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to get removed affected manifests: %v", err)
 	}
 	log.Debug().Int("added", len(added.VulnerableManifests)).Int("removed", len(removed.VulnerableManifests)).Msg("affected manifest counts")
 
@@ -167,7 +168,7 @@ func (p *Processor) create(ctx context.Context, e Event, prev uuid.UUID) error {
 	}
 	err = p.store.PutNotifications(ctx, opts)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to store notifications: %v", err)
 	}
 	return nil
 }