add automatic span timing

Author: dmelikyan

README.md

@@ -119,6 +119,13 @@ span := agent.Profile();
 defer span.Stop();
 ```
 
+```go
+// This method is similar to the Profile() method. It additionally
+// allows to specify a span name to group span timing measurements.
+span := agent.ProfileWithName(name);
+defer span.Stop();
+```
+
 ```go
 // A helper function to profile HTTP handler execution by wrapping 
 // http.Handle method parameters.

agent.go

@@ -156,7 +156,13 @@ func (a *Agent) Configure(agentKey string, appName string) {
 // overhead constraints. The method returns Span object, on
 // which the Stop() method should be called.
 func (a *Agent) Profile() *Span {
-	s := newSpan(a)
+	return a.ProfileWithName("Default")
+}
+
+// This method is similar to the Profile() method. It additionally
+// allows to specify a span name to group span timing measurements.
+func (a *Agent) ProfileWithName(name string) *Span {
+	s := newSpan(a, name)
 	s.start()
 
 	return s
@@ -166,13 +172,12 @@ func (a *Agent) Profile() *Span {
 // by wrapping http.HandleFunc method parameters.
 func (a *Agent) ProfileHandlerFunc(pattern string, handlerFunc func(http.ResponseWriter, *http.Request)) (string, func(http.ResponseWriter, *http.Request)) {
 	return pattern, func(w http.ResponseWriter, r *http.Request) {
-		span := newSpan(a)
-		span.workload = pattern
+		span := newSpan(a, fmt.Sprintf("Handler %s", pattern))
 		span.start()
 		defer span.Stop()
 
 		if span.active {
-			WithPprofLabel("workload", pattern, r, func() {
+			WithPprofLabel("workload", span.name, r, func() {
 				handlerFunc(w, r)
 			})
 		} else {
@@ -185,13 +190,12 @@ func (a *Agent) ProfileHandlerFunc(pattern string, handlerFunc func(http.Respons
 // by wrapping http.Handle method parameters.
 func (a *Agent) ProfileHandler(pattern string, handler http.Handler) (string, http.Handler) {
 	return pattern, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		span := newSpan(a)
-		span.workload = pattern
+		span := newSpan(a, fmt.Sprintf("Handler %s", pattern))
 		span.start()
 		defer span.Stop()
 
 		if span.active {
-			WithPprofLabel("workload", pattern, r, func() {
+			WithPprofLabel("workload", span.name, r, func() {
 				handler.ServeHTTP(w, r)
 			})
 		} else {

agent_test.go

@@ -123,19 +123,22 @@ func waitForServer(url string) {
 	}
 }
 
-func BenchmarkMeasureSegment(b *testing.B) {
+func BenchmarkProfile(b *testing.B) {
 	agent := NewAgent()
 	agent.Start(Options{
 		AgentKey: "key1",
 		AppName:  "app1",
 	})
+	agent.internalAgent.Enable()
+
+	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		s := agent.MeasureSegment("seg1")
+		s := agent.Profile()
 		s.Stop()
 	}
 
-	// go test -v -run=^$ -bench=BenchmarkMeasureSegment -cpuprofile=cpu.out
+	// go test -v -run=^$ -bench=BenchmarkProfile -cpuprofile=cpu.out
 	// go tool pprof internal.test cpu.out
 }
 
@@ -145,9 +148,12 @@ func BenchmarkRecordError(b *testing.B) {
 		AgentKey: "key1",
 		AppName:  "app1",
 	})
+	agent.internalAgent.Enable()
 
 	err := errors.New("error1")
 
+	b.ResetTimer()
+
 	for i := 0; i < b.N; i++ {
 		agent.RecordError(err)
 	}

examples/app.go

@@ -201,7 +201,7 @@ func simulateProgrammaticProfiling() {
 func simulateWorkloadProfiling() {
 	// start HTTP server
 	go func() {
-		http.HandleFunc(agent.ProfileHandlerFunc("/some-handler-workload", func(w http.ResponseWriter, r *http.Request) {
+		http.HandleFunc(agent.ProfileHandlerFunc("/some-handler", func(w http.ResponseWriter, r *http.Request) {
 			for i := 0; i < 500000; i++ {
 				str := "str" + strconv.Itoa(i)
 				str = str + "a"
@@ -220,58 +220,7 @@ func simulateWorkloadProfiling() {
 	for {
 		select {
 		case <-requestTicker.C:
-			res, err := http.Get("http://localhost:5003/some-handler-workload")
-			if err == nil {
-				res.Body.Close()
-			}
-		}
-	}
-}
-
-func simulateSegments() {
-	for {
-		done1 := make(chan bool)
-
-		go func() {
-			segment := agent.MeasureSegment("Segment1")
-			defer segment.Stop()
-
-			time.Sleep(time.Duration(100+rand.Intn(20)) * time.Millisecond)
-
-			done1 <- true
-		}()
-
-		<-done1
-	}
-}
-
-func simulateHandlerSegments() {
-	// start HTTP server
-	go func() {
-		http.HandleFunc(agent.MeasureHandlerFunc("/some-handler-func", func(w http.ResponseWriter, r *http.Request) {
-			time.Sleep(time.Duration(200+rand.Intn(50)) * time.Millisecond)
-
-			fmt.Fprintf(w, "OK")
-		}))
-
-		http.Handle(agent.MeasureHandler("/some-handler", http.StripPrefix("/some-handler", http.FileServer(http.Dir("/tmp")))))
-
-		if err := http.ListenAndServe(":5001", nil); err != nil {
-			log.Fatal(err)
-			return
-		}
-	}()
-
-	requestTicker := time.NewTicker(1000 * time.Millisecond)
-	for {
-		select {
-		case <-requestTicker.C:
-			res, err := http.Get("http://localhost:5001/some-handler-func")
-			if err == nil {
-				res.Body.Close()
-			}
-
-			res, err = http.Get("http://localhost:5001/some-handler")
+			res, err := http.Get("http://localhost:5003/some-handler")
 			if err == nil {
 				res.Body.Close()
 			}
@@ -346,8 +295,6 @@ func main() {
 	go simulateLockWait()
 	go simulateProgrammaticProfiling()
 	go simulateWorkloadProfiling()
-	go simulateSegments()
-	go simulateHandlerSegments()
 	go simulateErrors()
 
 	select {}

internal/agent.go

@@ -16,7 +16,7 @@ import (
 	"time"
 )
 
-const AgentVersion = "2.3.5"
+const AgentVersion = "2.3.6"
 const SAASDashboardAddress = "https://agent-api.stackimpact.com"
 
 var agentPath = filepath.Join("github.com", "stackimpact", "stackimpact-go")
@@ -41,7 +41,7 @@ type Agent struct {
 	cpuReporter        *ProfileReporter
 	allocationReporter *ProfileReporter
 	blockReporter      *ProfileReporter
-	segmentReporter    *SegmentReporter
+	spanReporter       *SpanReporter
 	errorReporter      *ErrorReporter
 
 	profilerActive *Flag
@@ -78,7 +78,7 @@ func NewAgent() *Agent {
 		cpuReporter:        nil,
 		allocationReporter: nil,
 		blockReporter:      nil,
-		segmentReporter:    nil,
+		spanReporter:       nil,
 		errorReporter:      nil,
 
 		profilerActive: &Flag{},
@@ -136,7 +136,7 @@ func NewAgent() *Agent {
 	}
 	a.blockReporter = newProfileReporter(a, blockProfiler, blockProfilerConfig)
 
-	a.segmentReporter = newSegmentReporter(a)
+	a.spanReporter = newSpanReporter(a)
 	a.errorReporter = newErrorReporter(a)
 
 	return a
@@ -174,7 +174,7 @@ func (a *Agent) Enable() {
 		a.cpuReporter.start()
 		a.allocationReporter.start()
 		a.blockReporter.start()
-		a.segmentReporter.start()
+		a.spanReporter.start()
 		a.errorReporter.start()
 		a.processReporter.start()
 		a.config.setAgentEnabled(true)
@@ -187,7 +187,7 @@ func (a *Agent) Disable() {
 		a.cpuReporter.stop()
 		a.allocationReporter.stop()
 		a.blockReporter.stop()
-		a.segmentReporter.stop()
+		a.spanReporter.stop()
 		a.errorReporter.stop()
 		a.processReporter.stop()
 	}
@@ -210,12 +210,12 @@ func (a *Agent) StopProfiling() {
 	a.blockReporter.stopProfiling()
 }
 
-func (a *Agent) RecordSegment(name string, duration float64) {
+func (a *Agent) RecordSpan(name string, duration float64) {
 	if !agentStarted {
 		return
 	}
 
-	a.segmentReporter.recordSegment(name, duration)
+	a.spanReporter.recordSpan(name, duration)
 }
 
 func (a *Agent) RecordError(group string, msg interface{}, skipFrames int) {

internal/config_loader.go

@@ -88,12 +88,12 @@ func (cl *ConfigLoader) load() {
 		}
 
 		if cl.agent.config.isAgentEnabled() {
-			cl.agent.segmentReporter.start()
+			cl.agent.spanReporter.start()
 			cl.agent.errorReporter.start()
 			cl.agent.processReporter.start()
 			cl.agent.log("Agent enabled")
 		} else {
-			cl.agent.segmentReporter.stop()
+			cl.agent.spanReporter.stop()
 			cl.agent.errorReporter.stop()
 			cl.agent.processReporter.stop()
 			cl.agent.log("Agent disabled")

internal/error_reporter.go

@@ -112,7 +112,7 @@ func (er *ErrorReporter) recordError(group string, err error, skip int) {
 		er.recordLock.Lock()
 		errorGraph, exists := er.errorGraphs[group]
 		if !exists {
-			// If segment was not created by other recordError call between locks, create it.
+			// If error was not created by other recordError call between locks, create it.
 			errorGraph = newBreakdownNode(group)
 			er.errorGraphs[group] = errorGraph
 		}

internal/metric.go

@@ -19,13 +19,13 @@ const CategoryCPU string = "cpu"
 const CategoryMemory string = "memory"
 const CategoryGC string = "gc"
 const CategoryRuntime string = "runtime"
+const CategorySpan string = "span"
 const CategoryCPUProfile string = "cpu-profile"
 const CategoryMemoryProfile string = "memory-profile"
 const CategoryBlockProfile string = "block-profile"
 const CategoryLockProfile string = "lock-profile"
 const CategoryCPUTrace string = "cpu-trace"
 const CategoryBlockTrace string = "block-trace"
-const CategorySegmentTrace string = "segment-trace"
 const CategoryErrorProfile string = "error-profile"
 
 const NameCPUTime string = "CPU time"