Warn about time adjustment in spans

Time adjustment is confusing to many people, as you can see in #961. This change adds a warning if we do any time adjustments, so that it's at least clear that adjustments happened. Signed-off-by: Ivan Babrou <[email protected]>
jaegertracing · Feb 2, 2020 · a8cb126 · a8cb126
1 parent 7d339ef
commit a8cb126
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/model/adjuster/clockskew.go b/model/adjuster/clockskew.go
@@ -173,7 +173,13 @@ func (a *clockSkewAdjuster) calculateSkew(child *node, parent *node) time.Durati
 }
 
 func (a *clockSkewAdjuster) adjustTimestamps(n *node, skew clockSkew) {
+	if skew.delta == 0 {
+		return
+	}
+
 	n.span.StartTime = n.span.StartTime.Add(skew.delta)
+	n.span.Warnings = append(n.span.Warnings, fmt.Sprintf("This span's timestamps were adjusted by %v", skew.delta))
+
 	for i := range n.span.Logs {
 		n.span.Logs[i].Timestamp = n.span.Logs[i].Timestamp.Add(skew.delta)
 	}

diff --git a/model/adjuster/clockskew_test.go b/model/adjuster/clockskew_test.go
@@ -175,8 +175,12 @@ func TestClockSkewAdjuster(t *testing.T) {
 				}
 				assert.Equal(t, err, testCase.err)
 			} else {
-				for _, span := range trace.Spans {
-					assert.Len(t, span.Warnings, 0, "no warnings in span %s", span.SpanID)
+				for i, span := range trace.Spans {
+					if testCase.trace[i].adjusted == testCase.trace[i].startTime {
+						assert.Len(t, span.Warnings, 0, "no warnings in span %s", span.SpanID)
+					} else {
+						assert.Len(t, span.Warnings, 1, "warning about adjutment added to span %s", span.SpanID)
+					}
 				}
 			}
 			for _, proto := range testCase.trace {