Chore: Implement OpenTelemtry in Grafana (#42674)

* Separate Tracer interface to TracerService and Tracer

* Fix lint

* Fix:Make it possible to start spans for both opentracing and opentelemetry in ds proxy

* Add span methods, use span interface for rest of tracing

* Fix logs in tracing

* Fix tests that are related to tracing

* Fix resourcepermissions test

* Fix some tests

* Fix more tests

* Add TracingService to wire cli runner

* Remove GlobalTracer from bus

* Renaming test function

* Remove GlobalTracer from TSDB

* Replace GlobalTracer in api

* Adjust tests to the InitializeForTests func

* Remove GlobalTracer from services

* Remove GlobalTracer

* Remove bus.NewTest

* Remove Tracer interface

* Add InitializeForBus

* Simplify tests

* Clean up tests

* Rename TracerService to Tracer

* Update pkg/middleware/request_tracing.go

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

* Initialize tracer before passing it to SQLStore initialization in commands

* Remove tests for opentracing

* Set span attributes correctly, remove unnecessary trace initiliazation form test

* Add tracer instance to newSQLStore

* Fix changes due to rebase

* Add modified tracing middleware test

* Fix opentracing implementation tags

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
This commit is contained in:
idafurjes
2022-01-20 11:10:12 +01:00
committed by GitHub
co-authored by Marcus Efraimsson
parent 5b61273497
commit 30aa24a183
62 changed files with 717 additions and 474 deletions
@@ -8,21 +8,20 @@ import (
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
"github.com/grafana/grafana/pkg/infra/log"
"github.com/opentracing/opentracing-go"
"github.com/opentracing/opentracing-go/ext"
"github.com/grafana/grafana/pkg/infra/tracing"
"github.com/stretchr/testify/require"
jaeger "github.com/uber/jaeger-client-go"
)
func TestTracingMiddleware(t *testing.T) {
setupTracing(t)
tracer, err := tracing.InitializeTracerForTest()
require.NoError(t, err)
t.Run("GET request that returns 200 OK should start and capture span", func(t *testing.T) {
finalRoundTripper := httpclient.RoundTripperFunc(func(req *http.Request) (*http.Response, error) {
return &http.Response{StatusCode: http.StatusOK, Request: req}, nil
})
mw := TracingMiddleware(log.New("test"))
mw := TracingMiddleware(log.New("test"), tracer)
rt := mw.CreateMiddleware(httpclient.Options{
Labels: map[string]string{
"l1": "v1",
@@ -44,24 +43,8 @@ func TestTracingMiddleware(t *testing.T) {
require.NoError(t, res.Body.Close())
}
sp := opentracing.SpanFromContext(res.Request.Context())
_, sp := tracer.Start(ctx, "test")
require.NotNil(t, sp)
jsp, ok := sp.(*jaeger.Span)
require.True(t, ok)
require.Equal(t, "HTTP Outgoing Request", jsp.OperationName())
require.Len(t, jsp.Tags(), 8)
expectedTags := opentracing.Tags{
string(ext.HTTPMethod): http.MethodGet,
string(ext.HTTPStatusCode): uint16(http.StatusOK),
string(ext.HTTPUrl): "http://test.com/query",
"l1": "v1",
"l2": "v2",
jaeger.SamplerParamTagKey: true,
jaeger.SamplerTypeTagKey: jaeger.SamplerTypeConst,
string(ext.SpanKind): ext.SpanKindRPCClientEnum,
}
require.EqualValues(t, expectedTags, jsp.Tags())
require.Contains(t, req.Header, "Uber-Trace-Id")
})
t.Run("GET request that returns 400 Bad Request should start and capture span", func(t *testing.T) {
@@ -69,7 +52,7 @@ func TestTracingMiddleware(t *testing.T) {
return &http.Response{StatusCode: http.StatusBadRequest, Request: req}, nil
})
mw := TracingMiddleware(log.New("test"))
mw := TracingMiddleware(log.New("test"), tracer)
rt := mw.CreateMiddleware(httpclient.Options{
Labels: map[string]string{
"l1": "v1",
@@ -91,25 +74,8 @@ func TestTracingMiddleware(t *testing.T) {
require.NoError(t, res.Body.Close())
}
sp := opentracing.SpanFromContext(res.Request.Context())
_, sp := tracer.Start(res.Request.Context(), "test")
require.NotNil(t, sp)
jsp, ok := sp.(*jaeger.Span)
require.True(t, ok)
require.Equal(t, "HTTP Outgoing Request", jsp.OperationName())
require.Len(t, jsp.Tags(), 9)
expectedTags := opentracing.Tags{
string(ext.Error): true,
string(ext.HTTPMethod): http.MethodGet,
string(ext.HTTPStatusCode): uint16(http.StatusBadRequest),
string(ext.HTTPUrl): "http://test.com/query",
"l1": "v1",
"l2": "v2",
jaeger.SamplerParamTagKey: true,
jaeger.SamplerTypeTagKey: jaeger.SamplerTypeConst,
string(ext.SpanKind): ext.SpanKindRPCClientEnum,
}
require.EqualValues(t, expectedTags, jsp.Tags())
require.Contains(t, req.Header, "Uber-Trace-Id")
})
t.Run("POST request that returns 200 OK should start and capture span", func(t *testing.T) {
@@ -117,7 +83,7 @@ func TestTracingMiddleware(t *testing.T) {
return &http.Response{StatusCode: http.StatusOK, Request: req, ContentLength: 10}, nil
})
mw := TracingMiddleware(log.New("test"))
mw := TracingMiddleware(log.New("test"), tracer)
rt := mw.CreateMiddleware(httpclient.Options{
Labels: map[string]string{
"l1": "v1",
@@ -139,35 +105,7 @@ func TestTracingMiddleware(t *testing.T) {
require.NoError(t, res.Body.Close())
}
sp := opentracing.SpanFromContext(res.Request.Context())
_, sp := tracer.Start(res.Request.Context(), "test")
require.NotNil(t, sp)
jsp, ok := sp.(*jaeger.Span)
require.True(t, ok)
require.Equal(t, "HTTP Outgoing Request", jsp.OperationName())
require.Len(t, jsp.Tags(), 9)
expectedTags := opentracing.Tags{
httpContentLengthTagKey: int64(10),
string(ext.HTTPMethod): http.MethodPost,
string(ext.HTTPStatusCode): uint16(http.StatusOK),
string(ext.HTTPUrl): "http://test.com/query",
"l1": "v1",
"l2": "v2",
jaeger.SamplerParamTagKey: true,
jaeger.SamplerTypeTagKey: jaeger.SamplerTypeConst,
string(ext.SpanKind): ext.SpanKindRPCClientEnum,
}
require.EqualValues(t, expectedTags, jsp.Tags())
require.Contains(t, req.Header, "Uber-Trace-Id")
})
}
func setupTracing(t *testing.T) {
t.Helper()
tracer, closer := jaeger.NewTracer("test", jaeger.NewConstSampler(true), jaeger.NewNullReporter())
opentracing.SetGlobalTracer(tracer)
t.Cleanup(func() {
require.NoError(t, closer.Close())
opentracing.SetGlobalTracer(opentracing.NoopTracer{})
})
}