Allow setting the health check notes

command/agent/check.go

@@ -15,7 +15,7 @@ import (
 // to notify when a check has a status update. The update
 // should take care to be idempotent.
 type CheckNotifier interface {
-	UpdateCheck(checkID, status string)
+	UpdateCheck(checkID, status, note string)
 }
 
 // CheckMonitor is used to periodically invoke a script to
@@ -90,19 +90,20 @@ func (c *CheckMonitor) check() {
 	// Start the check
 	if err := cmd.Start(); err != nil {
 		c.Logger.Printf("[ERR] agent: failed to invoke '%s': %s", c.Script, err)
-		c.Notify.UpdateCheck(c.CheckID, structs.HealthUnknown)
+		c.Notify.UpdateCheck(c.CheckID, structs.HealthUnknown, err.Error())
 		return
 	}
 
 	// Wait for the check to complete
 	err := cmd.Wait()
+	notes := string(output.Bytes())
 	c.Logger.Printf("[DEBUG] agent: check '%s' script '%s' output: %s",
-		c.CheckID, c.Script, output.Bytes())
+		c.CheckID, c.Script, notes)
 
 	// Check if the check passed
 	if err == nil {
 		c.Logger.Printf("[DEBUG] Check '%v' is passing", c.CheckID)
-		c.Notify.UpdateCheck(c.CheckID, structs.HealthPassing)
+		c.Notify.UpdateCheck(c.CheckID, structs.HealthPassing, notes)
 		return
 	}
 
@@ -113,7 +114,7 @@ func (c *CheckMonitor) check() {
 			code := status.ExitStatus()
 			if code == 1 {
 				c.Logger.Printf("[WARN] Check '%v' is now warning", c.CheckID)
-				c.Notify.UpdateCheck(c.CheckID, structs.HealthWarning)
+				c.Notify.UpdateCheck(c.CheckID, structs.HealthWarning, notes)
 				return
 			}
 		}
@@ -121,7 +122,7 @@ func (c *CheckMonitor) check() {
 
 	// Set the health as critical
 	c.Logger.Printf("[WARN] Check '%v' is now critical", c.CheckID)
-	c.Notify.UpdateCheck(c.CheckID, structs.HealthCritical)
+	c.Notify.UpdateCheck(c.CheckID, structs.HealthCritical, notes)
 }
 
 // CheckTTL is used to apply a TTL to check status,
@@ -169,7 +170,7 @@ func (c *CheckTTL) run() {
 		case <-c.timer.C:
 			c.Logger.Printf("[WARN] Check '%v' missed TTL, is now critical",
 				c.CheckID)
-			c.Notify.UpdateCheck(c.CheckID, structs.HealthCritical)
+			c.Notify.UpdateCheck(c.CheckID, structs.HealthCritical, "TTL expired")
 
 		case <-c.stopCh:
 			return
@@ -179,9 +180,9 @@ func (c *CheckTTL) run() {
 
 // SetStatus is used to update the status of the check,
 // and to renew the TTL. If expired, TTL is restarted.
-func (c *CheckTTL) SetStatus(status string) {
+func (c *CheckTTL) SetStatus(status, note string) {
 	c.Logger.Printf("[DEBUG] Check '%v' status is now %v",
 		c.CheckID, status)
-	c.Notify.UpdateCheck(c.CheckID, status)
+	c.Notify.UpdateCheck(c.CheckID, status, note)
 	c.timer.Reset(c.TTL)
 }

command/agent/check_test.go

@@ -13,7 +13,7 @@ type MockNotify struct {
 	updates map[string]int
 }
 
-func (m *MockNotify) UpdateCheck(id, status string) {
+func (m *MockNotify) UpdateCheck(id, status, note string) {
 	m.state[id] = status
 	old := m.updates[id]
 	m.updates[id] = old + 1

command/agent/local.go

@@ -129,7 +129,7 @@ func (a *Agent) RemoveCheck(checkID string) {
 }
 
 // UpdateCheck is used to update the status of a check
-func (a *Agent) UpdateCheck(checkID, status string) {
+func (a *Agent) UpdateCheck(checkID, status, output string) {
 	a.state.Lock()
 	defer a.state.Unlock()
 
@@ -139,12 +139,13 @@ func (a *Agent) UpdateCheck(checkID, status string) {
 	}
 
 	// Do nothing if update is idempotent
-	if check.Status == status {
+	if check.Status == status && check.Notes == output {
 		return
 	}
 
 	// Update status and mark out of sync
 	check.Status = status
+	check.Notes = output
 	a.state.checkStatus[checkID] = syncStatus{inSync: false}
 	a.state.changeMade()
 }