Add logging for recipient to contacts expansion

The most relevant case where this is interesting is when a schedule expands to
no contacts at the time of a notification.

Author: julianbrost

internal/incident/incident.go

@@ -648,11 +648,20 @@ func (i *Incident) getRecipientsChannel(t time.Time) rule.ContactChannels {
 		}
 
 		if i.IsNotifiable(state.Role) {
-			for _, contact := range r.GetContactsAt(t) {
-				if contactChs[contact] == nil {
-					contactChs[contact] = make(map[int64]bool)
-					contactChs[contact][contact.DefaultChannelID] = true
+			contacts := r.GetContactsAt(t)
+			if len(contacts) > 0 {
+				i.logger.Debugw("Expanded recipient to contacts",
+					zap.Object("recipient", r),
+					zap.Objects("contacts", contacts))
+
+				for _, contact := range contacts {
+					if contactChs[contact] == nil {
+						contactChs[contact] = make(map[int64]bool)
+						contactChs[contact][contact.DefaultChannelID] = true
+					}
 				}
+			} else {
+				i.logger.Warnw("Recipient expanded to no contacts", zap.Object("recipient", r))
 			}
 		}
 	}

internal/recipient/contact.go

@@ -2,6 +2,7 @@ package recipient
 
 import (
 	"database/sql"
+	"go.uber.org/zap/zapcore"
 	"time"
 )
 
@@ -21,6 +22,14 @@ func (c *Contact) GetContactsAt(t time.Time) []*Contact {
 	return []*Contact{c}
 }
 
+// MarshalLogObject implements the zapcore.ObjectMarshaler interface.
+func (c *Contact) MarshalLogObject(encoder zapcore.ObjectEncoder) error {
+	// Use contact_id as key so that the type is explicit if logged as the Recipient interface.
+	encoder.AddInt64("contact_id", c.ID)
+	encoder.AddString("name", c.FullName)
+	return nil
+}
+
 var _ Recipient = (*Contact)(nil)
 
 type Address struct {

internal/recipient/group.go

@@ -1,6 +1,9 @@
 package recipient
 
-import "time"
+import (
+	"go.uber.org/zap/zapcore"
+	"time"
+)
 
 type Group struct {
 	ID        int64      `db:"id"`
@@ -21,4 +24,12 @@ func (g *Group) String() string {
 	return g.Name
 }
 
+// MarshalLogObject implements the zapcore.ObjectMarshaler interface.
+func (g *Group) MarshalLogObject(encoder zapcore.ObjectEncoder) error {
+	// Use contact_id as key so that the type is explicit if logged as the Recipient interface.
+	encoder.AddInt64("group_id", g.ID)
+	encoder.AddString("name", g.Name)
+	return nil
+}
+
 var _ Recipient = (*Group)(nil)

internal/recipient/recipient.go

@@ -10,6 +10,7 @@ import (
 
 type Recipient interface {
 	fmt.Stringer
+	zapcore.ObjectMarshaler
 
 	GetContactsAt(t time.Time) []*Contact
 }

internal/recipient/schedule.go

@@ -23,6 +23,14 @@ func (s *Schedule) RefreshRotations() {
 	s.rotationResolver.update(s.Rotations)
 }
 
+// MarshalLogObject implements the zapcore.ObjectMarshaler interface.
+func (s *Schedule) MarshalLogObject(encoder zapcore.ObjectEncoder) error {
+	// Use schedule_id as key so that the type is explicit if logged as the Recipient interface.
+	encoder.AddInt64("schedule_id", s.ID)
+	encoder.AddString("name", s.Name)
+	return nil
+}
+
 type Rotation struct {
 	ID            int64             `db:"id"`
 	ScheduleID    int64             `db:"schedule_id"`