From c0f2c0543f26972d62e9424b0f96bfb8497cff83 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Mon, 5 Jul 2021 10:20:50 +0800 Subject: [PATCH 01/26] add Driver.driver interface implements --- sql/README.md | 15 ++++ sql/conn.go | 35 ++++++++ sql/driver.go | 23 +++++ sql/driver_test.go | 1 + sql/go.mod | 14 ++++ sql/go.sum | 203 +++++++++++++++++++++++++++++++++++++++++++++ sql/stmt.go | 38 +++++++++ sql/tx.go | 28 +++++++ 8 files changed, 357 insertions(+) create mode 100644 sql/README.md create mode 100644 sql/conn.go create mode 100644 sql/driver.go create mode 100644 sql/driver_test.go create mode 100644 sql/go.mod create mode 100644 sql/go.sum create mode 100644 sql/stmt.go create mode 100644 sql/tx.go diff --git a/sql/README.md b/sql/README.md new file mode 100644 index 0000000..e6d6e26 --- /dev/null +++ b/sql/README.md @@ -0,0 +1,15 @@ +# Go2Sky with database/sql + +## Installation + +```bash +go get -u github.com/SkyAPM/go2sky-plugins/sql +``` + +## Usage + +```go +// TODO + + +``` \ No newline at end of file diff --git a/sql/conn.go b/sql/conn.go new file mode 100644 index 0000000..1b49902 --- /dev/null +++ b/sql/conn.go @@ -0,0 +1,35 @@ +package sql + +import ( + "context" + "database/sql/driver" + + "github.com/SkyAPM/go2sky" +) + +// conn is a tracing wrapper for driver.Conn +type conn struct { + conn driver.Conn + tracer *go2sky.Tracer +} + +func (c *conn) Prepare(query string) (driver.Stmt, error) { + panic("implement me") +} + +func (c *conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) { + panic("implement me") +} + +func (c *conn) Close() error { + panic("implement me") +} + +func (c *conn) Begin() (driver.Tx, error) { + panic("implement me") +} + +func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) { + panic("implement me") +} + diff --git a/sql/driver.go b/sql/driver.go new file mode 100644 index 0000000..a27bb4f --- /dev/null +++ b/sql/driver.go @@ -0,0 +1,23 @@ +package sql + +import ( + "database/sql/driver" + + "github.com/SkyAPM/go2sky" +) + +type Driver struct { + driver driver.Driver + tracer *go2sky.Tracer +} + +func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer) driver.Driver { + return Driver{ + driver: driver, + tracer: tracer, + } +} + +func (d Driver) Open(name string) (driver.Conn, error) { + panic("implement me") +} \ No newline at end of file diff --git a/sql/driver_test.go b/sql/driver_test.go new file mode 100644 index 0000000..e4b317b --- /dev/null +++ b/sql/driver_test.go @@ -0,0 +1 @@ +package sql diff --git a/sql/go.mod b/sql/go.mod new file mode 100644 index 0000000..113f007 --- /dev/null +++ b/sql/go.mod @@ -0,0 +1,14 @@ +module sql + +go 1.16 + +require ( + github.com/SkyAPM/go2sky v1.1.0 + github.com/google/uuid v1.2.0 // indirect + github.com/pkg/errors v0.9.1 // indirect + golang.org/x/net v0.0.0-20210614182718-04defd469f4e // indirect + golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect + google.golang.org/genproto v0.0.0-20210630183607-d20f26d13c79 // indirect + google.golang.org/grpc v1.39.0 // indirect + skywalking.apache.org/repo/goapi v0.0.0-20210628073857-a95ba03d3c7a // indirect +) diff --git a/sql/go.sum b/sql/go.sum new file mode 100644 index 0000000..0320782 --- /dev/null +++ b/sql/go.sum @@ -0,0 +1,203 @@ +cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= +cloud.google.com/go v0.34.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= +github.com/99designs/gqlgen v0.13.0/go.mod h1:NV130r6f4tpRWuAI+zsrSdooO/eWUv+Gyyoi3rEfXIk= +github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= +github.com/SkyAPM/go2sky v1.1.0 h1:XT8aiCvf0qZnQz2gPfb8ROzymoog9yGNbE9wBBLny+o= +github.com/SkyAPM/go2sky v1.1.0/go.mod h1:LzuySkt/TsQL8FMANZu4BX/6Rn0UfGu5KS/r9TwG/dc= +github.com/agnivade/levenshtein v1.0.1/go.mod h1:CURSv5d9Uaml+FovSIICkLbAUZ9S4RqaHDIsdSBg7lM= +github.com/agnivade/levenshtein v1.0.3/go.mod h1:4SFRZbbXWLF4MU1T9Qg0pGgH3Pjs+t6ie5efyrwRJXs= +github.com/andreyvit/diff v0.0.0-20170406064948-c7f18ee00883/go.mod h1:rCTlJbsFo29Kk6CurOXKm700vrz8f0KW0JNfpkRJY/8= +github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY= +github.com/arbovm/levenshtein v0.0.0-20160628152529-48b4e1c0c4d0/go.mod h1:t2tdKJDJF9BV14lnkjHmOQgcvEKgtqs5a1N3LNdJhGE= +github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= +github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= +github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc= +github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk= +github.com/cncf/xds/go v0.0.0-20210312221358-fbca930ec8ed/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= +github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dgryski/trifles v0.0.0-20190318185328-a8d75aae118c/go.mod h1:if7Fbed8SFyPtHLHbg49SI7NAdJiC5WIA09pe59rfAA= +github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= +github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= +github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98= +github.com/envoyproxy/go-control-plane v0.9.9-0.20201210154907-fd9021fe5dad/go.mod h1:cXg6YxExXjJnVBQHBLXeUAgxn2UodCpnH306RInaBQk= +github.com/envoyproxy/go-control-plane v0.9.9-0.20210217033140-668b12f5399d/go.mod h1:cXg6YxExXjJnVBQHBLXeUAgxn2UodCpnH306RInaBQk= +github.com/envoyproxy/go-control-plane v0.9.9-0.20210512163311-63b5d3c536b0/go.mod h1:hliV/p42l8fGbc6Y9bQ70uLwIvmJyVE5k4iMKlh8wCQ= +github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= +github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= +github.com/go-chi/chi v3.3.2+incompatible/go.mod h1:eB3wogJHnLi3x/kFX2A+IbTBlXxmMeXJVKy9tTv1XzQ= +github.com/gogo/protobuf v1.0.0/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= +github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= +github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= +github.com/golang/mock v1.5.0/go.mod h1:CWnOUgYIOo4TcNZ0wHX3YZCqsaM1I1Jvs6v3mP3KVu8= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw= +github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8= +github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA= +github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs= +github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w= +github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0= +github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8= +github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= +github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= +github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= +github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= +github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= +github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= +github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/google/uuid v1.2.0 h1:qJYtXnJRWmpe7m/3XlyhrsLrEURqHRM2kxzoxXqyUDs= +github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/gorilla/context v0.0.0-20160226214623-1ea25387ff6f/go.mod h1:kBGZzfjB9CEq2AlWe17Uuf7NDRt0dE0s8S51q0aT7Yg= +github.com/gorilla/mux v1.6.1/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs= +github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/grpc-ecosystem/grpc-gateway v1.16.0/go.mod h1:BDjrQk3hbvj6Nolgz8mAMFbcEtjT1g+wF4CSlocrBnw= +github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= +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/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/logrusorgru/aurora v0.0.0-20200102142835-e9ef32dff381/go.mod h1:7rIyQOR62GCctdiQpZ/zOJlFyk6y+94wXzv6RNZgaR4= +github.com/matryer/moq v0.0.0-20200106131100-75d0ddfc0007/go.mod h1:9ELz6aaclSIGnZBoaSLZ3NAl1VTufbOrXBPvtcy6WiQ= +github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE= +github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s= +github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= +github.com/mitchellh/mapstructure v0.0.0-20180203102830-a4e142e9c047/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y= +github.com/opentracing/basictracer-go v1.0.0/go.mod h1:QfBfYuafItcjQuMwinw9GhYKwFXS9KnPs5lxoYwgW74= +github.com/opentracing/opentracing-go v1.0.2/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o= +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/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ= +github.com/rs/cors v1.6.0/go.mod h1:gFx+x8UowdsKA9AchylcLynDq+nNFfI8FkUZdN/jGCU= +github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= +github.com/shurcooL/httpfs v0.0.0-20171119174359-809beceb2371/go.mod h1:ZY1cvUeJuFPAdZ/B6v7RHavJWZn2YPVFQ1OSXhCGOkg= +github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= +github.com/shurcooL/vfsgen v0.0.0-20180121065927-ffb13db8def0/go.mod h1:TrYk7fJVaAttu97ZZKrO9UbRa8izdowaMIZcxYMbVaw= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.1/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= +github.com/urfave/cli/v2 v2.1.1/go.mod h1:SE9GqnLQmjVa0iPEY0f1w3ygNIYcIJ0OKPMoW2caLfQ= +github.com/vektah/dataloaden v0.2.1-0.20190515034641-a19b9a6e7c9e/go.mod h1:/HUdMve7rvxZma+2ZELQeNh88+003LL7Pf/CZ089j8U= +github.com/vektah/gqlparser/v2 v2.1.0/go.mod h1:SyUiHgLATUR8BiYURfTirrTcGpcE+4XkV2se04Px1Ms= +github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= +go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqeYNgFYFoEGnI= +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/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= +golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= +golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= +golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/lint v0.0.0-20210508222113-6edffad5e616/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY= +golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg= +golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +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-20200222125558-5a598a2470a0/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= +golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= +golang.org/x/net v0.0.0-20210614182718-04defd469f4e h1:XpT3nA5TvE525Ne3hInMh6+GETgn27Zfm9dxsThnX2Q= +golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= +golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +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-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/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-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.1-0.20181010134911-4d1c5fb19474/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190125232054-d66bd3c5d5a6/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= +golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190515012406-7d7faa4812bd/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20200114235610-7ae403b6b589/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +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-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= +google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= +google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= +google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= +google.golang.org/genproto v0.0.0-20200513103714-09dca8ec2884/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= +google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo= +google.golang.org/genproto v0.0.0-20210630183607-d20f26d13c79 h1:s1jFTXJryg4a1mew7xv03VZD8N9XjxFhk1o4Js4WvPQ= +google.golang.org/genproto v0.0.0-20210630183607-d20f26d13c79/go.mod h1:yiaVoXHpRzHGyxV3o4DktVWY4mSUErTKaeEOq6C3t3U= +google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= +google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg= +google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY= +google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= +google.golang.org/grpc v1.33.1/go.mod h1:fr5YgcSWrqhRRxogOsw7RzIpsmvOZ6IcH4kBYTpR3n0= +google.golang.org/grpc v1.36.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= +google.golang.org/grpc v1.36.1/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= +google.golang.org/grpc v1.38.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM= +google.golang.org/grpc v1.39.0 h1:Klz8I9kdtkIN6EpHHUOMLCYhTn/2WAe5a0s1hcBkdTI= +google.golang.org/grpc v1.39.0/go.mod h1:PImNr+rS9TWYb2O4/emRugxiyHZ5JyHW5F+RPnDzfrE= +google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= +google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= +google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= +google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE= +google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo= +google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c= +google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +google.golang.org/protobuf v1.27.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ= +google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +skywalking.apache.org/repo/goapi v0.0.0-20210401062122-a049ca15c62d/go.mod h1:S9co6uRVlbQU7PnN7RpEqRtLRCF5n0E9TB7RSmqC5kw= +skywalking.apache.org/repo/goapi v0.0.0-20210628073857-a95ba03d3c7a h1:O3nG1yp5zO2TMWx6ZryMZhlQ+LBM7C9iYIHju2A4Yqg= +skywalking.apache.org/repo/goapi v0.0.0-20210628073857-a95ba03d3c7a/go.mod h1:wmVce2yQsna9boVCkJP4oROZVnOCobmwUiOTsDIzWmQ= +sourcegraph.com/sourcegraph/appdash v0.0.0-20180110180208-2cc67fd64755/go.mod h1:hI742Nqp5OhwiqlzhgfbWU4mW4yO10fP+LoT9WOswdU= +sourcegraph.com/sourcegraph/appdash-data v0.0.0-20151005221446-73f23eafcf67/go.mod h1:L5q+DGLGOQFpo1snNEkLOJT2d1YTW66rWNzatr3He1k= diff --git a/sql/stmt.go b/sql/stmt.go new file mode 100644 index 0000000..d2cf9d8 --- /dev/null +++ b/sql/stmt.go @@ -0,0 +1,38 @@ +package sql + +import ( + "context" + "database/sql/driver" + + "github.com/SkyAPM/go2sky" +) + +// stmt is a tracing wrapper for driver.Stmt +type stmt struct { + stmt driver.Stmt + tracer *go2sky.Tracer +} + +func (s stmt) Close() error { + panic("implement me") +} + +func (s stmt) NumInput() int { + panic("implement me") +} + +func (s stmt) Exec(args []driver.Value) (driver.Result, error) { + panic("implement me") +} + +func (s stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error) { + panic("implement me") +} + +func (s stmt) Query(args []driver.Value) (driver.Rows, error) { + panic("implement me") +} + +func (s stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error) { + panic("implement me") +} diff --git a/sql/tx.go b/sql/tx.go new file mode 100644 index 0000000..3ece48e --- /dev/null +++ b/sql/tx.go @@ -0,0 +1,28 @@ +package sql + +import ( + "database/sql/driver" + + "github.com/SkyAPM/go2sky" +) + +// tx is a wrapper for driver.Tx +type tx struct { + tx driver.Tx + tracer *go2sky.Tracer + span go2sky.Span +} + +func (t *tx) Commit() error { + if t.span != nil { + defer t.span.End() + } + return t.tx.Commit() +} + +func (t *tx) Rollback() error { + if t.span != nil { + defer t.span.End() + } + return t.tx.Rollback() +} \ No newline at end of file From fa0706539a91c923fa30d7ee8eee36f2094ef4f3 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Mon, 5 Jul 2021 23:46:44 +0800 Subject: [PATCH 02/26] add Ping function --- sql/conn.go | 43 +++++++++++++++++++++++++++++++++++---- sql/connector.go | 24 ++++++++++++++++++++++ sql/driver.go | 20 ++++++++++++++++--- sql/driver_test.go | 50 ++++++++++++++++++++++++++++++++++++++++++++++ sql/go.mod | 4 ++++ sql/go.sum | 12 +++++++++++ sql/stmt.go | 5 ++++- 7 files changed, 150 insertions(+), 8 deletions(-) create mode 100644 sql/connector.go diff --git a/sql/conn.go b/sql/conn.go index 1b49902..931b3ec 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -3,33 +3,68 @@ package sql import ( "context" "database/sql/driver" + "fmt" "github.com/SkyAPM/go2sky" ) // conn is a tracing wrapper for driver.Conn type conn struct { - conn driver.Conn + conn driver.Conn tracer *go2sky.Tracer + + // dsn defines the destination of sql server, format in host:port + dsn string +} + +func (c *conn) Ping(ctx context.Context) error { + if pinger, ok := c.conn.(driver.Pinger); ok { + s, err := c.tracer.CreateExitSpan(ctx, "go2sky/sql/ping", c.dsn, emptyInjectFunc) + if err != nil { + return err + } + defer s.End() + return pinger.Ping(ctx) + } + return fmt.Errorf("driver not implements driver.Pinger interface") } func (c *conn) Prepare(query string) (driver.Stmt, error) { - panic("implement me") + return c.conn.Prepare(query) } +// PrepareContext implements driver.ConnPrepareContext PrepareContext func (c *conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) { - panic("implement me") + panic("") } +// Close implements driver.Conn Close func (c *conn) Close() error { - panic("implement me") + return c.conn.Close() } +// Begin implements driver.Conn Begin func (c *conn) Begin() (driver.Tx, error) { panic("implement me") } +// BeginTx implements driver.ConnBeginTx BeginTx func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) { panic("implement me") } +func (c *conn) Exec(query string, args []driver.Value) (driver.Result, error) { + panic("implement me") +} + +func (c *conn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) { + panic("implement me") +} + +func (c *conn) Query(query string, args []driver.Value) (driver.Rows, error) { + panic("implement me") +} + +func (c *conn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) { + panic("implement me") +} diff --git a/sql/connector.go b/sql/connector.go new file mode 100644 index 0000000..2ddcbca --- /dev/null +++ b/sql/connector.go @@ -0,0 +1,24 @@ +package sql + +import ( + "context" + "database/sql/driver" + + "github.com/SkyAPM/go2sky" +) + +type connector struct { + connector driver.Connector + tracer *go2sky.Tracer + + // dsn defines the destination of sql server, format in host:port + dsn string +} + +func (c connector) Connect(ctx context.Context) (driver.Conn, error) { + panic("implement me") +} + +func (c connector) Driver() driver.Driver { + panic("implement me") +} diff --git a/sql/driver.go b/sql/driver.go index a27bb4f..8e2754c 100644 --- a/sql/driver.go +++ b/sql/driver.go @@ -12,12 +12,26 @@ type Driver struct { } func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer) driver.Driver { - return Driver{ + return &Driver{ driver: driver, tracer: tracer, } } -func (d Driver) Open(name string) (driver.Conn, error) { +func (d *Driver) Open(name string) (driver.Conn, error) { + // TODO: parse destination + // [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN] + c, err := d.driver.Open(name) + if err != nil { + return nil, err + } + return &conn{conn: c, tracer: d.tracer}, nil +} + +// OpenConnector implements driver.DriverContext OpenConnector +func (d *Driver) OpenConnector(name string) (driver.Connector, error) { panic("implement me") -} \ No newline at end of file +} + +// emptyInjectFunc defines a empty injector for propagation.Injector function +func emptyInjectFunc(key, value string) error { return nil } diff --git a/sql/driver_test.go b/sql/driver_test.go index e4b317b..5445cb6 100644 --- a/sql/driver_test.go +++ b/sql/driver_test.go @@ -1 +1,51 @@ package sql + +import ( + "context" + "database/sql" + "testing" + + "github.com/SkyAPM/go2sky" + "github.com/SkyAPM/go2sky/reporter" + "github.com/go-sql-driver/mysql" + "github.com/stretchr/testify/assert" +) + +func TestDriver(t *testing.T) { + // init driver + mysqlDriver := &mysql.MySQLDriver{} + + // init tracer + re, err := reporter.NewLogReporter() + assert.NoError(t, err) + defer re.Close() + + tracer, err := go2sky.NewTracer("test-driver", go2sky.WithReporter(re)) + assert.NoError(t, err) + + sql.Register("skywalking-sql", NewTracerDriver(mysqlDriver, tracer)) + db, err := sql.Open("skywalking-sql", "user:password@tcp(127.0.0.1:3306)/testdb") + assert.NoError(t, err) + + span, ctx, err := tracer.CreateLocalSpan(context.Background()) + assert.NoError(t, err) + defer span.End() + + _, err = db.ExecContext(ctx, `CREATE TABLE test (id char(255), name VARCHAR(255), age INTEGER)`) + assert.NoError(t, err) + + // test insert + _, err = db.ExecContext(ctx, + `INSERT INTO test (id, name, age, datetime) VALUE ( ?, ?, ?)`, + "0", "foo", 10) + assert.NoError(t, err) + + var name string + // test select + err = db.QueryRowContext(ctx, + `SELECT * FROM test WHERE id = ?`, + "1").Scan(&name) + assert.NoError(t, err) + assert.Equal(t, "foo", name) + +} diff --git a/sql/go.mod b/sql/go.mod index 113f007..92a6ffe 100644 --- a/sql/go.mod +++ b/sql/go.mod @@ -4,11 +4,15 @@ go 1.16 require ( github.com/SkyAPM/go2sky v1.1.0 + github.com/go-sql-driver/mysql v1.6.0 // indirect github.com/google/uuid v1.2.0 // indirect github.com/pkg/errors v0.9.1 // indirect + github.com/stretchr/objx v0.3.0 // indirect + github.com/stretchr/testify v1.7.0 // indirect golang.org/x/net v0.0.0-20210614182718-04defd469f4e // indirect golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect google.golang.org/genproto v0.0.0-20210630183607-d20f26d13c79 // indirect google.golang.org/grpc v1.39.0 // indirect + gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect skywalking.apache.org/repo/goapi v0.0.0-20210628073857-a95ba03d3c7a // indirect ) diff --git a/sql/go.sum b/sql/go.sum index 0320782..f90e810 100644 --- a/sql/go.sum +++ b/sql/go.sum @@ -16,6 +16,7 @@ github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnht github.com/cncf/xds/go v0.0.0-20210312221358-fbca930ec8ed/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= 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/trifles v0.0.0-20190318185328-a8d75aae118c/go.mod h1:if7Fbed8SFyPtHLHbg49SI7NAdJiC5WIA09pe59rfAA= github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= @@ -27,6 +28,8 @@ github.com/envoyproxy/go-control-plane v0.9.9-0.20210512163311-63b5d3c536b0/go.m github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= github.com/go-chi/chi v3.3.2+incompatible/go.mod h1:eB3wogJHnLi3x/kFX2A+IbTBlXxmMeXJVKy9tTv1XzQ= +github.com/go-sql-driver/mysql v1.6.0 h1:BCTh4TKNUYmOmMUcQ3IipzF5prigylS7XXjEkfCHuOE= +github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= github.com/gogo/protobuf v1.0.0/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= @@ -74,6 +77,7 @@ github.com/opentracing/opentracing-go v1.0.2/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFSt 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/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ= @@ -84,9 +88,14 @@ github.com/shurcooL/httpfs v0.0.0-20171119174359-809beceb2371/go.mod h1:ZY1cvUeJ github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/shurcooL/vfsgen v0.0.0-20180121065927-ffb13db8def0/go.mod h1:TrYk7fJVaAttu97ZZKrO9UbRa8izdowaMIZcxYMbVaw= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.3.0 h1:NGXK3lHquSN08v5vWalVI/L8XU9hdzE/G6xsrze47As= +github.com/stretchr/objx v0.3.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE= github.com/stretchr/testify v1.2.1/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= +github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/urfave/cli/v2 v2.1.1/go.mod h1:SE9GqnLQmjVa0iPEY0f1w3ygNIYcIJ0OKPMoW2caLfQ= github.com/vektah/dataloaden v0.2.1-0.20190515034641-a19b9a6e7c9e/go.mod h1:/HUdMve7rvxZma+2ZELQeNh88+003LL7Pf/CZ089j8U= github.com/vektah/gqlparser/v2 v2.1.0/go.mod h1:SyUiHgLATUR8BiYURfTirrTcGpcE+4XkV2se04Px1Ms= @@ -194,6 +203,9 @@ gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= skywalking.apache.org/repo/goapi v0.0.0-20210401062122-a049ca15c62d/go.mod h1:S9co6uRVlbQU7PnN7RpEqRtLRCF5n0E9TB7RSmqC5kw= diff --git a/sql/stmt.go b/sql/stmt.go index d2cf9d8..cbb3426 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -9,8 +9,11 @@ import ( // stmt is a tracing wrapper for driver.Stmt type stmt struct { - stmt driver.Stmt + stmt driver.Stmt tracer *go2sky.Tracer + + // dsn defines the destination of sql server, format in host:port + dsn string } func (s stmt) Close() error { From 6063900ab82fb0cdf68ba9309c58daef7bc3d5de Mon Sep 17 00:00:00 2001 From: Kagaya Date: Tue, 6 Jul 2021 16:13:27 +0800 Subject: [PATCH 03/26] add parseAddr & fallback connector --- sql/conn.go | 6 +++--- sql/connector.go | 53 +++++++++++++++++++++++++++++++++++++++++----- sql/driver.go | 42 ++++++++++++++++++++++++++++-------- sql/driver_test.go | 2 +- sql/stmt.go | 4 ++-- 5 files changed, 87 insertions(+), 20 deletions(-) diff --git a/sql/conn.go b/sql/conn.go index 931b3ec..1f81cdc 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -13,13 +13,13 @@ type conn struct { conn driver.Conn tracer *go2sky.Tracer - // dsn defines the destination of sql server, format in host:port - dsn string + // addr defines the address of sql server, format in host:port + addr string } func (c *conn) Ping(ctx context.Context) error { if pinger, ok := c.conn.(driver.Pinger); ok { - s, err := c.tracer.CreateExitSpan(ctx, "go2sky/sql/ping", c.dsn, emptyInjectFunc) + s, err := c.tracer.CreateExitSpan(ctx, "go2sky/sql/ping", c.addr, emptyInjectFunc) if err != nil { return err } diff --git a/sql/connector.go b/sql/connector.go index 2ddcbca..e0dd8ae 100644 --- a/sql/connector.go +++ b/sql/connector.go @@ -11,14 +11,57 @@ type connector struct { connector driver.Connector tracer *go2sky.Tracer - // dsn defines the destination of sql server, format in host:port - dsn string + // addr defines the address of sql server, format in host:port + addr string } -func (c connector) Connect(ctx context.Context) (driver.Conn, error) { +func (c *connector) Connect(ctx context.Context) (driver.Conn, error) { panic("implement me") } -func (c connector) Driver() driver.Driver { - panic("implement me") +func (c *connector) Driver() driver.Driver { + return c.connector.Driver() +} + +type fallbackConnector struct { + driver driver.Driver + name string +} + +func (fc *fallbackConnector) Connect(ctx context.Context) (driver.Conn, error) { + conn, err := fc.driver.Open(fc.name) + if err != nil { + return nil, err + } + if ctx.Err() != nil { // ctx done closed + conn.Close() + return nil, ctx.Err() + } + return conn, nil +} + +func (fc *fallbackConnector) Driver() driver.Driver { + return fc.driver +} + +// OpenConnector implements driver.DriverContext OpenConnector +func (d *Driver) OpenConnector(name string) (driver.Connector, error) { + if dc, ok := d.driver.(driver.DriverContext); ok { + c, err := dc.OpenConnector(name) + if err != nil { + return nil, err + } + return &connector{ + connector: c, + tracer: d.tracer, + addr: parseAddr(name, d.dbtype), + }, nil + } + + // given driver does not implement driver.DriverContext interface + return &connector{ + connector: nil, + tracer: d.tracer, + addr: parseAddr(name, d.dbtype), + }, nil } diff --git a/sql/driver.go b/sql/driver.go index 8e2754c..c35d52a 100644 --- a/sql/driver.go +++ b/sql/driver.go @@ -2,36 +2,60 @@ package sql import ( "database/sql/driver" + "regexp" "github.com/SkyAPM/go2sky" ) +type DBType int + +const ( + MYSQL DBType = iota + IPV4 +) + type Driver struct { driver driver.Driver tracer *go2sky.Tracer + + dbtype DBType } -func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer) driver.Driver { +func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer, dbType DBType) driver.Driver { return &Driver{ driver: driver, tracer: tracer, + dbtype: dbType, } } func (d *Driver) Open(name string) (driver.Conn, error) { - // TODO: parse destination - // [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN] c, err := d.driver.Open(name) if err != nil { return nil, err } - return &conn{conn: c, tracer: d.tracer}, nil -} - -// OpenConnector implements driver.DriverContext OpenConnector -func (d *Driver) OpenConnector(name string) (driver.Connector, error) { - panic("implement me") + return &conn{ + conn: c, + tracer: d.tracer, + addr: parseAddr(name, d.dbtype), + }, nil } // emptyInjectFunc defines a empty injector for propagation.Injector function func emptyInjectFunc(key, value string) error { return nil } + +// parseAddr parse dsn to a endpoint addr string (host:port) +func parseAddr(dsn string, dbType DBType) (addr string) { + switch dbType { + case MYSQL: + // [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN] + re := regexp.MustCompile(`\(.+\)`) + addr = re.FindString(dsn) + addr = addr[1 : len(addr)-1] + case IPV4: + // ipv4 addr + re := regexp.MustCompile(`((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})(\.((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})){3}:\d{1,5}`) + addr = re.FindString(dsn) + } + return +} diff --git a/sql/driver_test.go b/sql/driver_test.go index 5445cb6..34f7c12 100644 --- a/sql/driver_test.go +++ b/sql/driver_test.go @@ -23,7 +23,7 @@ func TestDriver(t *testing.T) { tracer, err := go2sky.NewTracer("test-driver", go2sky.WithReporter(re)) assert.NoError(t, err) - sql.Register("skywalking-sql", NewTracerDriver(mysqlDriver, tracer)) + sql.Register("skywalking-sql", NewTracerDriver(mysqlDriver, tracer, MYSQL)) db, err := sql.Open("skywalking-sql", "user:password@tcp(127.0.0.1:3306)/testdb") assert.NoError(t, err) diff --git a/sql/stmt.go b/sql/stmt.go index cbb3426..0ece8d3 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -12,8 +12,8 @@ type stmt struct { stmt driver.Stmt tracer *go2sky.Tracer - // dsn defines the destination of sql server, format in host:port - dsn string + // addr defines the address of sql server, format in host:port + addr string } func (s stmt) Close() error { From 82bd97b173f22b1d9c49915bf038edc0939f704f Mon Sep 17 00:00:00 2001 From: Kagaya Date: Wed, 7 Jul 2021 00:43:32 +0800 Subject: [PATCH 04/26] add driver.Conn wrapper --- sql/common.go | 43 +++++++++++++++++++++ sql/conn.go | 97 ++++++++++++++++++++++++++++++++++++++++++------ sql/connector.go | 25 ++++++++++--- sql/driver.go | 39 +++++++------------ 4 files changed, 161 insertions(+), 43 deletions(-) create mode 100644 sql/common.go diff --git a/sql/common.go b/sql/common.go new file mode 100644 index 0000000..4e6be02 --- /dev/null +++ b/sql/common.go @@ -0,0 +1,43 @@ +package sql + +import ( + "errors" + "regexp" +) + +const ( + TagDbType = "db.type" + TagDbInstance = "db.instance" + TagDbStatement = "db.statement" + TagDbSqlParameters = "db.sql.parameters" +) + +var ErrUnsupportedOp = errors.New("operation unsupported by the underlying driver") + +// emptyInjectFunc defines a empty injector for propagation.Injector function +func emptyInjectFunc(key, value string) error { return nil } + +// parseAddr parse dsn to a endpoint addr string (host:port) +func parseAddr(dsn string, dbType DBType) (addr string) { + switch dbType { + case MYSQL: + // [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN] + re := regexp.MustCompile(`\(.+\)`) + addr = re.FindString(dsn) + addr = addr[1 : len(addr)-1] + case IPV4: + // ipv4 addr + re := regexp.MustCompile(`((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})(\.((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})){3}:\d{1,5}`) + addr = re.FindString(dsn) + } + return +} + +func genOpName(dbType DBType, opName string) string { + switch dbType { + case MYSQL: + return "Mysql/Go2Sky/" + opName + default: + return "Sql/Go2Sky/" + opName + } +} diff --git a/sql/conn.go b/sql/conn.go index 1f81cdc..c8f7f48 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -3,7 +3,6 @@ package sql import ( "context" "database/sql/driver" - "fmt" "github.com/SkyAPM/go2sky" ) @@ -15,27 +14,51 @@ type conn struct { // addr defines the address of sql server, format in host:port addr string + // dbType defines the sql server type + dbType DBType } +// Ping implements driver.Pinger interface, +// If the underlying Conn does not implement Pinger, +// Ping will return a ErrUnsupportedOp error func (c *conn) Ping(ctx context.Context) error { if pinger, ok := c.conn.(driver.Pinger); ok { - s, err := c.tracer.CreateExitSpan(ctx, "go2sky/sql/ping", c.addr, emptyInjectFunc) + s, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "ping"), c.addr, emptyInjectFunc) if err != nil { return err } defer s.End() return pinger.Ping(ctx) } - return fmt.Errorf("driver not implements driver.Pinger interface") + return ErrUnsupportedOp } func (c *conn) Prepare(query string) (driver.Stmt, error) { - return c.conn.Prepare(query) + st, err := c.conn.Prepare(query) + if err != nil { + return nil, err + } + return stmt{ + stmt: st, + tracer: c.tracer, + addr: c.addr, + }, nil } // PrepareContext implements driver.ConnPrepareContext PrepareContext func (c *conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) { - panic("") + if ConnPrepareContext, ok := c.conn.(driver.ConnPrepareContext); ok { + st, err := ConnPrepareContext.PrepareContext(ctx, query) + if err != nil { + return nil, err + } + return &stmt{ + stmt: st, + tracer: c.tracer, + addr: c.addr, + }, nil + } + return nil, ErrUnsupportedOp } // Close implements driver.Conn Close @@ -45,26 +68,78 @@ func (c *conn) Close() error { // Begin implements driver.Conn Begin func (c *conn) Begin() (driver.Tx, error) { - panic("implement me") + t, err := c.conn.Begin() + if err != nil { + return nil, err + } + return &tx{ + tx: t, + tracer: c.tracer, + }, nil } // BeginTx implements driver.ConnBeginTx BeginTx func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) { - panic("implement me") + s, ctx, err := c.tracer.CreateLocalSpan(ctx, go2sky.WithOperationName(genOpName(c.dbType, "beginTransaction"))) + if err != nil { + return nil, err + } + if connBeginTx, ok := c.conn.(driver.ConnBeginTx); ok { + t, err := connBeginTx.BeginTx(ctx, opts) + if err != nil { + return nil, err + } + return &tx{ + tx: t, + tracer: c.tracer, + span: s, + }, nil + } + return nil, ErrUnsupportedOp } func (c *conn) Exec(query string, args []driver.Value) (driver.Result, error) { - panic("implement me") + if execer, ok := c.conn.(driver.Execer); ok { + return execer.Exec(query, args) + } + return nil, ErrUnsupportedOp } func (c *conn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) { - panic("implement me") + s, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "exec"), c.addr, emptyInjectFunc) + if err != nil { + return nil, err + } + s.Tag(TagDbType, string(c.dbType)) + s.Tag(TagDbInstance, c.addr) + s.Tag(TagDbStatement, query) + defer s.End() + if execerContext, ok := c.conn.(driver.ExecerContext); ok { + return execerContext.ExecContext(ctx, query, args) + } + return nil, ErrUnsupportedOp } +// Query implements driver.Queryer Query func (c *conn) Query(query string, args []driver.Value) (driver.Rows, error) { - panic("implement me") + if queryer, ok := c.conn.(driver.Queryer); ok { + return queryer.Query(query, args) + } + return nil, ErrUnsupportedOp } +// QueryContext implements driver.QueryerContext QueryContext func (c *conn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) { - panic("implement me") + s, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "query"), c.addr, emptyInjectFunc) + if err != nil { + return nil, err + } + s.Tag(TagDbType, string(c.dbType)) + s.Tag(TagDbInstance, c.addr) + s.Tag(TagDbStatement, query) + defer s.End() + if queryerContext, ok := c.conn.(driver.QueryerContext); ok { + return queryerContext.QueryContext(ctx, query, args) + } + return nil, ErrUnsupportedOp } diff --git a/sql/connector.go b/sql/connector.go index e0dd8ae..04f691c 100644 --- a/sql/connector.go +++ b/sql/connector.go @@ -13,14 +13,27 @@ type connector struct { // addr defines the address of sql server, format in host:port addr string + // dbType defines the sql server type + dbType DBType } -func (c *connector) Connect(ctx context.Context) (driver.Conn, error) { - panic("implement me") +func (ct *connector) Connect(ctx context.Context) (driver.Conn, error) { + span, err := ct.tracer.CreateExitSpan(ctx, genOpName(ct.dbType, "connect"), ct.addr, emptyInjectFunc) + if err != nil { + return nil, err + } + defer span.End() + + c, err := ct.connector.Connect(ctx) + return &conn{ + conn: c, + tracer: ct.tracer, + addr: ct.addr, + }, nil } -func (c *connector) Driver() driver.Driver { - return c.connector.Driver() +func (ct *connector) Driver() driver.Driver { + return ct.connector.Driver() } type fallbackConnector struct { @@ -54,7 +67,7 @@ func (d *Driver) OpenConnector(name string) (driver.Connector, error) { return &connector{ connector: c, tracer: d.tracer, - addr: parseAddr(name, d.dbtype), + addr: parseAddr(name, d.dbType), }, nil } @@ -62,6 +75,6 @@ func (d *Driver) OpenConnector(name string) (driver.Connector, error) { return &connector{ connector: nil, tracer: d.tracer, - addr: parseAddr(name, d.dbtype), + addr: parseAddr(name, d.dbType), }, nil } diff --git a/sql/driver.go b/sql/driver.go index c35d52a..a417ff7 100644 --- a/sql/driver.go +++ b/sql/driver.go @@ -1,35 +1,41 @@ package sql import ( + "context" "database/sql/driver" - "regexp" "github.com/SkyAPM/go2sky" ) -type DBType int +type DBType string const ( - MYSQL DBType = iota - IPV4 + MYSQL DBType = "mysql" + IPV4 DBType = "others" ) type Driver struct { driver driver.Driver tracer *go2sky.Tracer - dbtype DBType + dbType DBType } func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer, dbType DBType) driver.Driver { return &Driver{ driver: driver, tracer: tracer, - dbtype: dbType, + dbType: dbType, } } func (d *Driver) Open(name string) (driver.Conn, error) { + addr := parseAddr(name, d.dbType) + s, err := d.tracer.CreateExitSpan(context.Background(), genOpName(d.dbType, "open"), addr, emptyInjectFunc) + if err != nil { + return nil, err + } + defer s.End() c, err := d.driver.Open(name) if err != nil { return nil, err @@ -37,25 +43,6 @@ func (d *Driver) Open(name string) (driver.Conn, error) { return &conn{ conn: c, tracer: d.tracer, - addr: parseAddr(name, d.dbtype), + addr: addr, }, nil } - -// emptyInjectFunc defines a empty injector for propagation.Injector function -func emptyInjectFunc(key, value string) error { return nil } - -// parseAddr parse dsn to a endpoint addr string (host:port) -func parseAddr(dsn string, dbType DBType) (addr string) { - switch dbType { - case MYSQL: - // [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN] - re := regexp.MustCompile(`\(.+\)`) - addr = re.FindString(dsn) - addr = addr[1 : len(addr)-1] - case IPV4: - // ipv4 addr - re := regexp.MustCompile(`((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})(\.((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})){3}:\d{1,5}`) - addr = re.FindString(dsn) - } - return -} From f94c937454a85d58f8f6e24cc5f251669aab1e9c Mon Sep 17 00:00:00 2001 From: Kagaya Date: Wed, 7 Jul 2021 15:41:09 +0800 Subject: [PATCH 05/26] implements driver.Stmt & do some refactor --- sql/README.md | 19 +++++++++- sql/common.go | 42 ++++++++++++++++++++ sql/conn.go | 95 ++++++++++++++++++++++++++++++++++------------ sql/connector.go | 19 +++++++++- sql/doc.go | 19 ++++++++++ sql/driver.go | 24 ++++++++++-- sql/driver_test.go | 17 +++++++++ sql/stmt.go | 79 ++++++++++++++++++++++++++++++++------ sql/tx.go | 22 +++++++++-- 9 files changed, 291 insertions(+), 45 deletions(-) create mode 100644 sql/doc.go diff --git a/sql/README.md b/sql/README.md index e6d6e26..58f36ae 100644 --- a/sql/README.md +++ b/sql/README.md @@ -9,7 +9,24 @@ go get -u github.com/SkyAPM/go2sky-plugins/sql ## Usage ```go -// TODO +import ( + "database/sql" + "github.com/SkyAPM/go2sky" + "github.com/SkyAPM/go2sky/reporter" + "github.com/go-sql-driver/mysql" +) +// init reporter +re, err := reporter.NewLogReporter() +defer re.Close() + +// init tracer +tracer, err := go2sky.NewTracer("service-name", go2sky.WithReporter(re)) + +// register go2sky sql wrapper +sql.Register("skywalking-sql", NewTracerDriver(&mysql.MySQLDriver{}, tracer, MYSQL)) +db, err := sql.Open("skywalking-sql", "user:password@tcp(127.0.0.1:3306)/dbname") + +// use db handle as usual. ``` \ No newline at end of file diff --git a/sql/common.go b/sql/common.go index 4e6be02..87bd63b 100644 --- a/sql/common.go +++ b/sql/common.go @@ -1,8 +1,28 @@ +// Licensed to SkyAPM org under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. SkyAPM org 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 sql import ( + "database/sql/driver" "errors" + "fmt" "regexp" + "strings" ) const ( @@ -41,3 +61,25 @@ func genOpName(dbType DBType, opName string) string { return "Sql/Go2Sky/" + opName } } + +// namedValueToValueString converts driver arguments of NamedValue format to Value string format. +func namedValueToValueString(named []driver.NamedValue) string { + b := strings.Builder{} + for _, param := range named { + b.WriteString(fmt.Sprintf("%v,", param.Value)) + } + return b.String() +} + +// namedValueToValue converts driver arguments of NamedValue format to Value format. +// Implemented in the same way as in database/sql/ctxutil.go. +func namedValueToValue(named []driver.NamedValue) ([]driver.Value, error) { + dargs := make([]driver.Value, len(named)) + for n, param := range named { + if len(param.Name) > 0 { + return nil, errors.New("sql: driver does not support the use of Named Parameters") + } + dargs[n] = param.Value + } + return dargs, nil +} diff --git a/sql/conn.go b/sql/conn.go index c8f7f48..691195b 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -1,3 +1,20 @@ +// Licensed to SkyAPM org under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. SkyAPM org 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 sql import ( @@ -18,16 +35,16 @@ type conn struct { dbType DBType } -// Ping implements driver.Pinger interface, +// Ping implements driver.Pinger interface. // If the underlying Conn does not implement Pinger, // Ping will return a ErrUnsupportedOp error func (c *conn) Ping(ctx context.Context) error { if pinger, ok := c.conn.(driver.Pinger); ok { - s, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "ping"), c.addr, emptyInjectFunc) + span, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "ping"), c.addr, emptyInjectFunc) if err != nil { return err } - defer s.End() + defer span.End() return pinger.Ping(ctx) } return ErrUnsupportedOp @@ -38,14 +55,19 @@ func (c *conn) Prepare(query string) (driver.Stmt, error) { if err != nil { return nil, err } - return stmt{ + return &stmt{ stmt: st, tracer: c.tracer, + query: query, addr: c.addr, + dbType: c.dbType, }, nil } // PrepareContext implements driver.ConnPrepareContext PrepareContext +// If the underlying Conn does not implements +// driver.ConnPrepareContext interface, this method +// will use Prepare instead. func (c *conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) { if ConnPrepareContext, ok := c.conn.(driver.ConnPrepareContext); ok { st, err := ConnPrepareContext.PrepareContext(ctx, query) @@ -55,10 +77,12 @@ func (c *conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, e return &stmt{ stmt: st, tracer: c.tracer, + query: query, addr: c.addr, + dbType: c.dbType, }, nil } - return nil, ErrUnsupportedOp + return c.Prepare(query) } // Close implements driver.Conn Close @@ -73,14 +97,16 @@ func (c *conn) Begin() (driver.Tx, error) { return nil, err } return &tx{ - tx: t, - tracer: c.tracer, + tx: t, }, nil } -// BeginTx implements driver.ConnBeginTx BeginTx +// BeginTx implements driver.ConnBeginTx BeginTx. +// If the underlying Conn does not implements +// driver.ConnBeginTx interface, this method +// will use Begin instead. func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) { - s, ctx, err := c.tracer.CreateLocalSpan(ctx, go2sky.WithOperationName(genOpName(c.dbType, "beginTransaction"))) + span, ctx, err := c.tracer.CreateLocalSpan(ctx, go2sky.WithOperationName(genOpName(c.dbType, "beginTransaction"))) if err != nil { return nil, err } @@ -90,14 +116,14 @@ func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, e return nil, err } return &tx{ - tx: t, - tracer: c.tracer, - span: s, + tx: t, + span: span, }, nil } - return nil, ErrUnsupportedOp + return c.Begin() } +// Exec implements driver.Execer Exec func (c *conn) Exec(query string, args []driver.Value) (driver.Result, error) { if execer, ok := c.conn.(driver.Execer); ok { return execer.Exec(query, args) @@ -105,19 +131,29 @@ func (c *conn) Exec(query string, args []driver.Value) (driver.Result, error) { return nil, ErrUnsupportedOp } +// ExecContext implements driver.ExecerContext ExecContext. +// If the underlying Conn does not implements +// driver.ExecerContext interface, this method +// will use Exec instead. func (c *conn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) { - s, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "exec"), c.addr, emptyInjectFunc) + span, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "exec"), c.addr, emptyInjectFunc) if err != nil { return nil, err } - s.Tag(TagDbType, string(c.dbType)) - s.Tag(TagDbInstance, c.addr) - s.Tag(TagDbStatement, query) - defer s.End() + defer span.End() + span.Tag(TagDbType, string(c.dbType)) + span.Tag(TagDbInstance, c.addr) + span.Tag(TagDbStatement, query) + if execerContext, ok := c.conn.(driver.ExecerContext); ok { return execerContext.ExecContext(ctx, query, args) } - return nil, ErrUnsupportedOp + + values, err := namedValueToValue(args) + if err != nil { + return nil, err + } + return c.Exec(query, values) } // Query implements driver.Queryer Query @@ -129,17 +165,26 @@ func (c *conn) Query(query string, args []driver.Value) (driver.Rows, error) { } // QueryContext implements driver.QueryerContext QueryContext +// If the underlying Conn does not implements +// driver.QueryerContext interface, this method +// will use Query instead. func (c *conn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) { - s, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "query"), c.addr, emptyInjectFunc) + span, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "query"), c.addr, emptyInjectFunc) if err != nil { return nil, err } - s.Tag(TagDbType, string(c.dbType)) - s.Tag(TagDbInstance, c.addr) - s.Tag(TagDbStatement, query) - defer s.End() + defer span.End() + span.Tag(TagDbType, string(c.dbType)) + span.Tag(TagDbInstance, c.addr) + span.Tag(TagDbStatement, query) + if queryerContext, ok := c.conn.(driver.QueryerContext); ok { return queryerContext.QueryContext(ctx, query, args) } - return nil, ErrUnsupportedOp + + values, err := namedValueToValue(args) + if err != nil { + return nil, err + } + return c.Query(query, values) } diff --git a/sql/connector.go b/sql/connector.go index 04f691c..ad94f1d 100644 --- a/sql/connector.go +++ b/sql/connector.go @@ -1,3 +1,20 @@ +// Licensed to SkyAPM org under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. SkyAPM org 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 sql import ( @@ -58,7 +75,7 @@ func (fc *fallbackConnector) Driver() driver.Driver { } // OpenConnector implements driver.DriverContext OpenConnector -func (d *Driver) OpenConnector(name string) (driver.Connector, error) { +func (d *swDriver) OpenConnector(name string) (driver.Connector, error) { if dc, ok := d.driver.(driver.DriverContext); ok { c, err := dc.OpenConnector(name) if err != nil { diff --git a/sql/doc.go b/sql/doc.go new file mode 100644 index 0000000..45b0086 --- /dev/null +++ b/sql/doc.go @@ -0,0 +1,19 @@ +// Licensed to SkyAPM org under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. SkyAPM org 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 sql is a plugin that can be used to trace database/sql. +package sql diff --git a/sql/driver.go b/sql/driver.go index a417ff7..b056625 100644 --- a/sql/driver.go +++ b/sql/driver.go @@ -1,3 +1,20 @@ +// Licensed to SkyAPM org under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. SkyAPM org 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 sql import ( @@ -14,7 +31,8 @@ const ( IPV4 DBType = "others" ) -type Driver struct { +// swDriver is a tracing wrapper for driver.Driver +type swDriver struct { driver driver.Driver tracer *go2sky.Tracer @@ -22,14 +40,14 @@ type Driver struct { } func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer, dbType DBType) driver.Driver { - return &Driver{ + return &swDriver{ driver: driver, tracer: tracer, dbType: dbType, } } -func (d *Driver) Open(name string) (driver.Conn, error) { +func (d *swDriver) Open(name string) (driver.Conn, error) { addr := parseAddr(name, d.dbType) s, err := d.tracer.CreateExitSpan(context.Background(), genOpName(d.dbType, "open"), addr, emptyInjectFunc) if err != nil { diff --git a/sql/driver_test.go b/sql/driver_test.go index 34f7c12..2ac2c9d 100644 --- a/sql/driver_test.go +++ b/sql/driver_test.go @@ -1,3 +1,20 @@ +// Licensed to SkyAPM org under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. SkyAPM org 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 sql import ( diff --git a/sql/stmt.go b/sql/stmt.go index 0ece8d3..117caf1 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -1,3 +1,20 @@ +// Licensed to SkyAPM org under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. SkyAPM org 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 sql import ( @@ -12,30 +29,68 @@ type stmt struct { stmt driver.Stmt tracer *go2sky.Tracer + // query defines the statement query + query string // addr defines the address of sql server, format in host:port addr string + // dbType defines the sql server type + dbType DBType } -func (s stmt) Close() error { - panic("implement me") +func (s *stmt) Close() error { + return s.stmt.Close() } -func (s stmt) NumInput() int { - panic("implement me") +func (s *stmt) NumInput() int { + return s.stmt.NumInput() } -func (s stmt) Exec(args []driver.Value) (driver.Result, error) { - panic("implement me") +func (s *stmt) Exec(args []driver.Value) (driver.Result, error) { + return s.stmt.Exec(args) } -func (s stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error) { - panic("implement me") +func (s *stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error) { + span, err := s.tracer.CreateExitSpan(ctx, genOpName(s.dbType, "exec"), s.addr, emptyInjectFunc) + if err != nil { + return nil, err + } + defer span.End() + span.Tag(TagDbType, string(s.dbType)) + span.Tag(TagDbInstance, s.addr) + span.Tag(TagDbStatement, s.query) + + if execerContext, ok := s.stmt.(driver.StmtExecContext); ok { + return execerContext.ExecContext(ctx, args) + } + + values, err := namedValueToValue(args) + if err != nil { + return nil, err + } + return s.Exec(values) } -func (s stmt) Query(args []driver.Value) (driver.Rows, error) { - panic("implement me") +func (s *stmt) Query(args []driver.Value) (driver.Rows, error) { + return s.stmt.Query(args) } -func (s stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error) { - panic("implement me") +func (s *stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error) { + span, err := s.tracer.CreateExitSpan(ctx, genOpName(s.dbType, "query"), s.addr, emptyInjectFunc) + if err != nil { + return nil, err + } + defer span.End() + span.Tag(TagDbType, string(s.dbType)) + span.Tag(TagDbInstance, s.addr) + span.Tag(TagDbStatement, s.query) + + if queryer, ok := s.stmt.(driver.StmtQueryContext); ok { + return queryer.QueryContext(ctx, args) + } + + values, err := namedValueToValue(args) + if err != nil { + return nil, err + } + return s.Query(values) } diff --git a/sql/tx.go b/sql/tx.go index 3ece48e..9b113ea 100644 --- a/sql/tx.go +++ b/sql/tx.go @@ -1,3 +1,20 @@ +// Licensed to SkyAPM org under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. SkyAPM org 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 sql import ( @@ -8,8 +25,7 @@ import ( // tx is a wrapper for driver.Tx type tx struct { - tx driver.Tx - tracer *go2sky.Tracer + tx driver.Tx span go2sky.Span } @@ -25,4 +41,4 @@ func (t *tx) Rollback() error { defer t.span.End() } return t.tx.Rollback() -} \ No newline at end of file +} From ad7b5a1ec2fd9484fe4adcd0996cbe7479eb5eaf Mon Sep 17 00:00:00 2001 From: Kagaya Date: Wed, 7 Jul 2021 15:49:03 +0800 Subject: [PATCH 06/26] add fallback connector --- sql/connector.go | 11 +++++++---- sql/driver.go | 8 ++++---- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/sql/connector.go b/sql/connector.go index ad94f1d..c402d8c 100644 --- a/sql/connector.go +++ b/sql/connector.go @@ -75,7 +75,7 @@ func (fc *fallbackConnector) Driver() driver.Driver { } // OpenConnector implements driver.DriverContext OpenConnector -func (d *swDriver) OpenConnector(name string) (driver.Connector, error) { +func (d *swSQLDriver) OpenConnector(name string) (driver.Connector, error) { if dc, ok := d.driver.(driver.DriverContext); ok { c, err := dc.OpenConnector(name) if err != nil { @@ -90,8 +90,11 @@ func (d *swDriver) OpenConnector(name string) (driver.Connector, error) { // given driver does not implement driver.DriverContext interface return &connector{ - connector: nil, - tracer: d.tracer, - addr: parseAddr(name, d.dbType), + connector: &fallbackConnector{ + driver: d.driver, + name: name, + }, + tracer: d.tracer, + addr: parseAddr(name, d.dbType), }, nil } diff --git a/sql/driver.go b/sql/driver.go index b056625..cc04fe6 100644 --- a/sql/driver.go +++ b/sql/driver.go @@ -31,8 +31,8 @@ const ( IPV4 DBType = "others" ) -// swDriver is a tracing wrapper for driver.Driver -type swDriver struct { +// swSQLDriver is a tracing wrapper for driver.Driver +type swSQLDriver struct { driver driver.Driver tracer *go2sky.Tracer @@ -40,14 +40,14 @@ type swDriver struct { } func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer, dbType DBType) driver.Driver { - return &swDriver{ + return &swSQLDriver{ driver: driver, tracer: tracer, dbType: dbType, } } -func (d *swDriver) Open(name string) (driver.Conn, error) { +func (d *swSQLDriver) Open(name string) (driver.Conn, error) { addr := parseAddr(name, d.dbType) s, err := d.tracer.CreateExitSpan(context.Background(), genOpName(d.dbType, "open"), addr, emptyInjectFunc) if err != nil { From ecd42a11d348b1b89d25084c50ea000cbf3450e5 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Wed, 7 Jul 2021 16:36:13 +0800 Subject: [PATCH 07/26] go mod tidy --- sql/go.mod | 5 ++--- sql/go.sum | 7 ++++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/sql/go.mod b/sql/go.mod index 92a6ffe..9b5dd56 100644 --- a/sql/go.mod +++ b/sql/go.mod @@ -4,11 +4,10 @@ go 1.16 require ( github.com/SkyAPM/go2sky v1.1.0 - github.com/go-sql-driver/mysql v1.6.0 // indirect + github.com/go-sql-driver/mysql v1.6.0 github.com/google/uuid v1.2.0 // indirect github.com/pkg/errors v0.9.1 // indirect - github.com/stretchr/objx v0.3.0 // indirect - github.com/stretchr/testify v1.7.0 // indirect + github.com/stretchr/testify v1.7.0 golang.org/x/net v0.0.0-20210614182718-04defd469f4e // indirect golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect google.golang.org/genproto v0.0.0-20210630183607-d20f26d13c79 // indirect diff --git a/sql/go.sum b/sql/go.sum index f90e810..ec9ef0b 100644 --- a/sql/go.sum +++ b/sql/go.sum @@ -33,6 +33,7 @@ github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LB github.com/gogo/protobuf v1.0.0/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= +github.com/golang/mock v1.5.0 h1:jlYHihg//f7RRwuPfptm04yp4s7O6Kw8EZiVYIGcH0g= github.com/golang/mock v1.5.0/go.mod h1:CWnOUgYIOo4TcNZ0wHX3YZCqsaM1I1Jvs6v3mP3KVu8= github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= @@ -63,8 +64,10 @@ github.com/gorilla/mux v1.6.1/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2z github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= github.com/grpc-ecosystem/grpc-gateway v1.16.0/go.mod h1:BDjrQk3hbvj6Nolgz8mAMFbcEtjT1g+wF4CSlocrBnw= github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= +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/logrusorgru/aurora v0.0.0-20200102142835-e9ef32dff381/go.mod h1:7rIyQOR62GCctdiQpZ/zOJlFyk6y+94wXzv6RNZgaR4= github.com/matryer/moq v0.0.0-20200106131100-75d0ddfc0007/go.mod h1:9ELz6aaclSIGnZBoaSLZ3NAl1VTufbOrXBPvtcy6WiQ= @@ -88,10 +91,7 @@ github.com/shurcooL/httpfs v0.0.0-20171119174359-809beceb2371/go.mod h1:ZY1cvUeJ github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/shurcooL/vfsgen v0.0.0-20180121065927-ffb13db8def0/go.mod h1:TrYk7fJVaAttu97ZZKrO9UbRa8izdowaMIZcxYMbVaw= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/objx v0.3.0 h1:NGXK3lHquSN08v5vWalVI/L8XU9hdzE/G6xsrze47As= -github.com/stretchr/objx v0.3.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE= github.com/stretchr/testify v1.2.1/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= -github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= @@ -199,6 +199,7 @@ google.golang.org/protobuf v1.27.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQ google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ= google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= From 1ba7cc0f880460a01e7f840878a79e89e18aa319 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Tue, 13 Jul 2021 16:55:20 +0800 Subject: [PATCH 08/26] add createSpan func for componentID & spanLayer --- sql/common.go | 72 ++++++++++++++++++++++++++++++++++++++++-------- sql/conn.go | 32 ++++++++++----------- sql/connector.go | 19 +++++++------ sql/driver.go | 11 +++++--- sql/stmt.go | 30 ++++++++++++-------- 5 files changed, 111 insertions(+), 53 deletions(-) diff --git a/sql/common.go b/sql/common.go index 87bd63b..072077f 100644 --- a/sql/common.go +++ b/sql/common.go @@ -18,28 +18,54 @@ package sql import ( + "context" "database/sql/driver" "errors" "fmt" "regexp" "strings" + + "github.com/SkyAPM/go2sky" + agentv3 "skywalking.apache.org/repo/goapi/collect/language/agent/v3" ) const ( - TagDbType = "db.type" - TagDbInstance = "db.instance" - TagDbStatement = "db.statement" - TagDbSqlParameters = "db.sql.parameters" + componentIDUnknown = 0 + componentIDMysql = 5010 + componentIDSqlite = 5011 ) +const ( + tagDbType = "db.type" + tagDbInstance = "db.instance" + tagDbStatement = "db.statement" + tagDbSqlParameters = "db.sql.parameters" +) + +type attribute struct { + dbType DBType + peer string + componentID int32 +} + var ErrUnsupportedOp = errors.New("operation unsupported by the underlying driver") // emptyInjectFunc defines a empty injector for propagation.Injector function func emptyInjectFunc(key, value string) error { return nil } -// parseAddr parse dsn to a endpoint addr string (host:port) -func parseAddr(dsn string, dbType DBType) (addr string) { - switch dbType { +func newAttribute(name string, dbType DBType) attribute { + a := attribute{ + dbType: dbType, + } + a.setPeer(name) + a.setComponentID() + return a +} + +// setPeer parse dsn to a endpoint addr string (host:port) +func (a attribute) setPeer(dsn string) { + var addr string + switch a.dbType { case MYSQL: // [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN] re := regexp.MustCompile(`\(.+\)`) @@ -50,15 +76,25 @@ func parseAddr(dsn string, dbType DBType) (addr string) { re := regexp.MustCompile(`((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})(\.((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})){3}:\d{1,5}`) addr = re.FindString(dsn) } + a.peer = addr return } -func genOpName(dbType DBType, opName string) string { - switch dbType { +func (a attribute) getOpName(op string) string { + switch a.dbType { case MYSQL: - return "Mysql/Go2Sky/" + opName + return "Mysql/Go2Sky/" + op default: - return "Sql/Go2Sky/" + opName + return "Sql/Go2Sky/" + op + } +} + +func (a attribute) setComponentID() { + switch a.dbType { + case MYSQL: + a.componentID = componentIDMysql + default: + a.componentID = componentIDUnknown } } @@ -83,3 +119,17 @@ func namedValueToValue(named []driver.NamedValue) ([]driver.Value, error) { } return dargs, nil } + +func createSpan(ctx context.Context, tracer *go2sky.Tracer, attr attribute, operation string) (go2sky.Span, error) { + s, _, err := tracer.CreateLocalSpan(ctx, + go2sky.WithSpanType(go2sky.SpanTypeExit), + go2sky.WithOperationName(attr.getOpName(operation)), + ) + if err != nil { + return nil, err + } + s.SetPeer(attr.peer) + s.SetComponent(attr.componentID) + s.SetSpanLayer(agentv3.SpanLayer_Database) + return s, nil +} diff --git a/sql/conn.go b/sql/conn.go index 691195b..e6f1fbc 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -29,10 +29,8 @@ type conn struct { conn driver.Conn tracer *go2sky.Tracer - // addr defines the address of sql server, format in host:port - addr string - // dbType defines the sql server type - dbType DBType + // attr include some attributes need to report to OAP server + attr attribute } // Ping implements driver.Pinger interface. @@ -40,7 +38,7 @@ type conn struct { // Ping will return a ErrUnsupportedOp error func (c *conn) Ping(ctx context.Context) error { if pinger, ok := c.conn.(driver.Pinger); ok { - span, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "ping"), c.addr, emptyInjectFunc) + span, err := createSpan(ctx, c.tracer, c.attr, "ping") if err != nil { return err } @@ -59,8 +57,7 @@ func (c *conn) Prepare(query string) (driver.Stmt, error) { stmt: st, tracer: c.tracer, query: query, - addr: c.addr, - dbType: c.dbType, + attr: c.attr, }, nil } @@ -78,8 +75,7 @@ func (c *conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, e stmt: st, tracer: c.tracer, query: query, - addr: c.addr, - dbType: c.dbType, + attr: c.attr, }, nil } return c.Prepare(query) @@ -106,7 +102,7 @@ func (c *conn) Begin() (driver.Tx, error) { // driver.ConnBeginTx interface, this method // will use Begin instead. func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) { - span, ctx, err := c.tracer.CreateLocalSpan(ctx, go2sky.WithOperationName(genOpName(c.dbType, "beginTransaction"))) + span, err := createSpan(ctx, c.tracer, c.attr, "beginTransaction") if err != nil { return nil, err } @@ -136,14 +132,14 @@ func (c *conn) Exec(query string, args []driver.Value) (driver.Result, error) { // driver.ExecerContext interface, this method // will use Exec instead. func (c *conn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) { - span, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "exec"), c.addr, emptyInjectFunc) + span, err := createSpan(ctx, c.tracer, c.attr, "execute") if err != nil { return nil, err } defer span.End() - span.Tag(TagDbType, string(c.dbType)) - span.Tag(TagDbInstance, c.addr) - span.Tag(TagDbStatement, query) + span.Tag(tagDbType, string(c.attr.dbType)) + span.Tag(tagDbInstance, c.attr.peer) + span.Tag(tagDbStatement, query) if execerContext, ok := c.conn.(driver.ExecerContext); ok { return execerContext.ExecContext(ctx, query, args) @@ -169,14 +165,14 @@ func (c *conn) Query(query string, args []driver.Value) (driver.Rows, error) { // driver.QueryerContext interface, this method // will use Query instead. func (c *conn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) { - span, err := c.tracer.CreateExitSpan(ctx, genOpName(c.dbType, "query"), c.addr, emptyInjectFunc) + span, err := createSpan(ctx, c.tracer, c.attr, "query") if err != nil { return nil, err } defer span.End() - span.Tag(TagDbType, string(c.dbType)) - span.Tag(TagDbInstance, c.addr) - span.Tag(TagDbStatement, query) + span.Tag(tagDbType, string(c.attr.dbType)) + span.Tag(tagDbInstance, c.attr.peer) + span.Tag(tagDbStatement, query) if queryerContext, ok := c.conn.(driver.QueryerContext); ok { return queryerContext.QueryContext(ctx, query, args) diff --git a/sql/connector.go b/sql/connector.go index c402d8c..e085c5e 100644 --- a/sql/connector.go +++ b/sql/connector.go @@ -28,24 +28,24 @@ type connector struct { connector driver.Connector tracer *go2sky.Tracer - // addr defines the address of sql server, format in host:port - addr string - // dbType defines the sql server type - dbType DBType + // attr include some attributes need to report to OAP server + attr attribute } func (ct *connector) Connect(ctx context.Context) (driver.Conn, error) { - span, err := ct.tracer.CreateExitSpan(ctx, genOpName(ct.dbType, "connect"), ct.addr, emptyInjectFunc) + span, err := createSpan(ctx, ct.tracer, ct.attr, "connect") if err != nil { return nil, err } defer span.End() + span.Tag(tagDbType, string(ct.attr.dbType)) + span.Tag(tagDbInstance, ct.attr.peer) c, err := ct.connector.Connect(ctx) return &conn{ conn: c, tracer: ct.tracer, - addr: ct.addr, + attr: ct.attr, }, nil } @@ -56,6 +56,7 @@ func (ct *connector) Driver() driver.Driver { type fallbackConnector struct { driver driver.Driver name string + attr attribute } func (fc *fallbackConnector) Connect(ctx context.Context) (driver.Conn, error) { @@ -76,6 +77,7 @@ func (fc *fallbackConnector) Driver() driver.Driver { // OpenConnector implements driver.DriverContext OpenConnector func (d *swSQLDriver) OpenConnector(name string) (driver.Connector, error) { + attr := newAttribute(name, d.dbType) if dc, ok := d.driver.(driver.DriverContext); ok { c, err := dc.OpenConnector(name) if err != nil { @@ -84,7 +86,7 @@ func (d *swSQLDriver) OpenConnector(name string) (driver.Connector, error) { return &connector{ connector: c, tracer: d.tracer, - addr: parseAddr(name, d.dbType), + attr: attr, }, nil } @@ -93,8 +95,9 @@ func (d *swSQLDriver) OpenConnector(name string) (driver.Connector, error) { connector: &fallbackConnector{ driver: d.driver, name: name, + attr: attr, }, tracer: d.tracer, - addr: parseAddr(name, d.dbType), + attr: attr, }, nil } diff --git a/sql/driver.go b/sql/driver.go index cc04fe6..d101e4b 100644 --- a/sql/driver.go +++ b/sql/driver.go @@ -48,12 +48,15 @@ func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer, dbType DBType) } func (d *swSQLDriver) Open(name string) (driver.Conn, error) { - addr := parseAddr(name, d.dbType) - s, err := d.tracer.CreateExitSpan(context.Background(), genOpName(d.dbType, "open"), addr, emptyInjectFunc) + attr := newAttribute(name, d.dbType) + span, err := createSpan(context.Background(), d.tracer, attr, "open") if err != nil { return nil, err } - defer s.End() + defer span.End() + span.Tag(tagDbType, string(attr.dbType)) + span.Tag(tagDbInstance, attr.peer) + c, err := d.driver.Open(name) if err != nil { return nil, err @@ -61,6 +64,6 @@ func (d *swSQLDriver) Open(name string) (driver.Conn, error) { return &conn{ conn: c, tracer: d.tracer, - addr: addr, + attr: attr, }, nil } diff --git a/sql/stmt.go b/sql/stmt.go index 117caf1..2c44143 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -31,10 +31,8 @@ type stmt struct { // query defines the statement query query string - // addr defines the address of sql server, format in host:port - addr string - // dbType defines the sql server type - dbType DBType + // attr include some attributes need to report to OAP server + attr attribute } func (s *stmt) Close() error { @@ -49,15 +47,19 @@ func (s *stmt) Exec(args []driver.Value) (driver.Result, error) { return s.stmt.Exec(args) } +// ExecContext implements driver.StmtExecContext ExecContext +// If the underlying Stmt does not implements +// driver.StmtExecContext interface, this method +// will use Exec instead. func (s *stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error) { - span, err := s.tracer.CreateExitSpan(ctx, genOpName(s.dbType, "exec"), s.addr, emptyInjectFunc) + span, err := createSpan(ctx, s.tracer, s.attr, "execute") if err != nil { return nil, err } defer span.End() - span.Tag(TagDbType, string(s.dbType)) - span.Tag(TagDbInstance, s.addr) - span.Tag(TagDbStatement, s.query) + span.Tag(tagDbType, string(s.attr.dbType)) + span.Tag(tagDbInstance, s.attr.peer) + span.Tag(tagDbStatement, s.query) if execerContext, ok := s.stmt.(driver.StmtExecContext); ok { return execerContext.ExecContext(ctx, args) @@ -74,15 +76,19 @@ func (s *stmt) Query(args []driver.Value) (driver.Rows, error) { return s.stmt.Query(args) } +// QueryContext implements driver.StmtQueryContext QueryContext +// If the underlying Stmt does not implements +// driver.StmtQueryContext interface, this method +// will use Query instead. func (s *stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error) { - span, err := s.tracer.CreateExitSpan(ctx, genOpName(s.dbType, "query"), s.addr, emptyInjectFunc) + span, err := createSpan(ctx, s.tracer, s.attr, "query") if err != nil { return nil, err } defer span.End() - span.Tag(TagDbType, string(s.dbType)) - span.Tag(TagDbInstance, s.addr) - span.Tag(TagDbStatement, s.query) + span.Tag(tagDbType, string(s.attr.dbType)) + span.Tag(tagDbInstance, s.attr.peer) + span.Tag(tagDbStatement, s.query) if queryer, ok := s.stmt.(driver.StmtQueryContext); ok { return queryer.QueryContext(ctx, args) From 155fc08638e4061c8fa5e33ae9830c54481de3e1 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Mon, 19 Jul 2021 15:19:18 +0800 Subject: [PATCH 09/26] add driver options --- sql/common.go | 60 ++----------------------- sql/conn.go | 23 +++++----- sql/connector.go | 29 +++++++----- sql/driver.go | 42 ++++++++++-------- sql/driver_test.go | 2 +- sql/options.go | 84 +++++++++++++++++++++++++++++++++++ sql/stmt.go | 15 +++---- sql/test/sql_plugin_test.yaml | 9 ++++ 8 files changed, 156 insertions(+), 108 deletions(-) create mode 100644 sql/options.go create mode 100644 sql/test/sql_plugin_test.yaml diff --git a/sql/common.go b/sql/common.go index 072077f..8e7c173 100644 --- a/sql/common.go +++ b/sql/common.go @@ -22,7 +22,6 @@ import ( "database/sql/driver" "errors" "fmt" - "regexp" "strings" "github.com/SkyAPM/go2sky" @@ -42,62 +41,11 @@ const ( tagDbSqlParameters = "db.sql.parameters" ) -type attribute struct { - dbType DBType - peer string - componentID int32 -} - var ErrUnsupportedOp = errors.New("operation unsupported by the underlying driver") // emptyInjectFunc defines a empty injector for propagation.Injector function func emptyInjectFunc(key, value string) error { return nil } -func newAttribute(name string, dbType DBType) attribute { - a := attribute{ - dbType: dbType, - } - a.setPeer(name) - a.setComponentID() - return a -} - -// setPeer parse dsn to a endpoint addr string (host:port) -func (a attribute) setPeer(dsn string) { - var addr string - switch a.dbType { - case MYSQL: - // [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN] - re := regexp.MustCompile(`\(.+\)`) - addr = re.FindString(dsn) - addr = addr[1 : len(addr)-1] - case IPV4: - // ipv4 addr - re := regexp.MustCompile(`((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})(\.((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})){3}:\d{1,5}`) - addr = re.FindString(dsn) - } - a.peer = addr - return -} - -func (a attribute) getOpName(op string) string { - switch a.dbType { - case MYSQL: - return "Mysql/Go2Sky/" + op - default: - return "Sql/Go2Sky/" + op - } -} - -func (a attribute) setComponentID() { - switch a.dbType { - case MYSQL: - a.componentID = componentIDMysql - default: - a.componentID = componentIDUnknown - } -} - // namedValueToValueString converts driver arguments of NamedValue format to Value string format. func namedValueToValueString(named []driver.NamedValue) string { b := strings.Builder{} @@ -120,16 +68,16 @@ func namedValueToValue(named []driver.NamedValue) ([]driver.Value, error) { return dargs, nil } -func createSpan(ctx context.Context, tracer *go2sky.Tracer, attr attribute, operation string) (go2sky.Span, error) { +func createSpan(ctx context.Context, tracer *go2sky.Tracer, opts *options, operation string) (go2sky.Span, error) { s, _, err := tracer.CreateLocalSpan(ctx, go2sky.WithSpanType(go2sky.SpanTypeExit), - go2sky.WithOperationName(attr.getOpName(operation)), + go2sky.WithOperationName(opts.getOpName(operation)), ) if err != nil { return nil, err } - s.SetPeer(attr.peer) - s.SetComponent(attr.componentID) + s.SetPeer(opts.peer) + s.SetComponent(opts.componentID) s.SetSpanLayer(agentv3.SpanLayer_Database) return s, nil } diff --git a/sql/conn.go b/sql/conn.go index e6f1fbc..88003a2 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -29,8 +29,7 @@ type conn struct { conn driver.Conn tracer *go2sky.Tracer - // attr include some attributes need to report to OAP server - attr attribute + opts *options } // Ping implements driver.Pinger interface. @@ -38,7 +37,7 @@ type conn struct { // Ping will return a ErrUnsupportedOp error func (c *conn) Ping(ctx context.Context) error { if pinger, ok := c.conn.(driver.Pinger); ok { - span, err := createSpan(ctx, c.tracer, c.attr, "ping") + span, err := createSpan(ctx, c.tracer, c.opts, "ping") if err != nil { return err } @@ -57,7 +56,7 @@ func (c *conn) Prepare(query string) (driver.Stmt, error) { stmt: st, tracer: c.tracer, query: query, - attr: c.attr, + opts: c.opts, }, nil } @@ -75,7 +74,7 @@ func (c *conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, e stmt: st, tracer: c.tracer, query: query, - attr: c.attr, + opts: c.opts, }, nil } return c.Prepare(query) @@ -102,7 +101,7 @@ func (c *conn) Begin() (driver.Tx, error) { // driver.ConnBeginTx interface, this method // will use Begin instead. func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) { - span, err := createSpan(ctx, c.tracer, c.attr, "beginTransaction") + span, err := createSpan(ctx, c.tracer, c.opts, "beginTransaction") if err != nil { return nil, err } @@ -132,13 +131,13 @@ func (c *conn) Exec(query string, args []driver.Value) (driver.Result, error) { // driver.ExecerContext interface, this method // will use Exec instead. func (c *conn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) { - span, err := createSpan(ctx, c.tracer, c.attr, "execute") + span, err := createSpan(ctx, c.tracer, c.opts, "execute") if err != nil { return nil, err } defer span.End() - span.Tag(tagDbType, string(c.attr.dbType)) - span.Tag(tagDbInstance, c.attr.peer) + span.Tag(tagDbType, string(c.opts.dbType)) + span.Tag(tagDbInstance, c.opts.peer) span.Tag(tagDbStatement, query) if execerContext, ok := c.conn.(driver.ExecerContext); ok { @@ -165,13 +164,13 @@ func (c *conn) Query(query string, args []driver.Value) (driver.Rows, error) { // driver.QueryerContext interface, this method // will use Query instead. func (c *conn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) { - span, err := createSpan(ctx, c.tracer, c.attr, "query") + span, err := createSpan(ctx, c.tracer, c.opts, "query") if err != nil { return nil, err } defer span.End() - span.Tag(tagDbType, string(c.attr.dbType)) - span.Tag(tagDbInstance, c.attr.peer) + span.Tag(tagDbType, string(c.opts.dbType)) + span.Tag(tagDbInstance, c.opts.peer) span.Tag(tagDbStatement, query) if queryerContext, ok := c.conn.(driver.QueryerContext); ok { diff --git a/sql/connector.go b/sql/connector.go index e085c5e..81d378f 100644 --- a/sql/connector.go +++ b/sql/connector.go @@ -28,24 +28,26 @@ type connector struct { connector driver.Connector tracer *go2sky.Tracer - // attr include some attributes need to report to OAP server - attr attribute + opts *options } func (ct *connector) Connect(ctx context.Context) (driver.Conn, error) { - span, err := createSpan(ctx, ct.tracer, ct.attr, "connect") + span, err := createSpan(ctx, ct.tracer, ct.opts, "connect") if err != nil { return nil, err } defer span.End() - span.Tag(tagDbType, string(ct.attr.dbType)) - span.Tag(tagDbInstance, ct.attr.peer) + span.Tag(tagDbType, string(ct.opts.dbType)) + span.Tag(tagDbInstance, ct.opts.peer) c, err := ct.connector.Connect(ctx) + if err != nil { + return nil, err + } return &conn{ conn: c, tracer: ct.tracer, - attr: ct.attr, + opts: ct.opts, }, nil } @@ -56,7 +58,8 @@ func (ct *connector) Driver() driver.Driver { type fallbackConnector struct { driver driver.Driver name string - attr attribute + + opts *options } func (fc *fallbackConnector) Connect(ctx context.Context) (driver.Conn, error) { @@ -76,8 +79,10 @@ func (fc *fallbackConnector) Driver() driver.Driver { } // OpenConnector implements driver.DriverContext OpenConnector -func (d *swSQLDriver) OpenConnector(name string) (driver.Connector, error) { - attr := newAttribute(name, d.dbType) +func (d *go2SkySQLDriver) OpenConnector(name string) (driver.Connector, error) { + if d.opts.peer == "" { + d.opts.setPeerWithDsn(name) + } if dc, ok := d.driver.(driver.DriverContext); ok { c, err := dc.OpenConnector(name) if err != nil { @@ -86,7 +91,7 @@ func (d *swSQLDriver) OpenConnector(name string) (driver.Connector, error) { return &connector{ connector: c, tracer: d.tracer, - attr: attr, + opts: d.opts, }, nil } @@ -95,9 +100,9 @@ func (d *swSQLDriver) OpenConnector(name string) (driver.Connector, error) { connector: &fallbackConnector{ driver: d.driver, name: name, - attr: attr, + opts: d.opts, }, tracer: d.tracer, - attr: attr, + opts: d.opts, }, nil } diff --git a/sql/driver.go b/sql/driver.go index d101e4b..6b87e1f 100644 --- a/sql/driver.go +++ b/sql/driver.go @@ -24,38 +24,42 @@ import ( "github.com/SkyAPM/go2sky" ) -type DBType string - -const ( - MYSQL DBType = "mysql" - IPV4 DBType = "others" -) - -// swSQLDriver is a tracing wrapper for driver.Driver -type swSQLDriver struct { +// go2SkySQLDriver is a tracing wrapper for driver.Driver +type go2SkySQLDriver struct { driver driver.Driver tracer *go2sky.Tracer - dbType DBType + opts *options } -func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer, dbType DBType) driver.Driver { - return &swSQLDriver{ +func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer, opts ...Option) driver.Driver { + options := &options{ + dbType: IPV4, + } + for _, o := range opts { + o(options) + } + if options.componentID == 0 { + options.setComponentID() + } + return &go2SkySQLDriver{ driver: driver, tracer: tracer, - dbType: dbType, + opts: options, } } -func (d *swSQLDriver) Open(name string) (driver.Conn, error) { - attr := newAttribute(name, d.dbType) - span, err := createSpan(context.Background(), d.tracer, attr, "open") +func (d *go2SkySQLDriver) Open(name string) (driver.Conn, error) { + if d.opts.peer == "" { + d.opts.setPeerWithDsn(name) + } + span, err := createSpan(context.Background(), d.tracer, d.opts, "open") if err != nil { return nil, err } defer span.End() - span.Tag(tagDbType, string(attr.dbType)) - span.Tag(tagDbInstance, attr.peer) + span.Tag(tagDbType, string(d.opts.dbType)) + span.Tag(tagDbInstance, d.opts.peer) c, err := d.driver.Open(name) if err != nil { @@ -64,6 +68,6 @@ func (d *swSQLDriver) Open(name string) (driver.Conn, error) { return &conn{ conn: c, tracer: d.tracer, - attr: attr, + opts: d.opts, }, nil } diff --git a/sql/driver_test.go b/sql/driver_test.go index 2ac2c9d..5e362f8 100644 --- a/sql/driver_test.go +++ b/sql/driver_test.go @@ -40,7 +40,7 @@ func TestDriver(t *testing.T) { tracer, err := go2sky.NewTracer("test-driver", go2sky.WithReporter(re)) assert.NoError(t, err) - sql.Register("skywalking-sql", NewTracerDriver(mysqlDriver, tracer, MYSQL)) + sql.Register("skywalking-sql", NewTracerDriver(mysqlDriver, tracer, WithSqlDBType(MYSQL))) db, err := sql.Open("skywalking-sql", "user:password@tcp(127.0.0.1:3306)/testdb") assert.NoError(t, err) diff --git a/sql/options.go b/sql/options.go new file mode 100644 index 0000000..1a77882 --- /dev/null +++ b/sql/options.go @@ -0,0 +1,84 @@ +// Licensed to SkyAPM org under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. SkyAPM org 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 sql + +import ( + "regexp" +) + +type DBType string + +const ( + MYSQL DBType = "mysql" + IPV4 DBType = "others" +) + +type Option func(*options) + +type options struct { + dbType DBType + peer string + componentID int32 +} + +func WithSqlDBType(t DBType) Option { + return func(o *options) { + o.dbType = t + } +} + +func WithPeerAddr(addr string) Option { + return func(o *options) { + o.peer = addr + } +} + +func (o options) getOpName(op string) string { + switch o.dbType { + case MYSQL: + return "Mysql/Go2Sky/" + op + default: + return "Sql/Go2Sky/" + op + } +} + +// setPeerWithDsn parse dsn to a endpoint addr string (host:port) +func (o *options) setPeerWithDsn(dsn string) { + var addr string + switch o.dbType { + case MYSQL: + // [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN] + re := regexp.MustCompile(`\(.+\)`) + addr = re.FindString(dsn) + addr = addr[1 : len(addr)-1] + case IPV4: + // ipv4 addr + re := regexp.MustCompile(`((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})(\.((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})){3}:\d{1,5}`) + addr = re.FindString(dsn) + } + o.peer = addr +} + +func (o *options) setComponentID() { + switch o.dbType { + case MYSQL: + o.componentID = componentIDMysql + default: + o.componentID = componentIDUnknown + } +} diff --git a/sql/stmt.go b/sql/stmt.go index 2c44143..622cd32 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -29,10 +29,9 @@ type stmt struct { stmt driver.Stmt tracer *go2sky.Tracer + opts *options // query defines the statement query query string - // attr include some attributes need to report to OAP server - attr attribute } func (s *stmt) Close() error { @@ -52,13 +51,13 @@ func (s *stmt) Exec(args []driver.Value) (driver.Result, error) { // driver.StmtExecContext interface, this method // will use Exec instead. func (s *stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error) { - span, err := createSpan(ctx, s.tracer, s.attr, "execute") + span, err := createSpan(ctx, s.tracer, s.opts, "execute") if err != nil { return nil, err } defer span.End() - span.Tag(tagDbType, string(s.attr.dbType)) - span.Tag(tagDbInstance, s.attr.peer) + span.Tag(tagDbType, string(s.opts.dbType)) + span.Tag(tagDbInstance, s.opts.peer) span.Tag(tagDbStatement, s.query) if execerContext, ok := s.stmt.(driver.StmtExecContext); ok { @@ -81,13 +80,13 @@ func (s *stmt) Query(args []driver.Value) (driver.Rows, error) { // driver.StmtQueryContext interface, this method // will use Query instead. func (s *stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error) { - span, err := createSpan(ctx, s.tracer, s.attr, "query") + span, err := createSpan(ctx, s.tracer, s.opts, "query") if err != nil { return nil, err } defer span.End() - span.Tag(tagDbType, string(s.attr.dbType)) - span.Tag(tagDbInstance, s.attr.peer) + span.Tag(tagDbType, string(s.opts.dbType)) + span.Tag(tagDbInstance, s.opts.peer) span.Tag(tagDbStatement, s.query) if queryer, ok := s.stmt.(driver.StmtQueryContext); ok { diff --git a/sql/test/sql_plugin_test.yaml b/sql/test/sql_plugin_test.yaml new file mode 100644 index 0000000..e88a987 --- /dev/null +++ b/sql/test/sql_plugin_test.yaml @@ -0,0 +1,9 @@ + +setup: + env: compose + file: docker-compose.yml + timeout: 1200 + +cleanup: + # always never success failure + on: always \ No newline at end of file From 78b5c971d1fbee27a548816b57e9882210078431 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Tue, 20 Jul 2021 14:32:36 +0800 Subject: [PATCH 10/26] add query & param report options --- sql/common.go | 6 +++--- sql/conn.go | 14 ++++++++++++-- sql/driver.go | 2 ++ sql/driver_test.go | 2 +- sql/options.go | 20 ++++++++++++++++++++ sql/stmt.go | 14 ++++++++++++-- 6 files changed, 50 insertions(+), 8 deletions(-) diff --git a/sql/common.go b/sql/common.go index 8e7c173..a3e5004 100644 --- a/sql/common.go +++ b/sql/common.go @@ -48,11 +48,11 @@ func emptyInjectFunc(key, value string) error { return nil } // namedValueToValueString converts driver arguments of NamedValue format to Value string format. func namedValueToValueString(named []driver.NamedValue) string { - b := strings.Builder{} + b := make([]string, 0, len(named)) for _, param := range named { - b.WriteString(fmt.Sprintf("%v,", param.Value)) + b = append(b, fmt.Sprintf("%v", param.Value)) } - return b.String() + return strings.Join(b, ",") } // namedValueToValue converts driver arguments of NamedValue format to Value format. diff --git a/sql/conn.go b/sql/conn.go index 88003a2..71344a4 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -138,7 +138,12 @@ func (c *conn) ExecContext(ctx context.Context, query string, args []driver.Name defer span.End() span.Tag(tagDbType, string(c.opts.dbType)) span.Tag(tagDbInstance, c.opts.peer) - span.Tag(tagDbStatement, query) + if c.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if c.opts.reportParam { + span.Tag(tagDbSqlParameters, namedValueToValueString(args)) + } if execerContext, ok := c.conn.(driver.ExecerContext); ok { return execerContext.ExecContext(ctx, query, args) @@ -171,7 +176,12 @@ func (c *conn) QueryContext(ctx context.Context, query string, args []driver.Nam defer span.End() span.Tag(tagDbType, string(c.opts.dbType)) span.Tag(tagDbInstance, c.opts.peer) - span.Tag(tagDbStatement, query) + if c.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if c.opts.reportParam { + span.Tag(tagDbSqlParameters, namedValueToValueString(args)) + } if queryerContext, ok := c.conn.(driver.QueryerContext); ok { return queryerContext.QueryContext(ctx, query, args) diff --git a/sql/driver.go b/sql/driver.go index 6b87e1f..468196d 100644 --- a/sql/driver.go +++ b/sql/driver.go @@ -32,6 +32,8 @@ type go2SkySQLDriver struct { opts *options } +// NewTracerDriver return a driver wrapper with go2sky tracer, +// Options include: WithSqlDBType, WithPeerAddr, WithQueryReport, WithParamReport func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer, opts ...Option) driver.Driver { options := &options{ dbType: IPV4, diff --git a/sql/driver_test.go b/sql/driver_test.go index 5e362f8..bf59552 100644 --- a/sql/driver_test.go +++ b/sql/driver_test.go @@ -40,7 +40,7 @@ func TestDriver(t *testing.T) { tracer, err := go2sky.NewTracer("test-driver", go2sky.WithReporter(re)) assert.NoError(t, err) - sql.Register("skywalking-sql", NewTracerDriver(mysqlDriver, tracer, WithSqlDBType(MYSQL))) + sql.Register("skywalking-sql", NewTracerDriver(mysqlDriver, tracer, WithSqlDBType(MYSQL), WithQueryReport())) db, err := sql.Open("skywalking-sql", "user:password@tcp(127.0.0.1:3306)/testdb") assert.NoError(t, err) diff --git a/sql/options.go b/sql/options.go index 1a77882..e2cc847 100644 --- a/sql/options.go +++ b/sql/options.go @@ -34,20 +34,40 @@ type options struct { dbType DBType peer string componentID int32 + + reportQuery bool + reportParam bool } +// WithSqlDBType set dbType option, +// dbType is used for parsing dsn string to peer address +// and setting componentID, if DB type is not support in DBType +// list, please use WithPeerAddr to set peer address manually func WithSqlDBType(t DBType) Option { return func(o *options) { o.dbType = t } } +// WithPeerAddr set the peer address to report func WithPeerAddr(addr string) Option { return func(o *options) { o.peer = addr } } +func WithQueryReport() Option { + return func(o *options) { + o.reportQuery = true + } +} + +func WithParamReport() Option { + return func(o *options) { + o.reportParam = true + } +} + func (o options) getOpName(op string) string { switch o.dbType { case MYSQL: diff --git a/sql/stmt.go b/sql/stmt.go index 622cd32..a835712 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -58,7 +58,12 @@ func (s *stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (drive defer span.End() span.Tag(tagDbType, string(s.opts.dbType)) span.Tag(tagDbInstance, s.opts.peer) - span.Tag(tagDbStatement, s.query) + if s.opts.reportQuery { + span.Tag(tagDbStatement, s.query) + } + if s.opts.reportParam { + span.Tag(tagDbSqlParameters, namedValueToValueString(args)) + } if execerContext, ok := s.stmt.(driver.StmtExecContext); ok { return execerContext.ExecContext(ctx, args) @@ -87,7 +92,12 @@ func (s *stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driv defer span.End() span.Tag(tagDbType, string(s.opts.dbType)) span.Tag(tagDbInstance, s.opts.peer) - span.Tag(tagDbStatement, s.query) + if s.opts.reportQuery { + span.Tag(tagDbStatement, s.query) + } + if s.opts.reportParam { + span.Tag(tagDbSqlParameters, namedValueToValueString(args)) + } if queryer, ok := s.stmt.(driver.StmtQueryContext); ok { return queryer.QueryContext(ctx, args) From e12962c95718c9133b63dde91e6e05533f5ae7f1 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Tue, 20 Jul 2021 22:34:35 +0800 Subject: [PATCH 11/26] init e2e test file --- sql/README.md | 3 +- sql/driver_test.go | 68 ----------------------------------- sql/test/Dockerfile.client | 10 ++++++ sql/test/client.go | 60 +++++++++++++++++++++++++++++++ sql/test/docker-compose.yaml | 57 +++++++++++++++++++++++++++++ sql/test/expected.data.yaml | 0 sql/test/sql_plugin_test.yaml | 16 ++++++++- 7 files changed, 144 insertions(+), 70 deletions(-) delete mode 100644 sql/driver_test.go create mode 100644 sql/test/Dockerfile.client create mode 100644 sql/test/client.go create mode 100644 sql/test/docker-compose.yaml create mode 100644 sql/test/expected.data.yaml diff --git a/sql/README.md b/sql/README.md index 58f36ae..3b3f92d 100644 --- a/sql/README.md +++ b/sql/README.md @@ -14,6 +14,7 @@ import ( "github.com/SkyAPM/go2sky" "github.com/SkyAPM/go2sky/reporter" + swsql "github.com/SkyAPM/go2sky-plugins/sql" "github.com/go-sql-driver/mysql" ) @@ -25,7 +26,7 @@ defer re.Close() tracer, err := go2sky.NewTracer("service-name", go2sky.WithReporter(re)) // register go2sky sql wrapper -sql.Register("skywalking-sql", NewTracerDriver(&mysql.MySQLDriver{}, tracer, MYSQL)) +sql.Register("skywalking-sql", swsql.NewTracerDriver(&mysql.MySQLDriver{}, tracer, swsql.WithSqlDBType(swsql.MYSQL), swsql.WithQueryReport())) db, err := sql.Open("skywalking-sql", "user:password@tcp(127.0.0.1:3306)/dbname") // use db handle as usual. diff --git a/sql/driver_test.go b/sql/driver_test.go deleted file mode 100644 index bf59552..0000000 --- a/sql/driver_test.go +++ /dev/null @@ -1,68 +0,0 @@ -// Licensed to SkyAPM org under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. SkyAPM org 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 sql - -import ( - "context" - "database/sql" - "testing" - - "github.com/SkyAPM/go2sky" - "github.com/SkyAPM/go2sky/reporter" - "github.com/go-sql-driver/mysql" - "github.com/stretchr/testify/assert" -) - -func TestDriver(t *testing.T) { - // init driver - mysqlDriver := &mysql.MySQLDriver{} - - // init tracer - re, err := reporter.NewLogReporter() - assert.NoError(t, err) - defer re.Close() - - tracer, err := go2sky.NewTracer("test-driver", go2sky.WithReporter(re)) - assert.NoError(t, err) - - sql.Register("skywalking-sql", NewTracerDriver(mysqlDriver, tracer, WithSqlDBType(MYSQL), WithQueryReport())) - db, err := sql.Open("skywalking-sql", "user:password@tcp(127.0.0.1:3306)/testdb") - assert.NoError(t, err) - - span, ctx, err := tracer.CreateLocalSpan(context.Background()) - assert.NoError(t, err) - defer span.End() - - _, err = db.ExecContext(ctx, `CREATE TABLE test (id char(255), name VARCHAR(255), age INTEGER)`) - assert.NoError(t, err) - - // test insert - _, err = db.ExecContext(ctx, - `INSERT INTO test (id, name, age, datetime) VALUE ( ?, ?, ?)`, - "0", "foo", 10) - assert.NoError(t, err) - - var name string - // test select - err = db.QueryRowContext(ctx, - `SELECT * FROM test WHERE id = ?`, - "1").Scan(&name) - assert.NoError(t, err) - assert.Equal(t, "foo", name) - -} diff --git a/sql/test/Dockerfile.client b/sql/test/Dockerfile.client new file mode 100644 index 0000000..63360aa --- /dev/null +++ b/sql/test/Dockerfile.client @@ -0,0 +1,10 @@ +FROM golang:1.16 + +ADD . /go2sky +WORKDIR /go2sky + +EXPOSE 8080 + +ENTRYPOINT ["go"] + +CMD ["run", "test/client.go"] diff --git a/sql/test/client.go b/sql/test/client.go new file mode 100644 index 0000000..f186efc --- /dev/null +++ b/sql/test/client.go @@ -0,0 +1,60 @@ +package main + +import ( + "context" + "database/sql" + "log" + + swsql "sql" + + "github.com/SkyAPM/go2sky" + "github.com/SkyAPM/go2sky/reporter" + "github.com/go-sql-driver/mysql" +) + +const ( + oap = "mockoap:19876" + service = "sql-client" + dsn = "user:password@tcp(127.0.0.1:3306)/database" +) + +func main() { + // init driver + mysqlDriver := &mysql.MySQLDriver{} + + // init tracer + re, err := reporter.NewGRPCReporter(oap) + if err != nil { + log.Fatalf("create grpc reporter error: %v \n", err) + } + + tracer, err := go2sky.NewTracer(service, go2sky.WithReporter(re)) + if err != nil { + log.Fatalf("crate tracer error: %v \n", err) + } + + sql.Register("skywalking-sql", swsql.NewTracerDriver(mysqlDriver, tracer, swsql.WithSqlDBType(swsql.MYSQL), swsql.WithQueryReport())) + db, err := sql.Open("skywalking-sql", dsn) + if err != nil { + log.Fatalf("open db error: %v \n", err) + } + + span, ctx, err := tracer.CreateLocalSpan(context.Background()) + if err != nil { + log.Fatalf("create span error: %v \n", err) + } + defer span.End() + + _, err = db.ExecContext(ctx, `CREATE TABLE test (id char(255), name VARCHAR(255), age INTEGER)`) + + // test insert + _, err = db.ExecContext(ctx, + `INSERT INTO test (id, name, age, datetime) VALUE ( ?, ?, ?)`, + "0", "foo", 10) + + var name string + // test select + err = db.QueryRowContext(ctx, + `SELECT name FROM test WHERE id = ?`, + "1").Scan(&name) +} diff --git a/sql/test/docker-compose.yaml b/sql/test/docker-compose.yaml new file mode 100644 index 0000000..90cfbf7 --- /dev/null +++ b/sql/test/docker-compose.yaml @@ -0,0 +1,57 @@ +version: '2.1' + +services: + mockoap: + image: ghcr.io/apache/skywalking-agent-test-tool/mock-collector:b01d4137fed862338d78a73b23435ccf425f9962 + expose: + - 19876 + - 12800 + ports: + - 19876 + - 12800 + networks: + - e2e + restart: on-failure + healthcheck: + test: [ "CMD", "curl", "http://127.0.0.1:12800/healthCheck" ] + interval: 5s + timeout: 60s + retries: 120 + mysql: + image: mysql:8.0 + networks: + - e2e + expose: + - 3306 + environment: + MYSQL_ALLOW_EMPTY_PASSWORD: "yes" + MYSQL_USER: "user" + MYSQL_PASSWORD: "password" + MYSQL_DATABASE: "database" + healthcheck: + test: [ "CMD", "mysqladmin" ,"ping", "-h", "localhost" ] + timeout: 20s + retries: 10 + client: + build: + context: ../ + dockerfile: ./test/Dockerfile.client + networks: + - e2e + expose: + - 8080 + ports: + - 8080 + healthcheck: + test: ["CMD", "curl", "http://127.0.0.1:8080/healthCheck"] + interval: 5s + timeout: 20s + retries: 10 + depends_on: + mockoap: + condition: service_healthy + mysql: + condition: service_healthy + +networks: + e2e: \ No newline at end of file diff --git a/sql/test/expected.data.yaml b/sql/test/expected.data.yaml new file mode 100644 index 0000000..e69de29 diff --git a/sql/test/sql_plugin_test.yaml b/sql/test/sql_plugin_test.yaml index e88a987..35cfc63 100644 --- a/sql/test/sql_plugin_test.yaml +++ b/sql/test/sql_plugin_test.yaml @@ -6,4 +6,18 @@ setup: cleanup: # always never success failure - on: always \ No newline at end of file + on: always + +trigger: + action: + +verify: + # verify with retry strategy + retry: + # max retry count + count: 10 + # the interval between two retries, in millisecond. + interval: 10000 + cases: + - query: curl http://127.0.0.1:${mockoap_12800}/receiveData + expected: expected.data.yml \ No newline at end of file From 495a9bdc9f61ec79652dec97d9dd3aa1614e4a79 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Wed, 21 Jul 2021 18:17:40 +0800 Subject: [PATCH 12/26] add expected.data.yaml & sql test client --- sql/README.md | 4 +- sql/conn.go | 14 +++- sql/test/Dockerfile.client | 17 ++++ sql/test/client.go | 141 ++++++++++++++++++++++++++++++---- sql/test/docker-compose.yaml | 29 ++++++- sql/test/expected.data.yaml | 115 +++++++++++++++++++++++++++ sql/test/sql_plugin_test.yaml | 20 ++++- sql/tx.go | 2 + 8 files changed, 321 insertions(+), 21 deletions(-) diff --git a/sql/README.md b/sql/README.md index 3b3f92d..34d8546 100644 --- a/sql/README.md +++ b/sql/README.md @@ -14,7 +14,7 @@ import ( "github.com/SkyAPM/go2sky" "github.com/SkyAPM/go2sky/reporter" - swsql "github.com/SkyAPM/go2sky-plugins/sql" + sqlPlugin "github.com/SkyAPM/go2sky-plugins/sql" "github.com/go-sql-driver/mysql" ) @@ -26,7 +26,7 @@ defer re.Close() tracer, err := go2sky.NewTracer("service-name", go2sky.WithReporter(re)) // register go2sky sql wrapper -sql.Register("skywalking-sql", swsql.NewTracerDriver(&mysql.MySQLDriver{}, tracer, swsql.WithSqlDBType(swsql.MYSQL), swsql.WithQueryReport())) +sql.Register("skywalking-sql", sqlPlugin.NewTracerDriver(&mysql.MySQLDriver{}, tracer, sqlPlugin.WithSqlDBType(sqlPlugin.MYSQL), sqlPlugin.WithQueryReport())) db, err := sql.Open("skywalking-sql", "user:password@tcp(127.0.0.1:3306)/dbname") // use db handle as usual. diff --git a/sql/conn.go b/sql/conn.go index 71344a4..ee33977 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -105,6 +105,9 @@ func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, e if err != nil { return nil, err } + span.Tag(tagDbType, string(c.opts.dbType)) + span.Tag(tagDbInstance, c.opts.peer) + if connBeginTx, ok := c.conn.(driver.ConnBeginTx); ok { t, err := connBeginTx.BeginTx(ctx, opts) if err != nil { @@ -115,7 +118,16 @@ func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, e span: span, }, nil } - return c.Begin() + + t, err := c.Begin() + if err != nil { + return nil, err + } + + return &tx{ + tx: t, + span: span, + }, nil } // Exec implements driver.Execer Exec diff --git a/sql/test/Dockerfile.client b/sql/test/Dockerfile.client index 63360aa..e98dd5b 100644 --- a/sql/test/Dockerfile.client +++ b/sql/test/Dockerfile.client @@ -1,3 +1,20 @@ +# Licensed to SkyAPM org under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. SkyAPM org 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. + FROM golang:1.16 ADD . /go2sky diff --git a/sql/test/client.go b/sql/test/client.go index f186efc..5cdf85e 100644 --- a/sql/test/client.go +++ b/sql/test/client.go @@ -1,21 +1,43 @@ +// Licensed to SkyAPM org under one or more contributor +// license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright +// ownership. SkyAPM org 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 main import ( "context" "database/sql" + "fmt" "log" + "net/http" - swsql "sql" + sqlPlugin "sql" "github.com/SkyAPM/go2sky" "github.com/SkyAPM/go2sky/reporter" "github.com/go-sql-driver/mysql" ) +type testFunc func(context.Context, *sql.DB) error + const ( oap = "mockoap:19876" service = "sql-client" - dsn = "user:password@tcp(127.0.0.1:3306)/database" + dsn = "user:password@tcp(mysql:3306)/database" + addr = ":8080" ) func main() { @@ -33,28 +55,121 @@ func main() { log.Fatalf("crate tracer error: %v \n", err) } - sql.Register("skywalking-sql", swsql.NewTracerDriver(mysqlDriver, tracer, swsql.WithSqlDBType(swsql.MYSQL), swsql.WithQueryReport())) + sql.Register("skywalking-sql", sqlPlugin.NewTracerDriver(mysqlDriver, tracer, + sqlPlugin.WithSqlDBType(sqlPlugin.MYSQL), + sqlPlugin.WithQueryReport(), + sqlPlugin.WithParamReport())) db, err := sql.Open("skywalking-sql", dsn) if err != nil { log.Fatalf("open db error: %v \n", err) } - span, ctx, err := tracer.CreateLocalSpan(context.Background()) + route := http.NewServeMux() + route.HandleFunc("/healthCheck", func(res http.ResponseWriter, req *http.Request) { + _, _ = res.Write([]byte("Success")) + }) + route.HandleFunc("/execute", func(res http.ResponseWriter, req *http.Request) { + tests := []struct { + name string + fn testFunc + }{ + {"exec", TestExec}, + {"stmt", TestStmt}, + {"commitTx", TestCommitTx}, + {"rollbackTx", TestRollbackTx}, + } + + span, ctx, err := tracer.CreateLocalSpan(context.Background()) + if err != nil { + log.Fatalf("create span error: %v \n", err) + } + defer span.End() + + for _, test := range tests { + if err := test.fn(ctx, db); err != nil { + log.Fatalf("test case %s failed: %v", test.name, err) + } + } + _, _ = res.Write([]byte("Execute sql success")) + }) + + log.Println("start client") + err = http.ListenAndServe(addr, route) if err != nil { - log.Fatalf("create span error: %v \n", err) + log.Fatalf("client start error: %v \n", err) } - defer span.End() +} - _, err = db.ExecContext(ctx, `CREATE TABLE test (id char(255), name VARCHAR(255), age INTEGER)`) +func TestExec(ctx context.Context, db *sql.DB) error { + if err := db.PingContext(ctx); err != nil { + return err + } + + if _, err := db.ExecContext(ctx, `DROP TABLE IF EXISTS users`); err != nil { + return fmt.Errorf("exec drop error: %w", err) + } + + if _, err := db.ExecContext(ctx, `CREATE TABLE IF NOT EXISTS users (id char(255), name VARCHAR(255), age INTEGER)`); err != nil { + return fmt.Errorf("exec create error: %w", err) + } // test insert - _, err = db.ExecContext(ctx, - `INSERT INTO test (id, name, age, datetime) VALUE ( ?, ?, ?)`, - "0", "foo", 10) + if _, err := db.ExecContext(ctx, `INSERT INTO users (id, name, age) VALUE ( ?, ?, ?)`, "0", "foo", 10); err != nil { + return fmt.Errorf("exec insert error: %w", err) + } var name string // test select - err = db.QueryRowContext(ctx, - `SELECT name FROM test WHERE id = ?`, - "1").Scan(&name) + if err := db.QueryRowContext(ctx, `SELECT name FROM users WHERE id = ?`, "0").Scan(&name); err != nil { + return fmt.Errorf("query select error: %w", err) + } + + return nil +} + +func TestStmt(ctx context.Context, db *sql.DB) error { + stmt, err := db.PrepareContext(ctx, `INSERT INTO users (id, name, age) VALUE ( ?, ?, ?)`) + if err != nil { + return err + } + defer stmt.Close() + + _, err = stmt.ExecContext(ctx, "1", "bar", 11) + if err != nil { + return err + } + + return nil +} + +func TestCommitTx(ctx context.Context, db *sql.DB) error { + tx, err := db.BeginTx(ctx, nil) + if err != nil { + return fmt.Errorf("begin tx error: %v \n", err) + } + + if _, err := tx.ExecContext(ctx, `UPDATE users SET name = ? WHERE id = ?`, "foobar", "0"); err != nil { + return err + } + + if err := tx.Commit(); err != nil { + return err + } + return nil +} + +func TestRollbackTx(ctx context.Context, db *sql.DB) error { + tx, err := db.BeginTx(ctx, nil) + if err != nil { + return fmt.Errorf("begin tx error: %v \n", err) + } + + if _, err := tx.ExecContext(ctx, `UPDATE users SET name = ? WHERE id = ?`, "foobar", "1"); err != nil { + return err + } + + if err := tx.Rollback(); err != nil { + return err + } + return nil } diff --git a/sql/test/docker-compose.yaml b/sql/test/docker-compose.yaml index 90cfbf7..b62e473 100644 --- a/sql/test/docker-compose.yaml +++ b/sql/test/docker-compose.yaml @@ -1,3 +1,20 @@ +# Licensed to SkyAPM org under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. SkyAPM org 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. + version: '2.1' services: @@ -8,21 +25,23 @@ services: - 12800 ports: - 19876 - - 12800 + - 12800:12800 networks: - e2e restart: on-failure healthcheck: test: [ "CMD", "curl", "http://127.0.0.1:12800/healthCheck" ] interval: 5s - timeout: 60s - retries: 120 + timeout: 20s + retries: 10 mysql: image: mysql:8.0 networks: - e2e expose: - 3306 + ports: + - 3306:3306 environment: MYSQL_ALLOW_EMPTY_PASSWORD: "yes" MYSQL_USER: "user" @@ -41,7 +60,9 @@ services: expose: - 8080 ports: - - 8080 + - 8080:8080 + environment: + GOPROXY: "https://goproxy.io" healthcheck: test: ["CMD", "curl", "http://127.0.0.1:8080/healthCheck"] interval: 5s diff --git a/sql/test/expected.data.yaml b/sql/test/expected.data.yaml index e69de29..5f6615a 100644 --- a/sql/test/expected.data.yaml +++ b/sql/test/expected.data.yaml @@ -0,0 +1,115 @@ +# Licensed to SkyAPM org under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. SkyAPM org 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. + +segmentItems: + {{- range .segmentItems }} + - serviceName: sql-client + segmentSize: {{ gt .segmentSize 0 } + segments: + {{- range .segments }} + - segmentId: {{ notEmpty .segmentId } + spans: + {{- range spans }} + {{- if eq .operationName "Mysql/Go2Sky/connect" }} + - operationName: Mysql/Go2Sky/connect + operationId: 0 + parentSpanId: 0 + spanId: 1 + spanLayer: Database + startTime: {{ gt .startTime 0 }} + endTime: {{ gt .endTime 0 }} + componentId: 5010 + isError: false + spanType: Exit + peer: mysql:3306 + skipAnalysis: false + tags: + - {key: db.type, value: mysql} + - {key: db.instance, value: 'mysql:3306'} + {{- end }} + {{- if eq .operationName "Mysql/Go2Sky/ping" }} + - operationName: Mysql/Go2Sky/ping + operationId: 0 + parentSpanId: 0 + spanId: 2, + spanLayer: Database + startTime: {{ gt .startTime 0 }} + endTime: {{ gt .endTime 0 }} + componentId: 5010 + isError: false + spanType: Exit + peer: 'mysql:3306' + skipAnalysis: false + {{- end }} + {{- if eq .operationName "Mysql/Go2Sky/execute" }} + - operationName: Mysql/Go2Sky/execute + operationId: 0 + parentSpanId: 0 + spanId: {{ notEmpty .spanId }} + spanLayer: Database + startTime: {{ gt .startTime 0 }} + endTime: {{ gt .endTime 0 }} + componentId: 5010 + isError: false + spanType: Exit + peer: mysql:3306 + skipAnalysis: false + tags: + - {key: db.type, value: mysql} + - {key: db.instance, value: 'mysql:3306'} + - {key: db.statement, value: {{ notEmpty (index .tags 2).value}}} + {{- end }} + {{- if eq .operationName "Mysql/Go2Sky/query"}} + - operationName: Mysql/Go2Sky/query + operationId: 0 + parentSpanId: 0 + spanId: {{ notEmpty .spanId }} + spanLayer: Database + startTime: {{ gt .startTime 0 }} + endTime: {{ gt .endTime 0 }} + componentId: 5010 + isError: false + spanType: Exit + peer: mysql:3306 + skipAnalysis: false + tags: + - {key: db.type, value: mysql} + - {key: db.instance, value: 'mysql:3306'} + - {key: db.statement, value: {{ notEmpty (index .tags 2).value}}} + {{- end }} + {{- if eq .operationName "Mysql/Go2Sky/beginTransaction" }} + - operationName: Mysql/Go2Sky/beginTransaction + operationId: 0 + parentSpanId: 0 + spanId: {{ notEmpty .spanId }} + spanLayer: Database + startTime: {{ gt .startTime 0 }} + endTime: {{ gt .endTime 0 }} + componentId: 5010 + isError: false + spanType: Exit + peer: mysql:3306 + skipAnalysis: false + tags: + - {key: db.type, value: mysql} + - {key: db.instance, value: 'mysql:3306'} + - {key: db.statement, value: {{ notEmpty (index .tags 2).value}}} + {{- end }} + {{- end }} + {{- end }} + {{- end }} +meterItems: [] \ No newline at end of file diff --git a/sql/test/sql_plugin_test.yaml b/sql/test/sql_plugin_test.yaml index 35cfc63..67a94eb 100644 --- a/sql/test/sql_plugin_test.yaml +++ b/sql/test/sql_plugin_test.yaml @@ -1,3 +1,19 @@ +# Licensed to SkyAPM org under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. SkyAPM org 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. setup: env: compose @@ -9,7 +25,9 @@ cleanup: on: always trigger: - action: + action: http + url: http://127.0.0.1:${client_8080}/execute + method: GET verify: # verify with retry strategy diff --git a/sql/tx.go b/sql/tx.go index 9b113ea..e0544f1 100644 --- a/sql/tx.go +++ b/sql/tx.go @@ -31,6 +31,7 @@ type tx struct { func (t *tx) Commit() error { if t.span != nil { + t.span.Tag(tagDbStatement, "commit") defer t.span.End() } return t.tx.Commit() @@ -38,6 +39,7 @@ func (t *tx) Commit() error { func (t *tx) Rollback() error { if t.span != nil { + t.span.Tag(tagDbStatement, "rollback") defer t.span.End() } return t.tx.Rollback() From 2e21a0d5805fcf12e2afe13aa01a62589044d524 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Fri, 30 Jul 2021 11:14:22 +0800 Subject: [PATCH 13/26] update license header --- sql/common.go | 25 ++++++++++++------------- sql/conn.go | 25 ++++++++++++------------- sql/connector.go | 25 ++++++++++++------------- sql/doc.go | 25 ++++++++++++------------- sql/driver.go | 25 ++++++++++++------------- sql/options.go | 25 ++++++++++++------------- sql/stmt.go | 25 ++++++++++++------------- sql/test/Dockerfile.client | 25 ++++++++++++------------- sql/test/client.go | 25 ++++++++++++------------- sql/test/docker-compose.yaml | 25 ++++++++++++------------- sql/test/expected.data.yaml | 25 ++++++++++++------------- sql/test/sql_plugin_test.yaml | 25 ++++++++++++------------- sql/tx.go | 25 ++++++++++++------------- 13 files changed, 156 insertions(+), 169 deletions(-) diff --git a/sql/common.go b/sql/common.go index a3e5004..8186242 100644 --- a/sql/common.go +++ b/sql/common.go @@ -1,19 +1,18 @@ -// Licensed to SkyAPM org under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. SkyAPM org 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. +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 +// 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. // -// 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 sql diff --git a/sql/conn.go b/sql/conn.go index ee33977..146b63c 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -1,19 +1,18 @@ -// Licensed to SkyAPM org under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. SkyAPM org 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. +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 +// 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. // -// 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 sql diff --git a/sql/connector.go b/sql/connector.go index 81d378f..e7590d0 100644 --- a/sql/connector.go +++ b/sql/connector.go @@ -1,19 +1,18 @@ -// Licensed to SkyAPM org under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. SkyAPM org 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. +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 +// 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. // -// 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 sql diff --git a/sql/doc.go b/sql/doc.go index 45b0086..fe2d976 100644 --- a/sql/doc.go +++ b/sql/doc.go @@ -1,19 +1,18 @@ -// Licensed to SkyAPM org under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. SkyAPM org 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. +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 +// 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. // -// 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 sql is a plugin that can be used to trace database/sql. package sql diff --git a/sql/driver.go b/sql/driver.go index 468196d..21444ce 100644 --- a/sql/driver.go +++ b/sql/driver.go @@ -1,19 +1,18 @@ -// Licensed to SkyAPM org under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. SkyAPM org 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. +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 +// 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. // -// 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 sql diff --git a/sql/options.go b/sql/options.go index e2cc847..974a985 100644 --- a/sql/options.go +++ b/sql/options.go @@ -1,19 +1,18 @@ -// Licensed to SkyAPM org under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. SkyAPM org 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. +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 +// 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. // -// 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 sql diff --git a/sql/stmt.go b/sql/stmt.go index a835712..9921131 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -1,19 +1,18 @@ -// Licensed to SkyAPM org under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. SkyAPM org 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. +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 +// 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. // -// 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 sql diff --git a/sql/test/Dockerfile.client b/sql/test/Dockerfile.client index e98dd5b..ff5112a 100644 --- a/sql/test/Dockerfile.client +++ b/sql/test/Dockerfile.client @@ -1,19 +1,18 @@ -# Licensed to SkyAPM org under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. SkyAPM org 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. +# +# Copyright 2021 SkyAPM org +# +# Licensed 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 +# 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. # -# 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. FROM golang:1.16 diff --git a/sql/test/client.go b/sql/test/client.go index 5cdf85e..55221ae 100644 --- a/sql/test/client.go +++ b/sql/test/client.go @@ -1,19 +1,18 @@ -// Licensed to SkyAPM org under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. SkyAPM org 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. +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 +// 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. // -// 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 main diff --git a/sql/test/docker-compose.yaml b/sql/test/docker-compose.yaml index b62e473..14d65c1 100644 --- a/sql/test/docker-compose.yaml +++ b/sql/test/docker-compose.yaml @@ -1,19 +1,18 @@ -# Licensed to SkyAPM org under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. SkyAPM org 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. +# +# Copyright 2021 SkyAPM org +# +# Licensed 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 +# 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. # -# 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. version: '2.1' diff --git a/sql/test/expected.data.yaml b/sql/test/expected.data.yaml index 5f6615a..d4dc7e3 100644 --- a/sql/test/expected.data.yaml +++ b/sql/test/expected.data.yaml @@ -1,19 +1,18 @@ -# Licensed to SkyAPM org under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. SkyAPM org 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. +# +# Copyright 2021 SkyAPM org +# +# Licensed 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 +# 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. +# 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. +#. segmentItems: {{- range .segmentItems }} diff --git a/sql/test/sql_plugin_test.yaml b/sql/test/sql_plugin_test.yaml index 67a94eb..668a4a3 100644 --- a/sql/test/sql_plugin_test.yaml +++ b/sql/test/sql_plugin_test.yaml @@ -1,19 +1,18 @@ -# Licensed to SkyAPM org under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. SkyAPM org 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. +# +# Copyright 2021 SkyAPM org +# +# Licensed 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 +# 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. # -# 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. setup: env: compose diff --git a/sql/tx.go b/sql/tx.go index e0544f1..35564f4 100644 --- a/sql/tx.go +++ b/sql/tx.go @@ -1,19 +1,18 @@ -// Licensed to SkyAPM org under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. SkyAPM org 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. +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 +// 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. // -// 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 sql From 8b58378e6bba7164dc29263594d14d9d14597f9b Mon Sep 17 00:00:00 2001 From: Kagaya Date: Wed, 4 Aug 2021 15:33:18 +0800 Subject: [PATCH 14/26] fix: duplicate span reporting when using conn.ExecContext & conn.QueryContext --- sql/conn.go | 33 +++++++++++++++++++++++++-------- sql/connector.go | 2 +- sql/test/docker-compose.yaml | 2 +- 3 files changed, 27 insertions(+), 10 deletions(-) diff --git a/sql/conn.go b/sql/conn.go index 146b63c..0043e9a 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -40,8 +40,11 @@ func (c *conn) Ping(ctx context.Context) error { if err != nil { return err } - defer span.End() - return pinger.Ping(ctx) + err = pinger.Ping(ctx) + if err == nil { + span.End() + } + return err } return ErrUnsupportedOp } @@ -146,7 +149,6 @@ func (c *conn) ExecContext(ctx context.Context, query string, args []driver.Name if err != nil { return nil, err } - defer span.End() span.Tag(tagDbType, string(c.opts.dbType)) span.Tag(tagDbInstance, c.opts.peer) if c.opts.reportQuery { @@ -157,14 +159,22 @@ func (c *conn) ExecContext(ctx context.Context, query string, args []driver.Name } if execerContext, ok := c.conn.(driver.ExecerContext); ok { - return execerContext.ExecContext(ctx, query, args) + res, err := execerContext.ExecContext(ctx, query, args) + if err == nil { + span.End() + } + return res, err } values, err := namedValueToValue(args) if err != nil { return nil, err } - return c.Exec(query, values) + res, err := c.Exec(query, values) + if err == nil { + span.End() + } + return res, err } // Query implements driver.Queryer Query @@ -184,7 +194,6 @@ func (c *conn) QueryContext(ctx context.Context, query string, args []driver.Nam if err != nil { return nil, err } - defer span.End() span.Tag(tagDbType, string(c.opts.dbType)) span.Tag(tagDbInstance, c.opts.peer) if c.opts.reportQuery { @@ -195,12 +204,20 @@ func (c *conn) QueryContext(ctx context.Context, query string, args []driver.Nam } if queryerContext, ok := c.conn.(driver.QueryerContext); ok { - return queryerContext.QueryContext(ctx, query, args) + row, err := queryerContext.QueryContext(ctx, query, args) + if err == nil { + span.End() + } + return row, err } values, err := namedValueToValue(args) if err != nil { return nil, err } - return c.Query(query, values) + row, err := c.Query(query, values) + if err == nil { + span.End() + } + return row, err } diff --git a/sql/connector.go b/sql/connector.go index e7590d0..510829f 100644 --- a/sql/connector.go +++ b/sql/connector.go @@ -35,7 +35,6 @@ func (ct *connector) Connect(ctx context.Context) (driver.Conn, error) { if err != nil { return nil, err } - defer span.End() span.Tag(tagDbType, string(ct.opts.dbType)) span.Tag(tagDbInstance, ct.opts.peer) @@ -43,6 +42,7 @@ func (ct *connector) Connect(ctx context.Context) (driver.Conn, error) { if err != nil { return nil, err } + span.End() return &conn{ conn: c, tracer: ct.tracer, diff --git a/sql/test/docker-compose.yaml b/sql/test/docker-compose.yaml index 14d65c1..074c2ec 100644 --- a/sql/test/docker-compose.yaml +++ b/sql/test/docker-compose.yaml @@ -23,7 +23,7 @@ services: - 19876 - 12800 ports: - - 19876 + - 19876:19876 - 12800:12800 networks: - e2e From 176bf7cf34d107c4fcd31ef3a1f922a9c590d494 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Thu, 5 Aug 2021 16:33:49 +0800 Subject: [PATCH 15/26] rename module name --- sql/go.mod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sql/go.mod b/sql/go.mod index 9b5dd56..cf69363 100644 --- a/sql/go.mod +++ b/sql/go.mod @@ -1,4 +1,4 @@ -module sql +module github.com/SkyAPM/go2sky-plugins/sql go 1.16 From 30b6581f98efc0e02d5fcd8c0b6da4203fba4760 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Tue, 10 Aug 2021 15:11:31 +0800 Subject: [PATCH 16/26] update error handle --- sql/common.go | 17 +++++++--- sql/conn.go | 31 ++++++++++--------- sql/connector.go | 5 ++- sql/go.mod | 16 +++++----- sql/go.sum | 25 +++++++++------ sql/stmt.go | 30 +++++++++++++++--- sql/test/client.go | 11 ++++--- ...docker-compose.yaml => docker-compose.yml} | 0 .../{expected.data.yaml => expected.data.yml} | 24 +++++++------- sql/test/sql_plugin_test.yaml | 2 ++ 10 files changed, 103 insertions(+), 58 deletions(-) rename sql/test/{docker-compose.yaml => docker-compose.yml} (100%) rename sql/test/{expected.data.yaml => expected.data.yml} (89%) diff --git a/sql/common.go b/sql/common.go index 8186242..92a2573 100644 --- a/sql/common.go +++ b/sql/common.go @@ -22,6 +22,7 @@ import ( "errors" "fmt" "strings" + "time" "github.com/SkyAPM/go2sky" agentv3 "skywalking.apache.org/repo/goapi/collect/language/agent/v3" @@ -29,8 +30,7 @@ import ( const ( componentIDUnknown = 0 - componentIDMysql = 5010 - componentIDSqlite = 5011 + componentIDMysql = 5012 ) const ( @@ -42,9 +42,6 @@ const ( var ErrUnsupportedOp = errors.New("operation unsupported by the underlying driver") -// emptyInjectFunc defines a empty injector for propagation.Injector function -func emptyInjectFunc(key, value string) error { return nil } - // namedValueToValueString converts driver arguments of NamedValue format to Value string format. func namedValueToValueString(named []driver.NamedValue) string { b := make([]string, 0, len(named)) @@ -80,3 +77,13 @@ func createSpan(ctx context.Context, tracer *go2sky.Tracer, opts *options, opera s.SetSpanLayer(agentv3.SpanLayer_Database) return s, nil } + +func closeSpan(span go2sky.Span, err error) { + if err == driver.ErrSkip { + return + } + if err != nil { + span.Error(time.Now(), err.Error()) + } + span.End() +} diff --git a/sql/conn.go b/sql/conn.go index 0043e9a..dcfea68 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -19,6 +19,7 @@ package sql import ( "context" "database/sql/driver" + "time" "github.com/SkyAPM/go2sky" ) @@ -37,13 +38,15 @@ type conn struct { func (c *conn) Ping(ctx context.Context) error { if pinger, ok := c.conn.(driver.Pinger); ok { span, err := createSpan(ctx, c.tracer, c.opts, "ping") + defer span.End() if err != nil { return err } err = pinger.Ping(ctx) - if err == nil { - span.End() + if err != nil { + span.Error(time.Now(), err.Error()) } + return err } return ErrUnsupportedOp @@ -113,6 +116,8 @@ func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, e if connBeginTx, ok := c.conn.(driver.ConnBeginTx); ok { t, err := connBeginTx.BeginTx(ctx, opts) if err != nil { + span.Error(time.Now(), err.Error()) + span.End() return nil, err } return &tx{ @@ -123,6 +128,8 @@ func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, e t, err := c.Begin() if err != nil { + span.Error(time.Now(), err.Error()) + span.End() return nil, err } @@ -160,20 +167,18 @@ func (c *conn) ExecContext(ctx context.Context, query string, args []driver.Name if execerContext, ok := c.conn.(driver.ExecerContext); ok { res, err := execerContext.ExecContext(ctx, query, args) - if err == nil { - span.End() - } + closeSpan(span, err) return res, err } values, err := namedValueToValue(args) if err != nil { + span.Error(time.Now(), err.Error()) + span.End() return nil, err } res, err := c.Exec(query, values) - if err == nil { - span.End() - } + closeSpan(span, err) return res, err } @@ -205,19 +210,17 @@ func (c *conn) QueryContext(ctx context.Context, query string, args []driver.Nam if queryerContext, ok := c.conn.(driver.QueryerContext); ok { row, err := queryerContext.QueryContext(ctx, query, args) - if err == nil { - span.End() - } + closeSpan(span, err) return row, err } values, err := namedValueToValue(args) if err != nil { + span.Error(time.Now(), err.Error()) + span.End() return nil, err } row, err := c.Query(query, values) - if err == nil { - span.End() - } + closeSpan(span, err) return row, err } diff --git a/sql/connector.go b/sql/connector.go index 510829f..645e0c0 100644 --- a/sql/connector.go +++ b/sql/connector.go @@ -19,6 +19,7 @@ package sql import ( "context" "database/sql/driver" + "time" "github.com/SkyAPM/go2sky" ) @@ -35,14 +36,16 @@ func (ct *connector) Connect(ctx context.Context) (driver.Conn, error) { if err != nil { return nil, err } + defer span.End() + span.Tag(tagDbType, string(ct.opts.dbType)) span.Tag(tagDbInstance, ct.opts.peer) c, err := ct.connector.Connect(ctx) if err != nil { + span.Error(time.Now(), err.Error()) return nil, err } - span.End() return &conn{ conn: c, tracer: ct.tracer, diff --git a/sql/go.mod b/sql/go.mod index cf69363..3999085 100644 --- a/sql/go.mod +++ b/sql/go.mod @@ -3,15 +3,13 @@ module github.com/SkyAPM/go2sky-plugins/sql go 1.16 require ( - github.com/SkyAPM/go2sky v1.1.0 + github.com/SkyAPM/go2sky v1.1.1-0.20210808075144-b16c9f07fef6 github.com/go-sql-driver/mysql v1.6.0 - github.com/google/uuid v1.2.0 // indirect + github.com/google/uuid v1.3.0 // indirect github.com/pkg/errors v0.9.1 // indirect - github.com/stretchr/testify v1.7.0 - golang.org/x/net v0.0.0-20210614182718-04defd469f4e // indirect - golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect - google.golang.org/genproto v0.0.0-20210630183607-d20f26d13c79 // indirect - google.golang.org/grpc v1.39.0 // indirect - gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect - skywalking.apache.org/repo/goapi v0.0.0-20210628073857-a95ba03d3c7a // indirect + golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d // indirect + golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069 // indirect + google.golang.org/genproto v0.0.0-20210805201207-89edb61ffb67 // indirect + google.golang.org/grpc v1.39.1 // indirect + skywalking.apache.org/repo/goapi v0.0.0-20210804062511-c324007aab53 ) diff --git a/sql/go.sum b/sql/go.sum index ec9ef0b..7e9700f 100644 --- a/sql/go.sum +++ b/sql/go.sum @@ -4,6 +4,8 @@ github.com/99designs/gqlgen v0.13.0/go.mod h1:NV130r6f4tpRWuAI+zsrSdooO/eWUv+Gyy github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/SkyAPM/go2sky v1.1.0 h1:XT8aiCvf0qZnQz2gPfb8ROzymoog9yGNbE9wBBLny+o= github.com/SkyAPM/go2sky v1.1.0/go.mod h1:LzuySkt/TsQL8FMANZu4BX/6Rn0UfGu5KS/r9TwG/dc= +github.com/SkyAPM/go2sky v1.1.1-0.20210808075144-b16c9f07fef6 h1:EloGRRVy/Ooui361ifggSXU/8J4F3aXiD86X9YwzXEE= +github.com/SkyAPM/go2sky v1.1.1-0.20210808075144-b16c9f07fef6/go.mod h1:LzuySkt/TsQL8FMANZu4BX/6Rn0UfGu5KS/r9TwG/dc= github.com/agnivade/levenshtein v1.0.1/go.mod h1:CURSv5d9Uaml+FovSIICkLbAUZ9S4RqaHDIsdSBg7lM= github.com/agnivade/levenshtein v1.0.3/go.mod h1:4SFRZbbXWLF4MU1T9Qg0pGgH3Pjs+t6ie5efyrwRJXs= github.com/andreyvit/diff v0.0.0-20170406064948-c7f18ee00883/go.mod h1:rCTlJbsFo29Kk6CurOXKm700vrz8f0KW0JNfpkRJY/8= @@ -16,7 +18,6 @@ github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnht github.com/cncf/xds/go v0.0.0-20210312221358-fbca930ec8ed/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= 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/trifles v0.0.0-20190318185328-a8d75aae118c/go.mod h1:if7Fbed8SFyPtHLHbg49SI7NAdJiC5WIA09pe59rfAA= github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= @@ -59,15 +60,15 @@ github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/ github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.2.0 h1:qJYtXnJRWmpe7m/3XlyhrsLrEURqHRM2kxzoxXqyUDs= github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= +github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/gorilla/context v0.0.0-20160226214623-1ea25387ff6f/go.mod h1:kBGZzfjB9CEq2AlWe17Uuf7NDRt0dE0s8S51q0aT7Yg= github.com/gorilla/mux v1.6.1/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs= github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= github.com/grpc-ecosystem/grpc-gateway v1.16.0/go.mod h1:BDjrQk3hbvj6Nolgz8mAMFbcEtjT1g+wF4CSlocrBnw= github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= -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/logrusorgru/aurora v0.0.0-20200102142835-e9ef32dff381/go.mod h1:7rIyQOR62GCctdiQpZ/zOJlFyk6y+94wXzv6RNZgaR4= github.com/matryer/moq v0.0.0-20200106131100-75d0ddfc0007/go.mod h1:9ELz6aaclSIGnZBoaSLZ3NAl1VTufbOrXBPvtcy6WiQ= @@ -80,7 +81,6 @@ github.com/opentracing/opentracing-go v1.0.2/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFSt 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/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ= @@ -94,8 +94,6 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+ github.com/stretchr/testify v1.2.1/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= -github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= -github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/urfave/cli/v2 v2.1.1/go.mod h1:SE9GqnLQmjVa0iPEY0f1w3ygNIYcIJ0OKPMoW2caLfQ= github.com/vektah/dataloaden v0.2.1-0.20190515034641-a19b9a6e7c9e/go.mod h1:/HUdMve7rvxZma+2ZELQeNh88+003LL7Pf/CZ089j8U= github.com/vektah/gqlparser/v2 v2.1.0/go.mod h1:SyUiHgLATUR8BiYURfTirrTcGpcE+4XkV2se04Px1Ms= @@ -124,6 +122,8 @@ golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81R golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= golang.org/x/net v0.0.0-20210614182718-04defd469f4e h1:XpT3nA5TvE525Ne3hInMh6+GETgn27Zfm9dxsThnX2Q= golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d h1:20cMwl2fHAzkJMEA+8J4JgqBQcQGzbisXo31MIeenXI= +golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -143,6 +143,8 @@ golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069 h1:siQdpVirKtzPhKl3lZWozZraCFObP8S1v6PRp0bLrtU= +golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.1-0.20181010134911-4d1c5fb19474/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= @@ -161,6 +163,7 @@ golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtn golang.org/x/tools v0.0.0-20200114235610-7ae403b6b589/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= 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= @@ -174,6 +177,8 @@ google.golang.org/genproto v0.0.0-20200513103714-09dca8ec2884/go.mod h1:55QSHmfG google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo= google.golang.org/genproto v0.0.0-20210630183607-d20f26d13c79 h1:s1jFTXJryg4a1mew7xv03VZD8N9XjxFhk1o4Js4WvPQ= google.golang.org/genproto v0.0.0-20210630183607-d20f26d13c79/go.mod h1:yiaVoXHpRzHGyxV3o4DktVWY4mSUErTKaeEOq6C3t3U= +google.golang.org/genproto v0.0.0-20210805201207-89edb61ffb67 h1:VmMSf20ssFK0+u1dscyTH9bU4/M4y+X/xNfkvD6kGtM= +google.golang.org/genproto v0.0.0-20210805201207-89edb61ffb67/go.mod h1:ob2IJxKrgPT52GcgX759i1sleT07tiKowYBGbczaW48= google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg= google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY= @@ -184,6 +189,8 @@ google.golang.org/grpc v1.36.1/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAG google.golang.org/grpc v1.38.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM= google.golang.org/grpc v1.39.0 h1:Klz8I9kdtkIN6EpHHUOMLCYhTn/2WAe5a0s1hcBkdTI= google.golang.org/grpc v1.39.0/go.mod h1:PImNr+rS9TWYb2O4/emRugxiyHZ5JyHW5F+RPnDzfrE= +google.golang.org/grpc v1.39.1 h1:f37vZbBVTiJ6jKG5mWz8ySOBxNqy6ViPgyhSdVnxF3E= +google.golang.org/grpc v1.39.1/go.mod h1:PImNr+rS9TWYb2O4/emRugxiyHZ5JyHW5F+RPnDzfrE= google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= @@ -199,18 +206,16 @@ google.golang.org/protobuf v1.27.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQ google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ= google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= -gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo= -gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= skywalking.apache.org/repo/goapi v0.0.0-20210401062122-a049ca15c62d/go.mod h1:S9co6uRVlbQU7PnN7RpEqRtLRCF5n0E9TB7RSmqC5kw= skywalking.apache.org/repo/goapi v0.0.0-20210628073857-a95ba03d3c7a h1:O3nG1yp5zO2TMWx6ZryMZhlQ+LBM7C9iYIHju2A4Yqg= skywalking.apache.org/repo/goapi v0.0.0-20210628073857-a95ba03d3c7a/go.mod h1:wmVce2yQsna9boVCkJP4oROZVnOCobmwUiOTsDIzWmQ= +skywalking.apache.org/repo/goapi v0.0.0-20210804062511-c324007aab53 h1:Uo45FlD3j75iKaH78pstq/HkyjgzEz7ryfET5lZEwto= +skywalking.apache.org/repo/goapi v0.0.0-20210804062511-c324007aab53/go.mod h1:2abOB2LaQEsJLmollzCt5kNfVMWFGKE58905uYzs+sc= sourcegraph.com/sourcegraph/appdash v0.0.0-20180110180208-2cc67fd64755/go.mod h1:hI742Nqp5OhwiqlzhgfbWU4mW4yO10fP+LoT9WOswdU= sourcegraph.com/sourcegraph/appdash-data v0.0.0-20151005221446-73f23eafcf67/go.mod h1:L5q+DGLGOQFpo1snNEkLOJT2d1YTW66rWNzatr3He1k= diff --git a/sql/stmt.go b/sql/stmt.go index 9921131..e32d128 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -19,6 +19,7 @@ package sql import ( "context" "database/sql/driver" + "time" "github.com/SkyAPM/go2sky" ) @@ -55,6 +56,7 @@ func (s *stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (drive return nil, err } defer span.End() + span.Tag(tagDbType, string(s.opts.dbType)) span.Tag(tagDbInstance, s.opts.peer) if s.opts.reportQuery { @@ -65,14 +67,25 @@ func (s *stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (drive } if execerContext, ok := s.stmt.(driver.StmtExecContext); ok { - return execerContext.ExecContext(ctx, args) + res, err := execerContext.ExecContext(ctx, args) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return res, err } values, err := namedValueToValue(args) if err != nil { + span.Error(time.Now(), err.Error()) + span.End() return nil, err } - return s.Exec(values) + res, err := s.Exec(values) + if err != nil { + span.Error(time.Now(), err.Error()) + return res, err + } + return res, err } func (s *stmt) Query(args []driver.Value) (driver.Rows, error) { @@ -89,6 +102,7 @@ func (s *stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driv return nil, err } defer span.End() + span.Tag(tagDbType, string(s.opts.dbType)) span.Tag(tagDbInstance, s.opts.peer) if s.opts.reportQuery { @@ -99,12 +113,20 @@ func (s *stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driv } if queryer, ok := s.stmt.(driver.StmtQueryContext); ok { - return queryer.QueryContext(ctx, args) + rows, err := queryer.QueryContext(ctx, args) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return rows, err } values, err := namedValueToValue(args) if err != nil { return nil, err } - return s.Query(values) + rows, err := s.Query(values) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return rows, err } diff --git a/sql/test/client.go b/sql/test/client.go index 55221ae..2030129 100644 --- a/sql/test/client.go +++ b/sql/test/client.go @@ -23,7 +23,7 @@ import ( "log" "net/http" - sqlPlugin "sql" + sqlPlugin "github.com/SkyAPM/go2sky-plugins/sql" "github.com/SkyAPM/go2sky" "github.com/SkyAPM/go2sky/reporter" @@ -35,7 +35,7 @@ type testFunc func(context.Context, *sql.DB) error const ( oap = "mockoap:19876" service = "sql-client" - dsn = "user:password@tcp(mysql:3306)/database" + dsn = "user:password@tcp(127.0.0.1:3306)/database" addr = ":8080" ) @@ -45,6 +45,7 @@ func main() { // init tracer re, err := reporter.NewGRPCReporter(oap) + //re, err := reporter.NewLogReporter() if err != nil { log.Fatalf("create grpc reporter error: %v \n", err) } @@ -58,6 +59,7 @@ func main() { sqlPlugin.WithSqlDBType(sqlPlugin.MYSQL), sqlPlugin.WithQueryReport(), sqlPlugin.WithParamReport())) + db, err := sql.Open("skywalking-sql", dsn) if err != nil { log.Fatalf("open db error: %v \n", err) @@ -65,7 +67,7 @@ func main() { route := http.NewServeMux() route.HandleFunc("/healthCheck", func(res http.ResponseWriter, req *http.Request) { - _, _ = res.Write([]byte("Success")) + _, _ = res.Write([]byte("success")) }) route.HandleFunc("/execute", func(res http.ResponseWriter, req *http.Request) { tests := []struct { @@ -85,11 +87,12 @@ func main() { defer span.End() for _, test := range tests { + log.Printf("excute test case %s", test.name) if err := test.fn(ctx, db); err != nil { log.Fatalf("test case %s failed: %v", test.name, err) } } - _, _ = res.Write([]byte("Execute sql success")) + _, _ = res.Write([]byte("execute sql success")) }) log.Println("start client") diff --git a/sql/test/docker-compose.yaml b/sql/test/docker-compose.yml similarity index 100% rename from sql/test/docker-compose.yaml rename to sql/test/docker-compose.yml diff --git a/sql/test/expected.data.yaml b/sql/test/expected.data.yml similarity index 89% rename from sql/test/expected.data.yaml rename to sql/test/expected.data.yml index d4dc7e3..baec9b9 100644 --- a/sql/test/expected.data.yaml +++ b/sql/test/expected.data.yml @@ -16,13 +16,14 @@ segmentItems: {{- range .segmentItems }} + {{- if eq .serviceName "sql-client"}} - serviceName: sql-client - segmentSize: {{ gt .segmentSize 0 } + segmentSize: {{ gt .segmentSize 0 }} segments: {{- range .segments }} - - segmentId: {{ notEmpty .segmentId } + - segmentId: {{ notEmpty .segmentId }} spans: - {{- range spans }} + {{- range .spans }} {{- if eq .operationName "Mysql/Go2Sky/connect" }} - operationName: Mysql/Go2Sky/connect operationId: 0 @@ -31,7 +32,7 @@ segmentItems: spanLayer: Database startTime: {{ gt .startTime 0 }} endTime: {{ gt .endTime 0 }} - componentId: 5010 + componentId: 5012 isError: false spanType: Exit peer: mysql:3306 @@ -48,7 +49,7 @@ segmentItems: spanLayer: Database startTime: {{ gt .startTime 0 }} endTime: {{ gt .endTime 0 }} - componentId: 5010 + componentId: 5012 isError: false spanType: Exit peer: 'mysql:3306' @@ -58,11 +59,11 @@ segmentItems: - operationName: Mysql/Go2Sky/execute operationId: 0 parentSpanId: 0 - spanId: {{ notEmpty .spanId }} + spanId: {{ gt .spanId 0 }} spanLayer: Database startTime: {{ gt .startTime 0 }} endTime: {{ gt .endTime 0 }} - componentId: 5010 + componentId: 5012 isError: false spanType: Exit peer: mysql:3306 @@ -76,11 +77,11 @@ segmentItems: - operationName: Mysql/Go2Sky/query operationId: 0 parentSpanId: 0 - spanId: {{ notEmpty .spanId }} + spanId: {{ gt .spanId 0 }} spanLayer: Database startTime: {{ gt .startTime 0 }} endTime: {{ gt .endTime 0 }} - componentId: 5010 + componentId: 5012 isError: false spanType: Exit peer: mysql:3306 @@ -94,11 +95,11 @@ segmentItems: - operationName: Mysql/Go2Sky/beginTransaction operationId: 0 parentSpanId: 0 - spanId: {{ notEmpty .spanId }} + spanId: {{ gt .spanId 0 }} spanLayer: Database startTime: {{ gt .startTime 0 }} endTime: {{ gt .endTime 0 }} - componentId: 5010 + componentId: 5012 isError: false spanType: Exit peer: mysql:3306 @@ -111,4 +112,5 @@ segmentItems: {{- end }} {{- end }} {{- end }} + {{- end }} meterItems: [] \ No newline at end of file diff --git a/sql/test/sql_plugin_test.yaml b/sql/test/sql_plugin_test.yaml index 668a4a3..9c088aa 100644 --- a/sql/test/sql_plugin_test.yaml +++ b/sql/test/sql_plugin_test.yaml @@ -25,6 +25,8 @@ cleanup: trigger: action: http + interval: 3s + times: 5 url: http://127.0.0.1:${client_8080}/execute method: GET From 11ab3bd5184b6e43ec7ebffe0f4a1e175176981f Mon Sep 17 00:00:00 2001 From: Kagaya Date: Tue, 10 Aug 2021 17:49:59 +0800 Subject: [PATCH 17/26] add sql.DB wrapper --- sql/common.go | 17 ++- sql/conn.go | 226 --------------------------------------- sql/connector.go | 110 ------------------- sql/driver.go | 74 ------------- sql/options.go | 5 +- sql/sql.go | 257 +++++++++++++++++++++++++++++++++++++++++++++ sql/stmt.go | 132 ----------------------- sql/test/client.go | 23 ++-- sql/tx.go | 45 -------- 9 files changed, 273 insertions(+), 616 deletions(-) delete mode 100644 sql/conn.go delete mode 100644 sql/connector.go delete mode 100644 sql/driver.go create mode 100644 sql/sql.go delete mode 100644 sql/stmt.go delete mode 100644 sql/tx.go diff --git a/sql/common.go b/sql/common.go index 92a2573..76b3b23 100644 --- a/sql/common.go +++ b/sql/common.go @@ -22,7 +22,6 @@ import ( "errors" "fmt" "strings" - "time" "github.com/SkyAPM/go2sky" agentv3 "skywalking.apache.org/repo/goapi/collect/language/agent/v3" @@ -64,6 +63,10 @@ func namedValueToValue(named []driver.NamedValue) ([]driver.Value, error) { return dargs, nil } +func argsToString(args ...interface{}) string { + return "" +} + func createSpan(ctx context.Context, tracer *go2sky.Tracer, opts *options, operation string) (go2sky.Span, error) { s, _, err := tracer.CreateLocalSpan(ctx, go2sky.WithSpanType(go2sky.SpanTypeExit), @@ -75,15 +78,7 @@ func createSpan(ctx context.Context, tracer *go2sky.Tracer, opts *options, opera s.SetPeer(opts.peer) s.SetComponent(opts.componentID) s.SetSpanLayer(agentv3.SpanLayer_Database) + s.Tag(tagDbType, string(opts.dbType)) + s.Tag(tagDbInstance, opts.peer) return s, nil } - -func closeSpan(span go2sky.Span, err error) { - if err == driver.ErrSkip { - return - } - if err != nil { - span.Error(time.Now(), err.Error()) - } - span.End() -} diff --git a/sql/conn.go b/sql/conn.go deleted file mode 100644 index dcfea68..0000000 --- a/sql/conn.go +++ /dev/null @@ -1,226 +0,0 @@ -// -// Copyright 2021 SkyAPM org -// -// Licensed 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 sql - -import ( - "context" - "database/sql/driver" - "time" - - "github.com/SkyAPM/go2sky" -) - -// conn is a tracing wrapper for driver.Conn -type conn struct { - conn driver.Conn - tracer *go2sky.Tracer - - opts *options -} - -// Ping implements driver.Pinger interface. -// If the underlying Conn does not implement Pinger, -// Ping will return a ErrUnsupportedOp error -func (c *conn) Ping(ctx context.Context) error { - if pinger, ok := c.conn.(driver.Pinger); ok { - span, err := createSpan(ctx, c.tracer, c.opts, "ping") - defer span.End() - if err != nil { - return err - } - err = pinger.Ping(ctx) - if err != nil { - span.Error(time.Now(), err.Error()) - } - - return err - } - return ErrUnsupportedOp -} - -func (c *conn) Prepare(query string) (driver.Stmt, error) { - st, err := c.conn.Prepare(query) - if err != nil { - return nil, err - } - return &stmt{ - stmt: st, - tracer: c.tracer, - query: query, - opts: c.opts, - }, nil -} - -// PrepareContext implements driver.ConnPrepareContext PrepareContext -// If the underlying Conn does not implements -// driver.ConnPrepareContext interface, this method -// will use Prepare instead. -func (c *conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) { - if ConnPrepareContext, ok := c.conn.(driver.ConnPrepareContext); ok { - st, err := ConnPrepareContext.PrepareContext(ctx, query) - if err != nil { - return nil, err - } - return &stmt{ - stmt: st, - tracer: c.tracer, - query: query, - opts: c.opts, - }, nil - } - return c.Prepare(query) -} - -// Close implements driver.Conn Close -func (c *conn) Close() error { - return c.conn.Close() -} - -// Begin implements driver.Conn Begin -func (c *conn) Begin() (driver.Tx, error) { - t, err := c.conn.Begin() - if err != nil { - return nil, err - } - return &tx{ - tx: t, - }, nil -} - -// BeginTx implements driver.ConnBeginTx BeginTx. -// If the underlying Conn does not implements -// driver.ConnBeginTx interface, this method -// will use Begin instead. -func (c *conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) { - span, err := createSpan(ctx, c.tracer, c.opts, "beginTransaction") - if err != nil { - return nil, err - } - span.Tag(tagDbType, string(c.opts.dbType)) - span.Tag(tagDbInstance, c.opts.peer) - - if connBeginTx, ok := c.conn.(driver.ConnBeginTx); ok { - t, err := connBeginTx.BeginTx(ctx, opts) - if err != nil { - span.Error(time.Now(), err.Error()) - span.End() - return nil, err - } - return &tx{ - tx: t, - span: span, - }, nil - } - - t, err := c.Begin() - if err != nil { - span.Error(time.Now(), err.Error()) - span.End() - return nil, err - } - - return &tx{ - tx: t, - span: span, - }, nil -} - -// Exec implements driver.Execer Exec -func (c *conn) Exec(query string, args []driver.Value) (driver.Result, error) { - if execer, ok := c.conn.(driver.Execer); ok { - return execer.Exec(query, args) - } - return nil, ErrUnsupportedOp -} - -// ExecContext implements driver.ExecerContext ExecContext. -// If the underlying Conn does not implements -// driver.ExecerContext interface, this method -// will use Exec instead. -func (c *conn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) { - span, err := createSpan(ctx, c.tracer, c.opts, "execute") - if err != nil { - return nil, err - } - span.Tag(tagDbType, string(c.opts.dbType)) - span.Tag(tagDbInstance, c.opts.peer) - if c.opts.reportQuery { - span.Tag(tagDbStatement, query) - } - if c.opts.reportParam { - span.Tag(tagDbSqlParameters, namedValueToValueString(args)) - } - - if execerContext, ok := c.conn.(driver.ExecerContext); ok { - res, err := execerContext.ExecContext(ctx, query, args) - closeSpan(span, err) - return res, err - } - - values, err := namedValueToValue(args) - if err != nil { - span.Error(time.Now(), err.Error()) - span.End() - return nil, err - } - res, err := c.Exec(query, values) - closeSpan(span, err) - return res, err -} - -// Query implements driver.Queryer Query -func (c *conn) Query(query string, args []driver.Value) (driver.Rows, error) { - if queryer, ok := c.conn.(driver.Queryer); ok { - return queryer.Query(query, args) - } - return nil, ErrUnsupportedOp -} - -// QueryContext implements driver.QueryerContext QueryContext -// If the underlying Conn does not implements -// driver.QueryerContext interface, this method -// will use Query instead. -func (c *conn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) { - span, err := createSpan(ctx, c.tracer, c.opts, "query") - if err != nil { - return nil, err - } - span.Tag(tagDbType, string(c.opts.dbType)) - span.Tag(tagDbInstance, c.opts.peer) - if c.opts.reportQuery { - span.Tag(tagDbStatement, query) - } - if c.opts.reportParam { - span.Tag(tagDbSqlParameters, namedValueToValueString(args)) - } - - if queryerContext, ok := c.conn.(driver.QueryerContext); ok { - row, err := queryerContext.QueryContext(ctx, query, args) - closeSpan(span, err) - return row, err - } - - values, err := namedValueToValue(args) - if err != nil { - span.Error(time.Now(), err.Error()) - span.End() - return nil, err - } - row, err := c.Query(query, values) - closeSpan(span, err) - return row, err -} diff --git a/sql/connector.go b/sql/connector.go deleted file mode 100644 index 645e0c0..0000000 --- a/sql/connector.go +++ /dev/null @@ -1,110 +0,0 @@ -// -// Copyright 2021 SkyAPM org -// -// Licensed 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 sql - -import ( - "context" - "database/sql/driver" - "time" - - "github.com/SkyAPM/go2sky" -) - -type connector struct { - connector driver.Connector - tracer *go2sky.Tracer - - opts *options -} - -func (ct *connector) Connect(ctx context.Context) (driver.Conn, error) { - span, err := createSpan(ctx, ct.tracer, ct.opts, "connect") - if err != nil { - return nil, err - } - defer span.End() - - span.Tag(tagDbType, string(ct.opts.dbType)) - span.Tag(tagDbInstance, ct.opts.peer) - - c, err := ct.connector.Connect(ctx) - if err != nil { - span.Error(time.Now(), err.Error()) - return nil, err - } - return &conn{ - conn: c, - tracer: ct.tracer, - opts: ct.opts, - }, nil -} - -func (ct *connector) Driver() driver.Driver { - return ct.connector.Driver() -} - -type fallbackConnector struct { - driver driver.Driver - name string - - opts *options -} - -func (fc *fallbackConnector) Connect(ctx context.Context) (driver.Conn, error) { - conn, err := fc.driver.Open(fc.name) - if err != nil { - return nil, err - } - if ctx.Err() != nil { // ctx done closed - conn.Close() - return nil, ctx.Err() - } - return conn, nil -} - -func (fc *fallbackConnector) Driver() driver.Driver { - return fc.driver -} - -// OpenConnector implements driver.DriverContext OpenConnector -func (d *go2SkySQLDriver) OpenConnector(name string) (driver.Connector, error) { - if d.opts.peer == "" { - d.opts.setPeerWithDsn(name) - } - if dc, ok := d.driver.(driver.DriverContext); ok { - c, err := dc.OpenConnector(name) - if err != nil { - return nil, err - } - return &connector{ - connector: c, - tracer: d.tracer, - opts: d.opts, - }, nil - } - - // given driver does not implement driver.DriverContext interface - return &connector{ - connector: &fallbackConnector{ - driver: d.driver, - name: name, - opts: d.opts, - }, - tracer: d.tracer, - opts: d.opts, - }, nil -} diff --git a/sql/driver.go b/sql/driver.go deleted file mode 100644 index 21444ce..0000000 --- a/sql/driver.go +++ /dev/null @@ -1,74 +0,0 @@ -// -// Copyright 2021 SkyAPM org -// -// Licensed 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 sql - -import ( - "context" - "database/sql/driver" - - "github.com/SkyAPM/go2sky" -) - -// go2SkySQLDriver is a tracing wrapper for driver.Driver -type go2SkySQLDriver struct { - driver driver.Driver - tracer *go2sky.Tracer - - opts *options -} - -// NewTracerDriver return a driver wrapper with go2sky tracer, -// Options include: WithSqlDBType, WithPeerAddr, WithQueryReport, WithParamReport -func NewTracerDriver(driver driver.Driver, tracer *go2sky.Tracer, opts ...Option) driver.Driver { - options := &options{ - dbType: IPV4, - } - for _, o := range opts { - o(options) - } - if options.componentID == 0 { - options.setComponentID() - } - return &go2SkySQLDriver{ - driver: driver, - tracer: tracer, - opts: options, - } -} - -func (d *go2SkySQLDriver) Open(name string) (driver.Conn, error) { - if d.opts.peer == "" { - d.opts.setPeerWithDsn(name) - } - span, err := createSpan(context.Background(), d.tracer, d.opts, "open") - if err != nil { - return nil, err - } - defer span.End() - span.Tag(tagDbType, string(d.opts.dbType)) - span.Tag(tagDbInstance, d.opts.peer) - - c, err := d.driver.Open(name) - if err != nil { - return nil, err - } - return &conn{ - conn: c, - tracer: d.tracer, - opts: d.opts, - }, nil -} diff --git a/sql/options.go b/sql/options.go index 974a985..d07e21b 100644 --- a/sql/options.go +++ b/sql/options.go @@ -23,8 +23,9 @@ import ( type DBType string const ( - MYSQL DBType = "mysql" - IPV4 DBType = "others" + UNKNOWN DBType = "unknown" + MYSQL DBType = "mysql" + IPV4 DBType = "others" ) type Option func(*options) diff --git a/sql/sql.go b/sql/sql.go new file mode 100644 index 0000000..01b8177 --- /dev/null +++ b/sql/sql.go @@ -0,0 +1,257 @@ +package sql + +import ( + "context" + "database/sql" + "database/sql/driver" + "time" + + "github.com/SkyAPM/go2sky" +) + +type DB struct { + *sql.DB + + tracer *go2sky.Tracer + opts *options +} + +func OpenDB(c driver.Connector, tracer *go2sky.Tracer, opts ...Option) *DB { + db := sql.OpenDB(c) + + options := &options{ + dbType: UNKNOWN, + componentID: componentIDUnknown, + reportQuery: false, + reportParam: false, + } + for _, o := range opts { + o(options) + } + + return &DB{ + DB: db, + tracer: tracer, + opts: options, + } +} + +func Open(driverName, dataSourceName string, tracer *go2sky.Tracer, opts ...Option) (*DB, error) { + db, err := sql.Open(driverName, dataSourceName) + if err != nil { + return nil, err + } + + options := &options{ + dbType: UNKNOWN, + componentID: componentIDUnknown, + reportQuery: false, + reportParam: false, + } + for _, o := range opts { + o(options) + } + + return &DB{ + DB: db, + tracer: tracer, + opts: options, + }, nil +} + +func (db *DB) PingContext(ctx context.Context) error { + span, err := createSpan(ctx, db.tracer, db.opts, "ping") + if err != nil { + return err + } + defer span.End() + err = db.DB.PingContext(ctx) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return err +} + +func (db *DB) PrepareContext(ctx context.Context, query string) (*Stmt, error) { + stmt, err := db.DB.PrepareContext(ctx, query) + if err != nil { + return nil, err + } + return &Stmt{ + Stmt: stmt, + query: query, + }, nil +} + +func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { + span, err := createSpan(ctx, db.tracer, db.opts, "exec") + if err != nil { + return nil, err + } + defer span.End() + + if db.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + res, err := db.DB.ExecContext(ctx, query, args) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return res, err +} + +func (db *DB) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) { + span, err := createSpan(ctx, db.tracer, db.opts, "query") + if err != nil { + return nil, err + } + defer span.End() + + if db.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + rows, err := db.DB.QueryContext(ctx, query, args) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return rows, err +} + +func (db *DB) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row { + span, err := createSpan(ctx, db.tracer, db.opts, "query") + if err != nil { + return nil + } + defer span.End() + + if db.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + return db.DB.QueryRowContext(ctx, query, args) +} + +func (db *DB) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) { + span, err := createSpan(ctx, db.tracer, db.opts, "transaction") + if err != nil { + return nil, err + } + + tx, err := db.DB.BeginTx(ctx, opts) + if err != nil { + span.Error(time.Now(), err.Error()) + span.End() + return nil, err + } + return &Tx{ + Tx: tx, + db: db, + span: span, + }, nil +} + +func (db *DB) Conn(ctx context.Context) (*Conn, error) { + conn, err := db.DB.Conn(ctx) + if err != nil { + return nil, err + } + return &Conn{ + Conn: conn, + db: db, + }, nil +} + +type Conn struct { + *sql.Conn + + db *DB +} + +func (c *Conn) PingContext(ctx context.Context) error { + +} + +func (c *Conn) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { + +} + +func (c *Conn) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) { + +} + +func (c *Conn) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sqlRow { + +} + +func (c *Conn) PrepareContext(ctx context.Context, query string) (*Stmt, error) { + +} + +func (c *Conn) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) { + +} + +type Tx struct { + *sql.Tx + + db *DB + span go2sky.Span +} + +func (tx *Tx) Commit() error { + +} + +func (tx *Tx) Rollback() error { + +} + +func (tx *Tx) PrepareContext(ctx context.Context, query string) (*Stmt, error) { + +} + +func (tx *Tx) StmtContext(ctx context.Context, stmt *Stmt) *Stmt { + +} + +func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { + +} + +func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) { + +} + +func (tx *Tx) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row { + +} + +type Stmt struct { + *sql.Stmt + + db *DB + query string +} + +func (s *Stmt) ExecContext(ctx context.Context, args ...interface{}) (sql.Result, error) { + +} + +func (s *Stmt) QueryContext(ctx context.Context, args ...interface{}) (*sql.Rows, error) { + +} + +func (s *Stmt) QueryRowContext(ctx context.Context, args ...interface{}) *sql.Row { + +} diff --git a/sql/stmt.go b/sql/stmt.go deleted file mode 100644 index e32d128..0000000 --- a/sql/stmt.go +++ /dev/null @@ -1,132 +0,0 @@ -// -// Copyright 2021 SkyAPM org -// -// Licensed 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 sql - -import ( - "context" - "database/sql/driver" - "time" - - "github.com/SkyAPM/go2sky" -) - -// stmt is a tracing wrapper for driver.Stmt -type stmt struct { - stmt driver.Stmt - tracer *go2sky.Tracer - - opts *options - // query defines the statement query - query string -} - -func (s *stmt) Close() error { - return s.stmt.Close() -} - -func (s *stmt) NumInput() int { - return s.stmt.NumInput() -} - -func (s *stmt) Exec(args []driver.Value) (driver.Result, error) { - return s.stmt.Exec(args) -} - -// ExecContext implements driver.StmtExecContext ExecContext -// If the underlying Stmt does not implements -// driver.StmtExecContext interface, this method -// will use Exec instead. -func (s *stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error) { - span, err := createSpan(ctx, s.tracer, s.opts, "execute") - if err != nil { - return nil, err - } - defer span.End() - - span.Tag(tagDbType, string(s.opts.dbType)) - span.Tag(tagDbInstance, s.opts.peer) - if s.opts.reportQuery { - span.Tag(tagDbStatement, s.query) - } - if s.opts.reportParam { - span.Tag(tagDbSqlParameters, namedValueToValueString(args)) - } - - if execerContext, ok := s.stmt.(driver.StmtExecContext); ok { - res, err := execerContext.ExecContext(ctx, args) - if err != nil { - span.Error(time.Now(), err.Error()) - } - return res, err - } - - values, err := namedValueToValue(args) - if err != nil { - span.Error(time.Now(), err.Error()) - span.End() - return nil, err - } - res, err := s.Exec(values) - if err != nil { - span.Error(time.Now(), err.Error()) - return res, err - } - return res, err -} - -func (s *stmt) Query(args []driver.Value) (driver.Rows, error) { - return s.stmt.Query(args) -} - -// QueryContext implements driver.StmtQueryContext QueryContext -// If the underlying Stmt does not implements -// driver.StmtQueryContext interface, this method -// will use Query instead. -func (s *stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error) { - span, err := createSpan(ctx, s.tracer, s.opts, "query") - if err != nil { - return nil, err - } - defer span.End() - - span.Tag(tagDbType, string(s.opts.dbType)) - span.Tag(tagDbInstance, s.opts.peer) - if s.opts.reportQuery { - span.Tag(tagDbStatement, s.query) - } - if s.opts.reportParam { - span.Tag(tagDbSqlParameters, namedValueToValueString(args)) - } - - if queryer, ok := s.stmt.(driver.StmtQueryContext); ok { - rows, err := queryer.QueryContext(ctx, args) - if err != nil { - span.Error(time.Now(), err.Error()) - } - return rows, err - } - - values, err := namedValueToValue(args) - if err != nil { - return nil, err - } - rows, err := s.Query(values) - if err != nil { - span.Error(time.Now(), err.Error()) - } - return rows, err -} diff --git a/sql/test/client.go b/sql/test/client.go index 2030129..51b79b7 100644 --- a/sql/test/client.go +++ b/sql/test/client.go @@ -18,7 +18,6 @@ package main import ( "context" - "database/sql" "fmt" "log" "net/http" @@ -27,10 +26,10 @@ import ( "github.com/SkyAPM/go2sky" "github.com/SkyAPM/go2sky/reporter" - "github.com/go-sql-driver/mysql" + _ "github.com/go-sql-driver/mysql" ) -type testFunc func(context.Context, *sql.DB) error +type testFunc func(context.Context, *sqlPlugin.DB) error const ( oap = "mockoap:19876" @@ -40,9 +39,6 @@ const ( ) func main() { - // init driver - mysqlDriver := &mysql.MySQLDriver{} - // init tracer re, err := reporter.NewGRPCReporter(oap) //re, err := reporter.NewLogReporter() @@ -55,12 +51,7 @@ func main() { log.Fatalf("crate tracer error: %v \n", err) } - sql.Register("skywalking-sql", sqlPlugin.NewTracerDriver(mysqlDriver, tracer, - sqlPlugin.WithSqlDBType(sqlPlugin.MYSQL), - sqlPlugin.WithQueryReport(), - sqlPlugin.WithParamReport())) - - db, err := sql.Open("skywalking-sql", dsn) + db, err := sqlPlugin.Open("mysql", dsn, tracer) if err != nil { log.Fatalf("open db error: %v \n", err) } @@ -102,7 +93,7 @@ func main() { } } -func TestExec(ctx context.Context, db *sql.DB) error { +func TestExec(ctx context.Context, db *sqlPlugin.DB) error { if err := db.PingContext(ctx); err != nil { return err } @@ -129,7 +120,7 @@ func TestExec(ctx context.Context, db *sql.DB) error { return nil } -func TestStmt(ctx context.Context, db *sql.DB) error { +func TestStmt(ctx context.Context, db *sqlPlugin.DB) error { stmt, err := db.PrepareContext(ctx, `INSERT INTO users (id, name, age) VALUE ( ?, ?, ?)`) if err != nil { return err @@ -144,7 +135,7 @@ func TestStmt(ctx context.Context, db *sql.DB) error { return nil } -func TestCommitTx(ctx context.Context, db *sql.DB) error { +func TestCommitTx(ctx context.Context, db *sqlPlugin.DB) error { tx, err := db.BeginTx(ctx, nil) if err != nil { return fmt.Errorf("begin tx error: %v \n", err) @@ -160,7 +151,7 @@ func TestCommitTx(ctx context.Context, db *sql.DB) error { return nil } -func TestRollbackTx(ctx context.Context, db *sql.DB) error { +func TestRollbackTx(ctx context.Context, db *sqlPlugin.DB) error { tx, err := db.BeginTx(ctx, nil) if err != nil { return fmt.Errorf("begin tx error: %v \n", err) diff --git a/sql/tx.go b/sql/tx.go deleted file mode 100644 index 35564f4..0000000 --- a/sql/tx.go +++ /dev/null @@ -1,45 +0,0 @@ -// -// Copyright 2021 SkyAPM org -// -// Licensed 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 sql - -import ( - "database/sql/driver" - - "github.com/SkyAPM/go2sky" -) - -// tx is a wrapper for driver.Tx -type tx struct { - tx driver.Tx - span go2sky.Span -} - -func (t *tx) Commit() error { - if t.span != nil { - t.span.Tag(tagDbStatement, "commit") - defer t.span.End() - } - return t.tx.Commit() -} - -func (t *tx) Rollback() error { - if t.span != nil { - t.span.Tag(tagDbStatement, "rollback") - defer t.span.End() - } - return t.tx.Rollback() -} From 84c65db087fe9a86d4a31d54ae2f8c723bc78703 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Tue, 10 Aug 2021 20:13:19 +0800 Subject: [PATCH 18/26] add tx/stmt/conn wrapper --- sql/conn.go | 114 ++++++++++++++++++++++++++++++++++++++++++ sql/{sql.go => db.go} | 84 ------------------------------- sql/stmt.go | 73 +++++++++++++++++++++++++++ sql/tx.go | 112 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 299 insertions(+), 84 deletions(-) create mode 100644 sql/conn.go rename sql/{sql.go => db.go} (68%) create mode 100644 sql/stmt.go create mode 100644 sql/tx.go diff --git a/sql/conn.go b/sql/conn.go new file mode 100644 index 0000000..4c68b1b --- /dev/null +++ b/sql/conn.go @@ -0,0 +1,114 @@ +package sql + +import ( + "context" + "database/sql" + "time" +) + +type Conn struct { + *sql.Conn + + db *DB +} + +func (c *Conn) PingContext(ctx context.Context) error { + span, err := createSpan(ctx, c.db.tracer, c.db.opts, "ping") + if err != nil { + return err + } + defer span.End() + err = c.Conn.PingContext(ctx) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return err +} + +func (c *Conn) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { + span, err := createSpan(ctx, c.db.tracer, c.db.opts, "exec") + if err != nil { + return nil, err + } + defer span.End() + + if c.db.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if c.db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + res, err := c.Conn.ExecContext(ctx, query, args) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return res, err +} + +func (c *Conn) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) { + span, err := createSpan(ctx, c.db.tracer, c.db.opts, "query") + if err != nil { + return nil, err + } + defer span.End() + + if c.db.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if c.db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + rows, err := c.Conn.QueryContext(ctx, query, args) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return rows, err +} + +func (c *Conn) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row { + span, err := createSpan(ctx, c.db.tracer, c.db.opts, "query") + if err != nil { + return nil + } + defer span.End() + + if c.db.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if c.db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + return c.Conn.QueryRowContext(ctx, query, args) +} + +func (c *Conn) PrepareContext(ctx context.Context, query string) (*Stmt, error) { + stmt, err := c.Conn.PrepareContext(ctx, query) + return &Stmt{ + Stmt: stmt, + db: c.db, + query: query, + }, err +} + +func (c *Conn) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) { + span, err := createSpan(ctx, c.db.tracer, c.db.opts, "transaction") + if err != nil { + return nil, err + } + + tx, err := c.Conn.BeginTx(ctx, opts) + if err != nil { + span.Error(time.Now(), err.Error()) + span.End() + return nil, err + } + + return &Tx{ + Tx: tx, + span: span, + }, nil + +} diff --git a/sql/sql.go b/sql/db.go similarity index 68% rename from sql/sql.go rename to sql/db.go index 01b8177..afef059 100644 --- a/sql/sql.go +++ b/sql/db.go @@ -171,87 +171,3 @@ func (db *DB) Conn(ctx context.Context) (*Conn, error) { db: db, }, nil } - -type Conn struct { - *sql.Conn - - db *DB -} - -func (c *Conn) PingContext(ctx context.Context) error { - -} - -func (c *Conn) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { - -} - -func (c *Conn) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) { - -} - -func (c *Conn) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sqlRow { - -} - -func (c *Conn) PrepareContext(ctx context.Context, query string) (*Stmt, error) { - -} - -func (c *Conn) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) { - -} - -type Tx struct { - *sql.Tx - - db *DB - span go2sky.Span -} - -func (tx *Tx) Commit() error { - -} - -func (tx *Tx) Rollback() error { - -} - -func (tx *Tx) PrepareContext(ctx context.Context, query string) (*Stmt, error) { - -} - -func (tx *Tx) StmtContext(ctx context.Context, stmt *Stmt) *Stmt { - -} - -func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { - -} - -func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) { - -} - -func (tx *Tx) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row { - -} - -type Stmt struct { - *sql.Stmt - - db *DB - query string -} - -func (s *Stmt) ExecContext(ctx context.Context, args ...interface{}) (sql.Result, error) { - -} - -func (s *Stmt) QueryContext(ctx context.Context, args ...interface{}) (*sql.Rows, error) { - -} - -func (s *Stmt) QueryRowContext(ctx context.Context, args ...interface{}) *sql.Row { - -} diff --git a/sql/stmt.go b/sql/stmt.go new file mode 100644 index 0000000..2bdab69 --- /dev/null +++ b/sql/stmt.go @@ -0,0 +1,73 @@ +package sql + +import ( + "context" + "database/sql" + "time" +) + +type Stmt struct { + *sql.Stmt + + db *DB + query string +} + +func (s *Stmt) ExecContext(ctx context.Context, args ...interface{}) (sql.Result, error) { + span, err := createSpan(ctx, s.db.tracer, s.db.opts, "exec") + if err != nil { + return nil, err + } + defer span.End() + + if s.db.opts.reportQuery { + span.Tag(tagDbStatement, s.query) + } + if s.db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + res, err := s.Stmt.ExecContext(ctx, args) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return res, err +} + +func (s *Stmt) QueryContext(ctx context.Context, args ...interface{}) (*sql.Rows, error) { + span, err := createSpan(ctx, s.db.tracer, s.db.opts, "query") + if err != nil { + return nil, err + } + defer span.End() + + if s.db.opts.reportQuery { + span.Tag(tagDbStatement, s.query) + } + if s.db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + rows, err := s.Stmt.QueryContext(ctx, args) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return rows, err +} + +func (s *Stmt) QueryRowContext(ctx context.Context, args ...interface{}) *sql.Row { + span, err := createSpan(ctx, s.db.tracer, s.db.opts, "query") + if err != nil { + return nil + } + defer span.End() + + if s.db.opts.reportQuery { + span.Tag(tagDbStatement, s.query) + } + if s.db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + return s.Stmt.QueryRowContext(ctx, args) +} diff --git a/sql/tx.go b/sql/tx.go new file mode 100644 index 0000000..48a5e93 --- /dev/null +++ b/sql/tx.go @@ -0,0 +1,112 @@ +package sql + +import ( + "context" + "database/sql" + "time" + + "github.com/SkyAPM/go2sky" +) + +type Tx struct { + *sql.Tx + + db *DB + span go2sky.Span +} + +func (tx *Tx) Commit() error { + if tx.span != nil { + tx.span.Tag(tagDbStatement, "commit") + defer tx.span.End() + } + return tx.Tx.Commit() +} + +func (tx *Tx) Rollback() error { + if tx.span != nil { + tx.span.Tag(tagDbStatement, "rollback") + defer tx.span.End() + } + return tx.Tx.Rollback() +} + +func (tx *Tx) PrepareContext(ctx context.Context, query string) (*Stmt, error) { + stmt, err := tx.Tx.PrepareContext(ctx, query) + if err != nil { + return nil, err + } + return &Stmt{ + Stmt: stmt, + db: tx.db, + query: query, + }, nil +} + +func (tx *Tx) StmtContext(ctx context.Context, stmt *Stmt) *Stmt { + st := tx.Tx.StmtContext(ctx, stmt.Stmt) + return &Stmt{ + Stmt: st, + db: tx.db, + query: stmt.query, + } +} + +func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { + span, err := createSpan(ctx, tx.db.tracer, tx.db.opts, "exec") + if err != nil { + return nil, err + } + defer span.End() + + if tx.db.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if tx.db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + res, err := tx.Tx.ExecContext(ctx, query, args) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return res, err +} + +func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) { + span, err := createSpan(ctx, tx.db.tracer, tx.db.opts, "query") + if err != nil { + return nil, err + } + defer span.End() + + if tx.db.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if tx.db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + rows, err := tx.Tx.QueryContext(ctx, query, args) + if err != nil { + span.Error(time.Now(), err.Error()) + } + return rows, err +} + +func (tx *Tx) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row { + span, err := createSpan(ctx, tx.db.tracer, tx.db.opts, "query") + if err != nil { + return nil + } + defer span.End() + + if tx.db.opts.reportQuery { + span.Tag(tagDbStatement, query) + } + if tx.db.opts.reportParam { + span.Tag(tagDbSqlParameters, argsToString(args)) + } + + return tx.Tx.QueryRowContext(ctx, query, args) +} From 4d9af1db21297a72d06d360231808ebaa712cbaf Mon Sep 17 00:00:00 2001 From: Kagaya Date: Tue, 10 Aug 2021 20:21:14 +0800 Subject: [PATCH 19/26] update license header & readme --- sql/README.md | 25 +++++++++++++++++-------- sql/conn.go | 16 ++++++++++++++++ sql/db.go | 16 ++++++++++++++++ sql/stmt.go | 16 ++++++++++++++++ sql/test/client.go | 7 ++++++- sql/tx.go | 16 ++++++++++++++++ 6 files changed, 87 insertions(+), 9 deletions(-) diff --git a/sql/README.md b/sql/README.md index 34d8546..8c57e81 100644 --- a/sql/README.md +++ b/sql/README.md @@ -10,12 +10,11 @@ go get -u github.com/SkyAPM/go2sky-plugins/sql ```go import ( - "database/sql" + sqlPlugin "github.com/SkyAPM/go2sky-plugins/sql" "github.com/SkyAPM/go2sky" "github.com/SkyAPM/go2sky/reporter" - sqlPlugin "github.com/SkyAPM/go2sky-plugins/sql" - "github.com/go-sql-driver/mysql" + _ "github.com/go-sql-driver/mysql" ) // init reporter @@ -24,10 +23,20 @@ defer re.Close() // init tracer tracer, err := go2sky.NewTracer("service-name", go2sky.WithReporter(re)) +if err != nil { + log.Fatalf("init tracer error: %v", err) +} + +// use sql plugin to open db with tracer +db, err := sqlPlugin.Open("mysql", dsn, tracer, + sqlPlugin.WithSqlDBType(sqlPlugin.MYSQL), + sqlPlugin.WithQueryReport(), + sqlPlugin.WithParamReport(), + sqlPlugin.WithPeerAddr("127.0.0.1:3306"), +) +if err != nil { + log.Fatalf("open db error: %v \n", err) +} -// register go2sky sql wrapper -sql.Register("skywalking-sql", sqlPlugin.NewTracerDriver(&mysql.MySQLDriver{}, tracer, sqlPlugin.WithSqlDBType(sqlPlugin.MYSQL), sqlPlugin.WithQueryReport())) -db, err := sql.Open("skywalking-sql", "user:password@tcp(127.0.0.1:3306)/dbname") - -// use db handle as usual. +// use db handler as usual. ``` \ No newline at end of file diff --git a/sql/conn.go b/sql/conn.go index 4c68b1b..7295ee5 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -1,3 +1,19 @@ +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 sql import ( diff --git a/sql/db.go b/sql/db.go index afef059..eecfda1 100644 --- a/sql/db.go +++ b/sql/db.go @@ -1,3 +1,19 @@ +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 sql import ( diff --git a/sql/stmt.go b/sql/stmt.go index 2bdab69..6253abf 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -1,3 +1,19 @@ +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 sql import ( diff --git a/sql/test/client.go b/sql/test/client.go index 51b79b7..4252fe2 100644 --- a/sql/test/client.go +++ b/sql/test/client.go @@ -51,7 +51,12 @@ func main() { log.Fatalf("crate tracer error: %v \n", err) } - db, err := sqlPlugin.Open("mysql", dsn, tracer) + db, err := sqlPlugin.Open("mysql", dsn, tracer, + sqlPlugin.WithSqlDBType(sqlPlugin.MYSQL), + sqlPlugin.WithQueryReport(), + sqlPlugin.WithParamReport(), + sqlPlugin.WithPeerAddr("127.0.0.1:3306"), + ) if err != nil { log.Fatalf("open db error: %v \n", err) } diff --git a/sql/tx.go b/sql/tx.go index 48a5e93..5578e01 100644 --- a/sql/tx.go +++ b/sql/tx.go @@ -1,3 +1,19 @@ +// +// Copyright 2021 SkyAPM org +// +// Licensed 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 sql import ( From df4bebfa82728205d98dda377da1592d2a5e4faf Mon Sep 17 00:00:00 2001 From: Kagaya Date: Tue, 10 Aug 2021 22:11:52 +0800 Subject: [PATCH 20/26] bug fixed --- sql/common.go | 8 ++++++-- sql/conn.go | 6 +++--- sql/db.go | 6 +++--- sql/go.sum | 15 --------------- sql/stmt.go | 6 +++--- sql/test/client.go | 2 +- sql/tx.go | 6 +++--- 7 files changed, 19 insertions(+), 30 deletions(-) diff --git a/sql/common.go b/sql/common.go index 76b3b23..426c62d 100644 --- a/sql/common.go +++ b/sql/common.go @@ -63,8 +63,12 @@ func namedValueToValue(named []driver.NamedValue) ([]driver.Value, error) { return dargs, nil } -func argsToString(args ...interface{}) string { - return "" +func argsToString(args []interface{}) string { + sb := strings.Builder{} + for _, arg := range args { + sb.WriteString(fmt.Sprintf("%v, ", arg)) + } + return sb.String() } func createSpan(ctx context.Context, tracer *go2sky.Tracer, opts *options, operation string) (go2sky.Span, error) { diff --git a/sql/conn.go b/sql/conn.go index 7295ee5..630843d 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -55,7 +55,7 @@ func (c *Conn) ExecContext(ctx context.Context, query string, args ...interface{ span.Tag(tagDbSqlParameters, argsToString(args)) } - res, err := c.Conn.ExecContext(ctx, query, args) + res, err := c.Conn.ExecContext(ctx, query, args...) if err != nil { span.Error(time.Now(), err.Error()) } @@ -76,7 +76,7 @@ func (c *Conn) QueryContext(ctx context.Context, query string, args ...interface span.Tag(tagDbSqlParameters, argsToString(args)) } - rows, err := c.Conn.QueryContext(ctx, query, args) + rows, err := c.Conn.QueryContext(ctx, query, args...) if err != nil { span.Error(time.Now(), err.Error()) } @@ -97,7 +97,7 @@ func (c *Conn) QueryRowContext(ctx context.Context, query string, args ...interf span.Tag(tagDbSqlParameters, argsToString(args)) } - return c.Conn.QueryRowContext(ctx, query, args) + return c.Conn.QueryRowContext(ctx, query, args...) } func (c *Conn) PrepareContext(ctx context.Context, query string) (*Stmt, error) { diff --git a/sql/db.go b/sql/db.go index eecfda1..c1c34c6 100644 --- a/sql/db.go +++ b/sql/db.go @@ -113,7 +113,7 @@ func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{} span.Tag(tagDbSqlParameters, argsToString(args)) } - res, err := db.DB.ExecContext(ctx, query, args) + res, err := db.DB.ExecContext(ctx, query, args...) if err != nil { span.Error(time.Now(), err.Error()) } @@ -134,7 +134,7 @@ func (db *DB) QueryContext(ctx context.Context, query string, args ...interface{ span.Tag(tagDbSqlParameters, argsToString(args)) } - rows, err := db.DB.QueryContext(ctx, query, args) + rows, err := db.DB.QueryContext(ctx, query, args...) if err != nil { span.Error(time.Now(), err.Error()) } @@ -155,7 +155,7 @@ func (db *DB) QueryRowContext(ctx context.Context, query string, args ...interfa span.Tag(tagDbSqlParameters, argsToString(args)) } - return db.DB.QueryRowContext(ctx, query, args) + return db.DB.QueryRowContext(ctx, query, args...) } func (db *DB) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) { diff --git a/sql/go.sum b/sql/go.sum index 7e9700f..cfa2ff0 100644 --- a/sql/go.sum +++ b/sql/go.sum @@ -2,8 +2,6 @@ cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMT cloud.google.com/go v0.34.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= github.com/99designs/gqlgen v0.13.0/go.mod h1:NV130r6f4tpRWuAI+zsrSdooO/eWUv+Gyyoi3rEfXIk= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= -github.com/SkyAPM/go2sky v1.1.0 h1:XT8aiCvf0qZnQz2gPfb8ROzymoog9yGNbE9wBBLny+o= -github.com/SkyAPM/go2sky v1.1.0/go.mod h1:LzuySkt/TsQL8FMANZu4BX/6Rn0UfGu5KS/r9TwG/dc= github.com/SkyAPM/go2sky v1.1.1-0.20210808075144-b16c9f07fef6 h1:EloGRRVy/Ooui361ifggSXU/8J4F3aXiD86X9YwzXEE= github.com/SkyAPM/go2sky v1.1.1-0.20210808075144-b16c9f07fef6/go.mod h1:LzuySkt/TsQL8FMANZu4BX/6Rn0UfGu5KS/r9TwG/dc= github.com/agnivade/levenshtein v1.0.1/go.mod h1:CURSv5d9Uaml+FovSIICkLbAUZ9S4RqaHDIsdSBg7lM= @@ -58,8 +56,6 @@ github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/ github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= -github.com/google/uuid v1.2.0 h1:qJYtXnJRWmpe7m/3XlyhrsLrEURqHRM2kxzoxXqyUDs= -github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/gorilla/context v0.0.0-20160226214623-1ea25387ff6f/go.mod h1:kBGZzfjB9CEq2AlWe17Uuf7NDRt0dE0s8S51q0aT7Yg= @@ -120,8 +116,6 @@ golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLL golang.org/x/net v0.0.0-20200222125558-5a598a2470a0/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= -golang.org/x/net v0.0.0-20210614182718-04defd469f4e h1:XpT3nA5TvE525Ne3hInMh6+GETgn27Zfm9dxsThnX2Q= -golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d h1:20cMwl2fHAzkJMEA+8J4JgqBQcQGzbisXo31MIeenXI= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= @@ -141,8 +135,6 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I= -golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069 h1:siQdpVirKtzPhKl3lZWozZraCFObP8S1v6PRp0bLrtU= golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= @@ -162,7 +154,6 @@ golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBn golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20200114235610-7ae403b6b589/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= -golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= 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= @@ -175,8 +166,6 @@ google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoA google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= google.golang.org/genproto v0.0.0-20200513103714-09dca8ec2884/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c= google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo= -google.golang.org/genproto v0.0.0-20210630183607-d20f26d13c79 h1:s1jFTXJryg4a1mew7xv03VZD8N9XjxFhk1o4Js4WvPQ= -google.golang.org/genproto v0.0.0-20210630183607-d20f26d13c79/go.mod h1:yiaVoXHpRzHGyxV3o4DktVWY4mSUErTKaeEOq6C3t3U= google.golang.org/genproto v0.0.0-20210805201207-89edb61ffb67 h1:VmMSf20ssFK0+u1dscyTH9bU4/M4y+X/xNfkvD6kGtM= google.golang.org/genproto v0.0.0-20210805201207-89edb61ffb67/go.mod h1:ob2IJxKrgPT52GcgX759i1sleT07tiKowYBGbczaW48= google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= @@ -187,7 +176,6 @@ google.golang.org/grpc v1.33.1/go.mod h1:fr5YgcSWrqhRRxogOsw7RzIpsmvOZ6IcH4kBYTp google.golang.org/grpc v1.36.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= google.golang.org/grpc v1.36.1/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= google.golang.org/grpc v1.38.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM= -google.golang.org/grpc v1.39.0 h1:Klz8I9kdtkIN6EpHHUOMLCYhTn/2WAe5a0s1hcBkdTI= google.golang.org/grpc v1.39.0/go.mod h1:PImNr+rS9TWYb2O4/emRugxiyHZ5JyHW5F+RPnDzfrE= google.golang.org/grpc v1.39.1 h1:f37vZbBVTiJ6jKG5mWz8ySOBxNqy6ViPgyhSdVnxF3E= google.golang.org/grpc v1.39.1/go.mod h1:PImNr+rS9TWYb2O4/emRugxiyHZ5JyHW5F+RPnDzfrE= @@ -202,7 +190,6 @@ google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpAD google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c= google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= -google.golang.org/protobuf v1.27.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ= google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= @@ -213,8 +200,6 @@ gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= skywalking.apache.org/repo/goapi v0.0.0-20210401062122-a049ca15c62d/go.mod h1:S9co6uRVlbQU7PnN7RpEqRtLRCF5n0E9TB7RSmqC5kw= -skywalking.apache.org/repo/goapi v0.0.0-20210628073857-a95ba03d3c7a h1:O3nG1yp5zO2TMWx6ZryMZhlQ+LBM7C9iYIHju2A4Yqg= -skywalking.apache.org/repo/goapi v0.0.0-20210628073857-a95ba03d3c7a/go.mod h1:wmVce2yQsna9boVCkJP4oROZVnOCobmwUiOTsDIzWmQ= skywalking.apache.org/repo/goapi v0.0.0-20210804062511-c324007aab53 h1:Uo45FlD3j75iKaH78pstq/HkyjgzEz7ryfET5lZEwto= skywalking.apache.org/repo/goapi v0.0.0-20210804062511-c324007aab53/go.mod h1:2abOB2LaQEsJLmollzCt5kNfVMWFGKE58905uYzs+sc= sourcegraph.com/sourcegraph/appdash v0.0.0-20180110180208-2cc67fd64755/go.mod h1:hI742Nqp5OhwiqlzhgfbWU4mW4yO10fP+LoT9WOswdU= diff --git a/sql/stmt.go b/sql/stmt.go index 6253abf..6826499 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -43,7 +43,7 @@ func (s *Stmt) ExecContext(ctx context.Context, args ...interface{}) (sql.Result span.Tag(tagDbSqlParameters, argsToString(args)) } - res, err := s.Stmt.ExecContext(ctx, args) + res, err := s.Stmt.ExecContext(ctx, args...) if err != nil { span.Error(time.Now(), err.Error()) } @@ -64,7 +64,7 @@ func (s *Stmt) QueryContext(ctx context.Context, args ...interface{}) (*sql.Rows span.Tag(tagDbSqlParameters, argsToString(args)) } - rows, err := s.Stmt.QueryContext(ctx, args) + rows, err := s.Stmt.QueryContext(ctx, args...) if err != nil { span.Error(time.Now(), err.Error()) } @@ -85,5 +85,5 @@ func (s *Stmt) QueryRowContext(ctx context.Context, args ...interface{}) *sql.Ro span.Tag(tagDbSqlParameters, argsToString(args)) } - return s.Stmt.QueryRowContext(ctx, args) + return s.Stmt.QueryRowContext(ctx, args...) } diff --git a/sql/test/client.go b/sql/test/client.go index 4252fe2..7e789d1 100644 --- a/sql/test/client.go +++ b/sql/test/client.go @@ -34,7 +34,7 @@ type testFunc func(context.Context, *sqlPlugin.DB) error const ( oap = "mockoap:19876" service = "sql-client" - dsn = "user:password@tcp(127.0.0.1:3306)/database" + dsn = "user:password@tcp(mysql:3306)/database" addr = ":8080" ) diff --git a/sql/tx.go b/sql/tx.go index 5578e01..851fee0 100644 --- a/sql/tx.go +++ b/sql/tx.go @@ -82,7 +82,7 @@ func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{} span.Tag(tagDbSqlParameters, argsToString(args)) } - res, err := tx.Tx.ExecContext(ctx, query, args) + res, err := tx.Tx.ExecContext(ctx, query, args...) if err != nil { span.Error(time.Now(), err.Error()) } @@ -103,7 +103,7 @@ func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{ span.Tag(tagDbSqlParameters, argsToString(args)) } - rows, err := tx.Tx.QueryContext(ctx, query, args) + rows, err := tx.Tx.QueryContext(ctx, query, args...) if err != nil { span.Error(time.Now(), err.Error()) } @@ -124,5 +124,5 @@ func (tx *Tx) QueryRowContext(ctx context.Context, query string, args ...interfa span.Tag(tagDbSqlParameters, argsToString(args)) } - return tx.Tx.QueryRowContext(ctx, query, args) + return tx.Tx.QueryRowContext(ctx, query, args...) } From 0b53ecf76aefded54bb8b82424a64fded3ba40c6 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Wed, 11 Aug 2021 15:56:28 +0800 Subject: [PATCH 21/26] fix e2e fail --- sql/common.go | 18 ++++++++++++++ sql/conn.go | 3 ++- sql/db.go | 7 +++++- sql/options.go | 22 +--------------- sql/stmt.go | 2 +- sql/test/client.go | 7 +++--- sql/test/expected.data.yml | 51 ++++++++++++++++++++------------------ sql/tx.go | 2 +- 8 files changed, 60 insertions(+), 52 deletions(-) diff --git a/sql/common.go b/sql/common.go index 426c62d..8107956 100644 --- a/sql/common.go +++ b/sql/common.go @@ -21,6 +21,7 @@ import ( "database/sql/driver" "errors" "fmt" + "regexp" "strings" "github.com/SkyAPM/go2sky" @@ -86,3 +87,20 @@ func createSpan(ctx context.Context, tracer *go2sky.Tracer, opts *options, opera s.Tag(tagDbInstance, opts.peer) return s, nil } + +// parseDsn parse dsn to a endpoint addr string (host:port) +func parseDsn(dbType DBType, dsn string) string { + var addr string + switch dbType { + case MYSQL: + // [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN] + re := regexp.MustCompile(`\(.+\)`) + addr = re.FindString(dsn) + addr = addr[1 : len(addr)-1] + case IPV4: + // ipv4 addr + re := regexp.MustCompile(`((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})(\.((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})){3}:\d{1,5}`) + addr = re.FindString(dsn) + } + return addr +} diff --git a/sql/conn.go b/sql/conn.go index 630843d..8c1aba9 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -42,7 +42,7 @@ func (c *Conn) PingContext(ctx context.Context) error { } func (c *Conn) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { - span, err := createSpan(ctx, c.db.tracer, c.db.opts, "exec") + span, err := createSpan(ctx, c.db.tracer, c.db.opts, "execute") if err != nil { return nil, err } @@ -124,6 +124,7 @@ func (c *Conn) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) { return &Tx{ Tx: tx, + db: c.db, span: span, }, nil diff --git a/sql/db.go b/sql/db.go index c1c34c6..284ae98 100644 --- a/sql/db.go +++ b/sql/db.go @@ -68,6 +68,10 @@ func Open(driverName, dataSourceName string, tracer *go2sky.Tracer, opts ...Opti o(options) } + if options.peer == "" { + options.peer = parseDsn(options.dbType, dataSourceName) + } + return &DB{ DB: db, tracer: tracer, @@ -95,12 +99,13 @@ func (db *DB) PrepareContext(ctx context.Context, query string) (*Stmt, error) { } return &Stmt{ Stmt: stmt, + db: db, query: query, }, nil } func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { - span, err := createSpan(ctx, db.tracer, db.opts, "exec") + span, err := createSpan(ctx, db.tracer, db.opts, "execute") if err != nil { return nil, err } diff --git a/sql/options.go b/sql/options.go index d07e21b..7342da7 100644 --- a/sql/options.go +++ b/sql/options.go @@ -16,10 +16,6 @@ package sql -import ( - "regexp" -) - type DBType string const ( @@ -46,6 +42,7 @@ type options struct { func WithSqlDBType(t DBType) Option { return func(o *options) { o.dbType = t + o.setComponentID() } } @@ -77,23 +74,6 @@ func (o options) getOpName(op string) string { } } -// setPeerWithDsn parse dsn to a endpoint addr string (host:port) -func (o *options) setPeerWithDsn(dsn string) { - var addr string - switch o.dbType { - case MYSQL: - // [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN] - re := regexp.MustCompile(`\(.+\)`) - addr = re.FindString(dsn) - addr = addr[1 : len(addr)-1] - case IPV4: - // ipv4 addr - re := regexp.MustCompile(`((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})(\.((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})){3}:\d{1,5}`) - addr = re.FindString(dsn) - } - o.peer = addr -} - func (o *options) setComponentID() { switch o.dbType { case MYSQL: diff --git a/sql/stmt.go b/sql/stmt.go index 6826499..d2bcd6d 100644 --- a/sql/stmt.go +++ b/sql/stmt.go @@ -30,7 +30,7 @@ type Stmt struct { } func (s *Stmt) ExecContext(ctx context.Context, args ...interface{}) (sql.Result, error) { - span, err := createSpan(ctx, s.db.tracer, s.db.opts, "exec") + span, err := createSpan(ctx, s.db.tracer, s.db.opts, "execute") if err != nil { return nil, err } diff --git a/sql/test/client.go b/sql/test/client.go index 7e789d1..9c457bb 100644 --- a/sql/test/client.go +++ b/sql/test/client.go @@ -54,8 +54,6 @@ func main() { db, err := sqlPlugin.Open("mysql", dsn, tracer, sqlPlugin.WithSqlDBType(sqlPlugin.MYSQL), sqlPlugin.WithQueryReport(), - sqlPlugin.WithParamReport(), - sqlPlugin.WithPeerAddr("127.0.0.1:3306"), ) if err != nil { log.Fatalf("open db error: %v \n", err) @@ -76,7 +74,10 @@ func main() { {"rollbackTx", TestRollbackTx}, } - span, ctx, err := tracer.CreateLocalSpan(context.Background()) + span, ctx, err := tracer.CreateLocalSpan( + context.Background(), + go2sky.WithOperationName("execute"), + ) if err != nil { log.Fatalf("create span error: %v \n", err) } diff --git a/sql/test/expected.data.yml b/sql/test/expected.data.yml index baec9b9..398e23f 100644 --- a/sql/test/expected.data.yml +++ b/sql/test/expected.data.yml @@ -12,7 +12,7 @@ # 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. -#. +# segmentItems: {{- range .segmentItems }} @@ -24,8 +24,8 @@ segmentItems: - segmentId: {{ notEmpty .segmentId }} spans: {{- range .spans }} - {{- if eq .operationName "Mysql/Go2Sky/connect" }} - - operationName: Mysql/Go2Sky/connect + {{- if eq .operationName "Mysql/Go2Sky/ping" }} + - operationName: Mysql/Go2Sky/ping operationId: 0 parentSpanId: 0 spanId: 1 @@ -35,26 +35,12 @@ segmentItems: componentId: 5012 isError: false spanType: Exit - peer: mysql:3306 + peer: 'mysql:3306' skipAnalysis: false tags: - {key: db.type, value: mysql} - {key: db.instance, value: 'mysql:3306'} {{- end }} - {{- if eq .operationName "Mysql/Go2Sky/ping" }} - - operationName: Mysql/Go2Sky/ping - operationId: 0 - parentSpanId: 0 - spanId: 2, - spanLayer: Database - startTime: {{ gt .startTime 0 }} - endTime: {{ gt .endTime 0 }} - componentId: 5012 - isError: false - spanType: Exit - peer: 'mysql:3306' - skipAnalysis: false - {{- end }} {{- if eq .operationName "Mysql/Go2Sky/execute" }} - operationName: Mysql/Go2Sky/execute operationId: 0 @@ -71,9 +57,10 @@ segmentItems: tags: - {key: db.type, value: mysql} - {key: db.instance, value: 'mysql:3306'} - - {key: db.statement, value: {{ notEmpty (index .tags 2).value}}} + - key: db.statement + value: {{ notEmpty (index .tags 2).value }} {{- end }} - {{- if eq .operationName "Mysql/Go2Sky/query"}} + {{- if eq .operationName "Mysql/Go2Sky/query" }} - operationName: Mysql/Go2Sky/query operationId: 0 parentSpanId: 0 @@ -89,10 +76,11 @@ segmentItems: tags: - {key: db.type, value: mysql} - {key: db.instance, value: 'mysql:3306'} - - {key: db.statement, value: {{ notEmpty (index .tags 2).value}}} + - key: db.statement + value: {{ notEmpty (index .tags 2).value }} {{- end }} - {{- if eq .operationName "Mysql/Go2Sky/beginTransaction" }} - - operationName: Mysql/Go2Sky/beginTransaction + {{- if eq .operationName "Mysql/Go2Sky/transaction" }} + - operationName: Mysql/Go2Sky/transaction operationId: 0 parentSpanId: 0 spanId: {{ gt .spanId 0 }} @@ -107,7 +95,22 @@ segmentItems: tags: - {key: db.type, value: mysql} - {key: db.instance, value: 'mysql:3306'} - - {key: db.statement, value: {{ notEmpty (index .tags 2).value}}} + - key: db.statement + value: {{ notEmpty (index .tags 2).value }} + {{- end }} + {{- if eq .operationName "execute" }} + - operationName: execute + operationId: 0 + parentSpanId: -1 + spanId: 0 + spanLayer: Unknown + startTime: {{ gt .startTime 0 }} + endTime: {{ gt .endTime 0 }} + componentId: 0 + isError: false + spanType: Local + peer: '' + skipAnalysis: false {{- end }} {{- end }} {{- end }} diff --git a/sql/tx.go b/sql/tx.go index 851fee0..6ed09d4 100644 --- a/sql/tx.go +++ b/sql/tx.go @@ -69,7 +69,7 @@ func (tx *Tx) StmtContext(ctx context.Context, stmt *Stmt) *Stmt { } func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { - span, err := createSpan(ctx, tx.db.tracer, tx.db.opts, "exec") + span, err := createSpan(ctx, tx.db.tracer, tx.db.opts, "execute") if err != nil { return nil, err } From 0ea71d8b476870e86e6f34d26424026db0193a10 Mon Sep 17 00:00:00 2001 From: Kagaya Date: Wed, 11 Aug 2021 16:23:28 +0800 Subject: [PATCH 22/26] update reademe & plugin_test --- .github/workflows/plugin_test.yaml | 3 ++- README.md | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/plugin_test.yaml b/.github/workflows/plugin_test.yaml index 4d57c96..72f0ad5 100644 --- a/.github/workflows/plugin_test.yaml +++ b/.github/workflows/plugin_test.yaml @@ -35,7 +35,8 @@ jobs: - { name: 'Go Restful', e2e_file: 'go-restful/test/go_restful_plugin_test.yaml' } - { name: 'Go Micro', e2e_file: 'micro/test/go_micro_plugin_test.yaml' } - { name: 'Go Resty', e2e_file: 'resty/test/go_resty_plugin_test.yaml' } - - { name: 'Go Kratos', e2e_file: 'kratos/test/go_kratos_plugin_test.yaml'} + - { name: 'Go Kratos', e2e_file: 'kratos/test/go_kratos_plugin_test.yaml' } + - { name: 'Sql', e2e_file: 'sql/test/sql_plugin_test.yaml' } steps: - uses: actions/checkout@v2 - uses: apache/skywalking-infra-e2e@main diff --git a/README.md b/README.md index 1c2a9c8..f701391 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ The plugins of [go2sky](https://github.com/SkyAPM/go2sky) 1. [go-micro](micro/README.md) 1. [go-restful](go-restful/README.md) 1. [go-kratos](kratos/README.md) +1. [sql](sql/README.md) ### Log Plugins 1. [logrus](logrus/README.md) From 139ad51a76f88b5585ef689c2df99057ea6512bf Mon Sep 17 00:00:00 2001 From: Kagaya Date: Wed, 18 Aug 2021 16:45:11 +0800 Subject: [PATCH 23/26] change tx span to localspan --- sql/common.go | 15 +++++++++++++++ sql/conn.go | 3 ++- sql/db.go | 3 ++- sql/test/expected.data.yml | 4 ++-- sql/tx.go | 37 +++++++++++++++++++++++++++++++++++++ 5 files changed, 58 insertions(+), 4 deletions(-) diff --git a/sql/common.go b/sql/common.go index 8107956..e7ad44c 100644 --- a/sql/common.go +++ b/sql/common.go @@ -88,6 +88,21 @@ func createSpan(ctx context.Context, tracer *go2sky.Tracer, opts *options, opera return s, nil } +func createLocalSpan(ctx context.Context, tracer *go2sky.Tracer, opts *options, operation string) (go2sky.Span, context.Context, error) { + s, nCtx, err := tracer.CreateLocalSpan(ctx, + go2sky.WithSpanType(go2sky.SpanTypeLocal), + go2sky.WithOperationName(opts.getOpName(operation)), + ) + if err != nil { + return nil, nil, err + } + s.SetComponent(opts.componentID) + s.SetSpanLayer(agentv3.SpanLayer_Database) + s.Tag(tagDbType, string(opts.dbType)) + s.Tag(tagDbInstance, opts.peer) + return s, nCtx, nil +} + // parseDsn parse dsn to a endpoint addr string (host:port) func parseDsn(dbType DBType, dsn string) string { var addr string diff --git a/sql/conn.go b/sql/conn.go index 8c1aba9..25cbb71 100644 --- a/sql/conn.go +++ b/sql/conn.go @@ -110,7 +110,7 @@ func (c *Conn) PrepareContext(ctx context.Context, query string) (*Stmt, error) } func (c *Conn) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) { - span, err := createSpan(ctx, c.db.tracer, c.db.opts, "transaction") + span, nCtx, err := createLocalSpan(ctx, c.db.tracer, c.db.opts, "transaction") if err != nil { return nil, err } @@ -126,6 +126,7 @@ func (c *Conn) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) { Tx: tx, db: c.db, span: span, + ctx: nCtx, }, nil } diff --git a/sql/db.go b/sql/db.go index 284ae98..a075972 100644 --- a/sql/db.go +++ b/sql/db.go @@ -164,7 +164,7 @@ func (db *DB) QueryRowContext(ctx context.Context, query string, args ...interfa } func (db *DB) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) { - span, err := createSpan(ctx, db.tracer, db.opts, "transaction") + span, nCtx, err := createLocalSpan(ctx, db.tracer, db.opts, "transaction") if err != nil { return nil, err } @@ -179,6 +179,7 @@ func (db *DB) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) { Tx: tx, db: db, span: span, + ctx: nCtx, }, nil } diff --git a/sql/test/expected.data.yml b/sql/test/expected.data.yml index 398e23f..f47912e 100644 --- a/sql/test/expected.data.yml +++ b/sql/test/expected.data.yml @@ -89,8 +89,8 @@ segmentItems: endTime: {{ gt .endTime 0 }} componentId: 5012 isError: false - spanType: Exit - peer: mysql:3306 + spanType: Local + peer: '' skipAnalysis: false tags: - {key: db.type, value: mysql} diff --git a/sql/tx.go b/sql/tx.go index 6ed09d4..196cefd 100644 --- a/sql/tx.go +++ b/sql/tx.go @@ -29,6 +29,7 @@ type Tx struct { db *DB span go2sky.Span + ctx context.Context } func (tx *Tx) Commit() error { @@ -47,6 +48,18 @@ func (tx *Tx) Rollback() error { return tx.Tx.Rollback() } +func (tx *Tx) Prepare(query string) (*Stmt, error) { + stmt, err := tx.Tx.Prepare(query) + if err != nil { + return nil, err + } + return &Stmt{ + Stmt: stmt, + db: tx.db, + query: query, + }, nil +} + func (tx *Tx) PrepareContext(ctx context.Context, query string) (*Stmt, error) { stmt, err := tx.Tx.PrepareContext(ctx, query) if err != nil { @@ -68,7 +81,15 @@ func (tx *Tx) StmtContext(ctx context.Context, stmt *Stmt) *Stmt { } } +func (tx *Tx) Exec(query string, args ...interface{}) (sql.Result, error) { + return tx.ExecContext(tx.ctx, query, args) +} + func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { + if id := go2sky.SpanID(ctx); id == go2sky.EmptySpanID { + // if ctx do not contain parent span, use transaction ctx instead + ctx = tx.ctx + } span, err := createSpan(ctx, tx.db.tracer, tx.db.opts, "execute") if err != nil { return nil, err @@ -89,7 +110,15 @@ func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{} return res, err } +func (tx *Tx) Query(query string, args ...interface{}) (*sql.Rows, error) { + return tx.QueryContext(tx.ctx, query, args) +} + func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) { + if id := go2sky.SpanID(ctx); id == go2sky.EmptySpanID { + // if ctx do not contain parent span, use transaction ctx instead + ctx = tx.ctx + } span, err := createSpan(ctx, tx.db.tracer, tx.db.opts, "query") if err != nil { return nil, err @@ -110,7 +139,15 @@ func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{ return rows, err } +func (tx *Tx) QueryRow(query string, args ...interface{}) *sql.Row { + return tx.QueryRowContext(tx.ctx, query, args) +} + func (tx *Tx) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row { + if id := go2sky.SpanID(ctx); id == go2sky.EmptySpanID { + // if ctx do not contain parent span, use transaction ctx instead + ctx = tx.ctx + } span, err := createSpan(ctx, tx.db.tracer, tx.db.opts, "query") if err != nil { return nil From bffebd7c02231f979c054ced97104cd625230f8c Mon Sep 17 00:00:00 2001 From: Kagaya Date: Mon, 23 Aug 2021 23:18:38 +0800 Subject: [PATCH 24/26] ci: add checkout for paths-filter --- .github/workflows/plugin_test.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/plugin_test.yaml b/.github/workflows/plugin_test.yaml index 404ac5c..c400788 100644 --- a/.github/workflows/plugin_test.yaml +++ b/.github/workflows/plugin_test.yaml @@ -28,6 +28,7 @@ jobs: outputs: e2e_file: ${{ steps.filter.outputs.changes }} steps: + - uses: actions/checkout@v2 - uses: dorny/paths-filter@v2 id: filter with: From 6fef37b0fee08732b54d1d126495ca0e08aaddea Mon Sep 17 00:00:00 2001 From: Kagaya Date: Mon, 23 Aug 2021 23:28:35 +0800 Subject: [PATCH 25/26] ci: fix empty error --- .github/workflows/plugin_test.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/plugin_test.yaml b/.github/workflows/plugin_test.yaml index c400788..5caa9e4 100644 --- a/.github/workflows/plugin_test.yaml +++ b/.github/workflows/plugin_test.yaml @@ -46,6 +46,7 @@ jobs: PluginsTest: name: Plugin needs: Changes + if: ${{ needs.Changes.outputs.e2e_file != '[]' && needs.Changes.outputs.e2e_file != '' }} runs-on: ubuntu-latest strategy: matrix: From 46c206df73b9853d7b16c9430b7837e8bc178f0f Mon Sep 17 00:00:00 2001 From: Kagaya Date: Wed, 25 Aug 2021 19:53:31 +0800 Subject: [PATCH 26/26] add tx.Exec test --- sql/test/client.go | 8 ++++++++ sql/test/expected.data.yml | 4 ++-- sql/tx.go | 2 +- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/sql/test/client.go b/sql/test/client.go index 9c457bb..728ad73 100644 --- a/sql/test/client.go +++ b/sql/test/client.go @@ -147,6 +147,10 @@ func TestCommitTx(ctx context.Context, db *sqlPlugin.DB) error { return fmt.Errorf("begin tx error: %v \n", err) } + if _, err := tx.Exec(`INSERT INTO users (id, name, age) VALUE ( ?, ?, ? )`, "2", "foobar", 24); err != nil { + return err + } + if _, err := tx.ExecContext(ctx, `UPDATE users SET name = ? WHERE id = ?`, "foobar", "0"); err != nil { return err } @@ -163,6 +167,10 @@ func TestRollbackTx(ctx context.Context, db *sqlPlugin.DB) error { return fmt.Errorf("begin tx error: %v \n", err) } + if _, err := tx.Exec(`UPDATE users SET age = ? WHERE id = ?`, 48, "2"); err != nil { + return err + } + if _, err := tx.ExecContext(ctx, `UPDATE users SET name = ? WHERE id = ?`, "foobar", "1"); err != nil { return err } diff --git a/sql/test/expected.data.yml b/sql/test/expected.data.yml index f47912e..bfd509c 100644 --- a/sql/test/expected.data.yml +++ b/sql/test/expected.data.yml @@ -44,7 +44,7 @@ segmentItems: {{- if eq .operationName "Mysql/Go2Sky/execute" }} - operationName: Mysql/Go2Sky/execute operationId: 0 - parentSpanId: 0 + parentSpanId: {{ gt .parentSpanId -1 }} spanId: {{ gt .spanId 0 }} spanLayer: Database startTime: {{ gt .startTime 0 }} @@ -116,4 +116,4 @@ segmentItems: {{- end }} {{- end }} {{- end }} -meterItems: [] \ No newline at end of file +meterItems: [] diff --git a/sql/tx.go b/sql/tx.go index 196cefd..d8c2b43 100644 --- a/sql/tx.go +++ b/sql/tx.go @@ -82,7 +82,7 @@ func (tx *Tx) StmtContext(ctx context.Context, stmt *Stmt) *Stmt { } func (tx *Tx) Exec(query string, args ...interface{}) (sql.Result, error) { - return tx.ExecContext(tx.ctx, query, args) + return tx.ExecContext(tx.ctx, query, args...) } func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) {