Update HTTP span names to include method and route (#143)

* http spans should be "method route" * update test traces to match convention * update changelog * Update CHANGELOG.md Co-authored-by: Mike Goldsmith <[email protected]> * Update CHANGELOG.md Co-authored-by: Tyler Yahn <[email protected]> --------- Co-authored-by: Mike Goldsmith <[email protected]> Co-authored-by: Tyler Yahn <[email protected]>
open-telemetry · May 9, 2023 · d7606e8 · d7606e8
1 parent eadc6bc
commit d7606e8
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ OpenTelemetry Go Automatic Instrumentation adheres to [Semantic Versioning](http
 ### Changed
 
 - Only pull docker image if not present for the emojivoto example. ([#149](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/149))
+- Update HTTP span names to include method and route to match semantic conventions. ([#143](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/143))
 
 ## [v0.2.0-alpha] - 2023-05-03
 

diff --git a/pkg/instrumentors/bpf/github.com/gin-gonic/gin/probe.go b/pkg/instrumentors/bpf/github.com/gin-gonic/gin/probe.go
@@ -18,6 +18,7 @@ import (
 	"bytes"
 	"encoding/binary"
 	"errors"
+	"fmt"
 
 	"os"
 
@@ -193,6 +194,7 @@ func (h *Instrumentor) Run(eventsChan chan<- *events.Event) {
 func (h *Instrumentor) convertEvent(e *Event) *events.Event {
 	method := unix.ByteSliceToString(e.Method[:])
 	path := unix.ByteSliceToString(e.Path[:])
+	name := fmt.Sprintf("%s %s", method, path)
 
 	sc := trace.NewSpanContext(trace.SpanContextConfig{
 		TraceID:    e.SpanContext.TraceID,
@@ -202,7 +204,7 @@ func (h *Instrumentor) convertEvent(e *Event) *events.Event {
 
 	return &events.Event{
 		Library:     h.LibraryName(),
-		Name:        path,
+		Name:        name,
 		Kind:        trace.SpanKindServer,
 		StartTime:   int64(e.StartTime),
 		EndTime:     int64(e.EndTime),

diff --git a/pkg/instrumentors/bpf/github.com/gorilla/mux/probe.go b/pkg/instrumentors/bpf/github.com/gorilla/mux/probe.go
@@ -18,6 +18,7 @@ import (
 	"bytes"
 	"encoding/binary"
 	"errors"
+	"fmt"
 	"os"
 
 	"go.opentelemetry.io/auto/pkg/instrumentors/bpffs"
@@ -180,6 +181,7 @@ func (g *Instrumentor) Run(eventsChan chan<- *events.Event) {
 func (g *Instrumentor) convertEvent(e *Event) *events.Event {
 	method := unix.ByteSliceToString(e.Method[:])
 	path := unix.ByteSliceToString(e.Path[:])
+	name := fmt.Sprintf("%s %s", method, path)
 
 	sc := trace.NewSpanContext(trace.SpanContextConfig{
 		TraceID:    e.SpanContext.TraceID,
@@ -189,7 +191,7 @@ func (g *Instrumentor) convertEvent(e *Event) *events.Event {
 
 	return &events.Event{
 		Library:     g.LibraryName(),
-		Name:        path,
+		Name:        name,
 		Kind:        trace.SpanKindServer,
 		StartTime:   int64(e.StartTime),
 		EndTime:     int64(e.EndTime),

diff --git a/pkg/instrumentors/bpf/net/http/server/probe.go b/pkg/instrumentors/bpf/net/http/server/probe.go
@@ -18,6 +18,7 @@ import (
 	"bytes"
 	"encoding/binary"
 	"errors"
+	"fmt"
 	"os"
 
 	"go.opentelemetry.io/auto/pkg/instrumentors/bpffs"
@@ -191,6 +192,7 @@ func (h *Instrumentor) Run(eventsChan chan<- *events.Event) {
 func (h *Instrumentor) convertEvent(e *Event) *events.Event {
 	method := unix.ByteSliceToString(e.Method[:])
 	path := unix.ByteSliceToString(e.Path[:])
+	name := fmt.Sprintf("%s %s", method, path)
 
 	sc := trace.NewSpanContext(trace.SpanContextConfig{
 		TraceID:    e.SpanContext.TraceID,
@@ -200,7 +202,7 @@ func (h *Instrumentor) convertEvent(e *Event) *events.Event {
 
 	return &events.Event{
 		Library:     h.LibraryName(),
-		Name:        path,
+		Name:        name,
 		Kind:        trace.SpanKindServer,
 		StartTime:   int64(e.StartTime),
 		EndTime:     int64(e.EndTime),

diff --git a/test/e2e/gin/traces.json b/test/e2e/gin/traces.json
@@ -45,7 +45,7 @@
                 }
               ],
               "kind": 2,
-              "name": "/hello-gin",
+              "name": "GET /hello-gin",
               "parentSpanId": "",
               "spanId": "xxxxx",
               "status": {},

diff --git a/test/e2e/gorillamux/traces.json b/test/e2e/gorillamux/traces.json
@@ -45,7 +45,7 @@
                 }
               ],
               "kind": 2,
-              "name": "/users/foo",
+              "name": "GET /users/foo",
               "parentSpanId": "",
               "spanId": "xxxxx",
               "status": {},

diff --git a/test/e2e/nethttp/traces.json b/test/e2e/nethttp/traces.json
@@ -45,7 +45,7 @@
                 }
               ],
               "kind": 2,
-              "name": "/hello",
+              "name": "GET /hello",
               "parentSpanId": "",
               "spanId": "xxxxx",
               "status": {},