diff --git a/module/apmgoredisv9/doc.go b/module/apmgoredisv9/doc.go new file mode 100644 index 000000000..b97eb6949 --- /dev/null +++ b/module/apmgoredisv9/doc.go @@ -0,0 +1,19 @@ +// Licensed to Elasticsearch B.V. under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. Elasticsearch B.V. licenses this file to you under +// the Apache License, Version 2.0 (the "License"); you may +// not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +// Package apmgoredisv9 provides helpers for tracing github.com/redis/go-redis/v9 client operations as spans. +package apmgoredisv9 // import "go.elastic.co/apm/module/apmgoredisv9/v2" diff --git a/module/apmgoredisv9/go.mod b/module/apmgoredisv9/go.mod new file mode 100644 index 000000000..5d9c55dfd --- /dev/null +++ b/module/apmgoredisv9/go.mod @@ -0,0 +1,27 @@ +module go.elastic.co/apm/module/apmgoredisv9/v2 + +go 1.19 + +require ( + github.com/redis/go-redis/v9 v9.0.5 + github.com/stretchr/testify v1.8.4 + go.elastic.co/apm/v2 v2.4.3 +) + +require ( + github.com/armon/go-radix v1.0.0 // indirect + github.com/cespare/xxhash/v2 v2.2.0 // indirect + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect + github.com/elastic/go-sysinfo v1.7.1 // indirect + github.com/elastic/go-windows v1.0.0 // indirect + github.com/google/go-cmp v0.5.4 // indirect + github.com/joeshaw/multierror v0.0.0-20140124173710-69b34d4ec901 // indirect + github.com/pkg/errors v0.9.1 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/prometheus/procfs v0.0.0-20190425082905-87a4384529e0 // indirect + go.elastic.co/fastjson v1.1.0 // indirect + golang.org/x/sys v0.8.0 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect + howett.net/plist v0.0.0-20181124034731-591f970eefbb // indirect +) diff --git a/module/apmgoredisv9/go.sum b/module/apmgoredisv9/go.sum new file mode 100644 index 000000000..39006be8a --- /dev/null +++ b/module/apmgoredisv9/go.sum @@ -0,0 +1,73 @@ +github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI= +github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= +github.com/bsm/ginkgo/v2 v2.7.0 h1:ItPMPH90RbmZJt5GtkcNvIRuGEdwlBItdNVoyzaNQao= +github.com/bsm/gomega v1.26.0 h1:LhQm+AFcgV2M0WyKroMASzAzCAJVpAxQXv4SaI9a69Y= +github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44= +github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78= +github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc= +github.com/elastic/go-sysinfo v1.7.1 h1:Wx4DSARcKLllpKT2TnFVdSUJOsybqMYCNQZq1/wO+s0= +github.com/elastic/go-sysinfo v1.7.1/go.mod h1:i1ZYdU10oLNfRzq4vq62BEwD2fH8KaWh6eh0ikPT9F0= +github.com/elastic/go-windows v1.0.0 h1:qLURgZFkkrYyTTkvYpsZIgf83AUsdIHfvlJaqaZ7aSY= +github.com/elastic/go-windows v1.0.0/go.mod h1:TsU0Nrp7/y3+VwE82FoZF8gC/XFg/Elz6CcloAxnPgU= +github.com/google/go-cmp v0.5.4 h1:L8R9j+yAqZuZjsqh/z+F1NCffTKKLShY6zXTItVIZ8M= +github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= +github.com/joeshaw/multierror v0.0.0-20140124173710-69b34d4ec901 h1:rp+c0RAYOWj8l6qbCUTSiRLG/iKnW3K3/QfPPuSsBt4= +github.com/joeshaw/multierror v0.0.0-20140124173710-69b34d4ec901/go.mod h1:Z86h9688Y0wesXCyonoVr47MasHilkuLMqGhRZ4Hpak= +github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/prometheus/procfs v0.0.0-20190425082905-87a4384529e0 h1:c8R11WC8m7KNMkTv/0+Be8vvwo4I3/Ut9AC2FW8fX3U= +github.com/prometheus/procfs v0.0.0-20190425082905-87a4384529e0/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= +github.com/redis/go-redis/v9 v9.0.5 h1:CuQcn5HIEeK7BgElubPP8CGtE0KakrnbBSTLjathl5o= +github.com/redis/go-redis/v9 v9.0.5/go.mod h1:WqMKv5vnQbRuZstUwxQI195wHy+t4PuXDOjzMvcuQHk= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +go.elastic.co/apm/v2 v2.4.3 h1:k6mj63O7IIyqqn3S52C2vBXvaSK9M5FHp0aZHpPH/as= +go.elastic.co/apm/v2 v2.4.3/go.mod h1:+CiBUdrrAGnGCL9TNx7tQz3BrfYV23L8Ljvotoc87so= +go.elastic.co/fastjson v1.1.0 h1:3MrGBWWVIxe/xvsbpghtkFoPciPhOCmjsR/HfwEeQR4= +go.elastic.co/fastjson v1.1.0/go.mod h1:boNGISWMjQsUPy/t6yqt2/1Wx4YNPSe+mZjlyw9vKKI= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191025021431-6c3a3bfe00ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20200509030707-2212a7e161a5/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 h1:H2TDz8ibqkAF6YGhCdN3jS9O0/s90v0rJh3X/OLHEUk= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +howett.net/plist v0.0.0-20181124034731-591f970eefbb h1:jhnBjNi9UFpfpl8YZhA9CrOqpnJdvzuiHsl/dnxl11M= +howett.net/plist v0.0.0-20181124034731-591f970eefbb/go.mod h1:vMygbs4qMhSZSc4lCUl2OEE+rDiIIJAIdR4m7MiMcm0= diff --git a/module/apmgoredisv9/hook.go b/module/apmgoredisv9/hook.go new file mode 100644 index 000000000..bbb098adf --- /dev/null +++ b/module/apmgoredisv9/hook.go @@ -0,0 +1,74 @@ +// Licensed to Elasticsearch B.V. under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. Elasticsearch B.V. licenses this file to you under +// the Apache License, Version 2.0 (the "License"); you may +// not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +package apmgoredisv9 // import "go.elastic.co/apm/module/apmgoredisv9/v2" + +import ( + "bytes" + "context" + "strings" + + "github.com/redis/go-redis/v9" + "go.elastic.co/apm/v2" +) + +// hook is an implementation of redis.Hook that reports cmds as spans to Elastic APM. +type hook struct{} + +// NewHook returns a redis.Hook that reports cmds as spans to Elastic APM. +func NewHook() redis.Hook { + return &hook{} +} + +func (r *hook) DialHook(next redis.DialHook) redis.DialHook { + return next +} + +func (r *hook) ProcessHook(next redis.ProcessHook) redis.ProcessHook { + return func(ctx context.Context, cmd redis.Cmder) error { + span, _ := apm.StartSpanOptions(ctx, getCmdName(cmd), "db.redis", apm.SpanOptions{ + ExitSpan: true, + }) + defer span.End() + return next(ctx, cmd) + } +} + +func (r *hook) ProcessPipelineHook(next redis.ProcessPipelineHook) redis.ProcessPipelineHook { + return func(ctx context.Context, cmds []redis.Cmder) error { + var cmdNameBuf bytes.Buffer + for i, cmd := range cmds { + if i != 0 { + cmdNameBuf.WriteString(", ") + } + cmdNameBuf.WriteString(getCmdName(cmd)) + } + span, _ := apm.StartSpanOptions(ctx, cmdNameBuf.String(), "db.redis", apm.SpanOptions{ + ExitSpan: true, + }) + defer span.End() + return next(ctx, cmds) + } +} + +func getCmdName(cmd redis.Cmder) string { + cmdName := strings.ToUpper(cmd.Name()) + if cmdName == "" { + cmdName = "(empty command)" + } + return cmdName +} diff --git a/module/apmgoredisv9/hook_test.go b/module/apmgoredisv9/hook_test.go new file mode 100644 index 000000000..31d68a594 --- /dev/null +++ b/module/apmgoredisv9/hook_test.go @@ -0,0 +1,159 @@ +// Licensed to Elasticsearch B.V. under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. Elasticsearch B.V. licenses this file to you under +// the Apache License, Version 2.0 (the "License"); you may +// not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +package apmgoredisv9_test + +import ( + "context" + "fmt" + "testing" + + "github.com/redis/go-redis/v9" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + apmgoredis "go.elastic.co/apm/module/apmgoredisv9/v2" + "go.elastic.co/apm/v2/apmtest" +) + +const ( + clientTypeBase = iota + clientTypeCluster + clientTypeRing +) + +var ( + unitTestCases = []struct { + clientType int + client redis.UniversalClient + }{ + { + clientTypeBase, + redisHookedClient(), + }, + { + clientTypeCluster, + redisHookedClusterClient(), + }, + { + clientTypeRing, + redisHookedRing(), + }, + } +) + +func TestHook(t *testing.T) { + for i, testCase := range unitTestCases { + t.Run(fmt.Sprintf("test %d", i), func(t *testing.T) { + client := testCase.client + + _, spans, _ := apmtest.WithTransaction(func(ctx context.Context) { + client.Ping(ctx) + client.Get(ctx, "key") + client.Do(ctx, "") + }) + require.Len(t, spans, 3) + assert.Equal(t, "PING", spans[0].Name) + assert.Equal(t, "db", spans[0].Type) + assert.Equal(t, "redis", spans[0].Subtype) + assert.Equal(t, "redis", spans[0].Context.Destination.Service.Resource) + assert.Equal(t, "GET", spans[1].Name) + assert.Equal(t, "db", spans[1].Type) + assert.Equal(t, "redis", spans[1].Subtype) + assert.Equal(t, "redis", spans[1].Context.Destination.Service.Resource) + assert.Equal(t, "(empty command)", spans[2].Name) + assert.Equal(t, "db", spans[2].Type) + assert.Equal(t, "redis", spans[2].Subtype) + assert.Equal(t, "redis", spans[2].Context.Destination.Service.Resource) + }) + } +} + +func TestHookPipeline(t *testing.T) { + for i, testCase := range unitTestCases { + t.Run(fmt.Sprintf("test %d", i), func(t *testing.T) { + client := testCase.client + + _, spans, _ := apmtest.WithTransaction(func(ctx context.Context) { + pipe := client.Pipeline() + pipe.Get(ctx, "key") + pipe.Set(ctx, "key", "value", 0) + pipe.Get(ctx, "key") + pipe.Do(ctx, "") + _, _ = pipe.Exec(ctx) + }) + + require.Len(t, spans, 1) + assert.Equal(t, "GET, SET, GET, (empty command)", spans[0].Name) + assert.Equal(t, "db", spans[0].Type) + assert.Equal(t, "redis", spans[0].Subtype) + assert.Equal(t, "redis", spans[0].Context.Destination.Service.Resource) + }) + } +} + +func TestHookTxPipeline(t *testing.T) { + for i, testCase := range unitTestCases { + t.Run(fmt.Sprintf("test %d", i), func(t *testing.T) { + client := testCase.client + + _, spans, _ := apmtest.WithTransaction(func(ctx context.Context) { + pipe := client.TxPipeline() + pipe.Get(ctx, "key") + pipe.Set(ctx, "key", "value", 0) + pipe.Get(ctx, "key") + pipe.Do(ctx, "") + _, _ = pipe.Exec(ctx) + }) + + require.Len(t, spans, 1) + assert.Equal(t, "MULTI, GET, SET, GET, (empty command), EXEC", spans[0].Name) + assert.Equal(t, "db", spans[0].Type) + assert.Equal(t, "redis", spans[0].Subtype) + assert.Equal(t, "redis", spans[0].Context.Destination.Service.Resource) + }) + } +} + +func redisEmptyClient() *redis.Client { + return redis.NewClient(&redis.Options{}) +} + +func redisHookedClient() *redis.Client { + client := redisEmptyClient() + client.AddHook(apmgoredis.NewHook()) + return client +} + +func redisEmptyClusterClient() *redis.ClusterClient { + return redis.NewClusterClient(&redis.ClusterOptions{}) +} + +func redisHookedClusterClient() *redis.ClusterClient { + client := redisEmptyClusterClient() + client.AddHook(apmgoredis.NewHook()) + return client +} + +func redisEmptyRing() *redis.Ring { + return redis.NewRing(&redis.RingOptions{}) +} + +func redisHookedRing() *redis.Ring { + client := redisEmptyRing() + client.AddHook(apmgoredis.NewHook()) + return client +}