add spot check concept

vault/diagnose/helpers.go

@@ -10,9 +10,12 @@ import (
 )
 
 const (
- warningEventName = "warning"
- actionKey = "actionKey"
- errorMessageKey = attribute.Key("error.message")
+ warningEventName = "warning"
+ actionKey = "actionKey"
+ spotCheckOkEventName = "spot-check-ok"
+ spotCheckWarnEventName = "spot-check-warn"
+ spotCheckErrorEventName = "spot-check-error"
+ errorMessageKey = attribute.Key("error.message")
 )
 
 var tp *sdktrace.TracerProvider
@@ -61,10 +64,45 @@ func Error(ctx context.Context, err error, options ...trace.EventOption) error {
 // Warn records a warning on the current span
 func Warn(ctx context.Context, msg string) {
  span := trace.SpanFromContext(ctx)
-
  span.AddEvent(warningEventName, trace.WithAttributes(attribute.String("message", msg)))
 }
 
+func SpotOk(ctx context.Context, checkName, message string) {
+ addSpotCheckResult(ctx, spotCheckOkEventName, checkName, message)
+}
+
+func SpotWarn(ctx context.Context, checkName, message string) {
+ addSpotCheckResult(ctx, spotCheckWarnEventName, checkName, message)
+}
+
+func SpotError(ctx context.Context, checkName string, err error) {
+ var message string
+ if err != nil {
+ message = err.Error()
+ }
+ addSpotCheckResult(ctx, spotCheckErrorEventName, checkName, message)
+}
+
+func addSpotCheckResult(ctx context.Context, eventName, checkName, message string) {
+ span := trace.SpanFromContext(ctx)
+ attrs := []trace.EventOption{trace.WithAttributes(attribute.String("name", checkName))}
+ if message != "" {
+ attrs = append(attrs, trace.WithAttributes(attribute.String("message", message)))
+ }
+ span.AddEvent(eventName, attrs...)
+}
+
+func SpotCheck(ctx context.Context, checkName string, f func() error) error {
+ err := f()
+ if err != nil {
+ SpotError(ctx, checkName, err)
+ return err
+ } else {
+ SpotOk(ctx, checkName, "")
+ }
+ return nil
+}
+
 // Test creates a new named span, and executes the provided function within it. If the function returns an error,
 // the span is considered to have failed.
 func Test(ctx context.Context, spanName string, function func(context.Context) error, options ...trace.SpanOption) error {

vault/diagnose/helpers_test.go

@@ -60,10 +60,7 @@ func makeCoffee(ctx context.Context) error {
  return err
  }
 
- err = pickScone(ctx)
- if err != nil {
- Warn(ctx, err.Error())
- }
+ SpotCheck(ctx, "pick-scone", pickScone)
 
  return nil
 }
@@ -81,6 +78,6 @@ func brewCoffee(ctx context.Context) error {
  return nil
 }
 
-func pickScone(ctx context.Context) error {
+func pickScone() error {
  return errors.New("no scones")
 }

vault/diagnose/output.go

@@ -94,13 +94,14 @@ func (t *TelemetryCollector) getOrBuildResult(id trace.SpanID) *Result {
  Message: s.StatusMessage(),
  }
  for _, e := range s.Events() {
- if e.Name == warningEventName {
+ switch e.Name {
+ case warningEventName:
  for _, a := range e.Attributes {
  if a.Key == "message" {
  r.Warnings = append(r.Warnings, a.Value.AsString())
  }
  }
- } else if e.Name == errorStatus {
+ case errorStatus:
  var message string
  var action string
  for _, a := range e.Attributes {
@@ -119,6 +120,63 @@ func (t *TelemetryCollector) getOrBuildResult(id trace.SpanID) *Result {
  })
 
  }
+ case spotCheckOkEventName:
+ var checkName string
+ var message string
+ for _, a := range e.Attributes {
+ switch a.Key {
+ case "name":
+ checkName = a.Value.AsString()
+ case "message":
+ message = a.Value.AsString()
+ }
+ }
+ if checkName != "" {
+ r.Children = append(r.Children,
+ &Result{
+ Name: checkName,
+ Status: okStatus,
+ Message: message,
+ })
+ }
+ case spotCheckWarnEventName:
+ var checkName string
+ var message string
+ for _, a := range e.Attributes {
+ switch a.Key {
+ case "name":
+ checkName = a.Value.AsString()
+ case "message":
+ message = a.Value.AsString()
+ }
+ }
+ if checkName != "" {
+ r.Children = append(r.Children,
+ &Result{
+ Name: checkName,
+ Status: warnStatus,
+ Message: message,
+ })
+ }
+ case spotCheckErrorEventName:
+ var checkName string
+ var message string
+ for _, a := range e.Attributes {
+ switch a.Key {
+ case "name":
+ checkName = a.Value.AsString()
+ case "error":
+ message = a.Value.AsString()
+ }
+ }
+ if checkName != "" {
+ r.Children = append(r.Children,
+ &Result{
+ Name: checkName,
+ Status: errorStatus,
+ Message: message,
+ })
+ }
  }
  }
  switch s.StatusCode() {