Additional comments on ID methods

weaveworks-experiments · May 18, 2021 · 7b3b275 · 7b3b275
1 parent 4c3e012
commit 7b3b275
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/controllers/events/object.go b/controllers/events/object.go
@@ -95,6 +95,7 @@ func (r *EventWatcher) createTraceFromTopLevelObject(ctx context.Context, obj ru
 	return spanData, nil
 }
 
+// create a spanID that will be consistent for a particular object
 func objectToSpanID(m v1.Object) trace.SpanID {
 	f := fnv.New64a()
 	_, _ = f.Write([]byte(m.GetUID()))
@@ -104,6 +105,7 @@ func objectToSpanID(m v1.Object) trace.SpanID {
 	return h
 }
 
+// we include the generation, so changes to the spec will start a new trace.
 func objectToTraceID(m v1.Object) trace.TraceID {
 	f := fnv.New128a()
 	_, _ = f.Write([]byte(m.GetUID()))