feat: database/sql integration #893
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,247 @@ | ||||||
| package sentrysql | ||||||
|
|
||||||
| import ( | ||||||
| "context" | ||||||
| "database/sql/driver" | ||||||
|
|
||||||
| "github.com/getsentry/sentry-go" | ||||||
| ) | ||||||
|
|
||||||
| type sentryConn struct { | ||||||
| originalConn driver.Conn | ||||||
| ctx context.Context | ||||||
| config *sentrySQLConfig | ||||||
| } | ||||||
|
|
||||||
| func (s *sentryConn) Prepare(query string) (driver.Stmt, error) { | ||||||
| stmt, err := s.originalConn.Prepare(query) | ||||||
| if err != nil { | ||||||
| return nil, err | ||||||
| } | ||||||
|
|
||||||
| return &sentryStmt{ | ||||||
| originalStmt: stmt, | ||||||
| query: query, | ||||||
| ctx: s.ctx, | ||||||
| config: s.config, | ||||||
| }, nil | ||||||
| } | ||||||
|
|
||||||
| func (s *sentryConn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) { | ||||||
| // should only be executed if the original driver implements ConnPrepareContext | ||||||
| connPrepareContext, ok := s.originalConn.(driver.ConnPrepareContext) | ||||||
| if !ok { | ||||||
| return nil, driver.ErrSkip | ||||||
| } | ||||||
|
|
||||||
| stmt, err := connPrepareContext.PrepareContext(ctx, query) | ||||||
| if err != nil { | ||||||
| return nil, err | ||||||
| } | ||||||
|
|
||||||
| return &sentryStmt{ | ||||||
| originalStmt: stmt, | ||||||
| query: query, | ||||||
| ctx: ctx, | ||||||
| config: s.config, | ||||||
| }, nil | ||||||
| } | ||||||
|
|
||||||
| func (s *sentryConn) Close() error { | ||||||
| return s.originalConn.Close() | ||||||
| } | ||||||
|
|
||||||
| func (s *sentryConn) Begin() (driver.Tx, error) { | ||||||
| tx, err := s.originalConn.Begin() //nolint:staticcheck We must support legacy clients | ||||||
| if err != nil { | ||||||
| return nil, err | ||||||
| } | ||||||
|
|
||||||
| return &sentryTx{originalTx: tx, ctx: s.ctx, config: s.config}, nil | ||||||
| } | ||||||
|
|
||||||
| func (s *sentryConn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) { | ||||||
| // should only be executed if the original driver implements ConnBeginTx | ||||||
| connBeginTx, ok := s.originalConn.(driver.ConnBeginTx) | ||||||
| if !ok { | ||||||
| // fallback to the so-called deprecated "Begin" method | ||||||
| return s.Begin() | ||||||
| } | ||||||
|
|
||||||
| tx, err := connBeginTx.BeginTx(ctx, opts) | ||||||
| if err != nil { | ||||||
| return nil, err | ||||||
| } | ||||||
|
|
||||||
| return &sentryTx{originalTx: tx, ctx: s.ctx, config: s.config}, nil | ||||||
|
||||||
| } | ||||||
|
|
||||||
| //nolint:dupl | ||||||
| func (s *sentryConn) Query(query string, args []driver.Value) (driver.Rows, error) { | ||||||
| // should only be executed if the original driver implements Queryer | ||||||
| queryer, ok := s.originalConn.(driver.Queryer) //nolint:staticcheck We must support legacy clients | ||||||
| if !ok { | ||||||
| return nil, driver.ErrSkip | ||||||
| } | ||||||
|
|
||||||
| parentSpan := sentry.SpanFromContext(s.ctx) | ||||||
| if parentSpan == nil { | ||||||
| return queryer.Query(query, args) | ||||||
| } | ||||||
|
|
||||||
| span := parentSpan.StartChild("db.sql.query", sentry.WithDescription(query)) | ||||||
| if s.config.databaseSystem != "" { | ||||||
ribice marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| span.SetData("db.system", s.config.databaseSystem) | ||||||
| } | ||||||
| if s.config.databaseName != "" { | ||||||
| span.SetData("db.name", s.config.databaseName) | ||||||
| } | ||||||
| if s.config.serverAddress != "" { | ||||||
| span.SetData("server.address", s.config.serverAddress) | ||||||
| } | ||||||
| if s.config.serverPort != "" { | ||||||
| span.SetData("server.port", s.config.serverPort) | ||||||
| } | ||||||
| defer span.Finish() | ||||||
|
|
||||||
| rows, err := queryer.Query(query, args) | ||||||
| if err != nil { | ||||||
| span.Status = sentry.SpanStatusInternalError | ||||||
| return nil, err | ||||||
| } | ||||||
|
|
||||||
| span.Status = sentry.SpanStatusOK | ||||||
| return rows, nil | ||||||
| } | ||||||
|
|
||||||
| //nolint:dupl | ||||||
| func (s *sentryConn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) { | ||||||
| // should only be executed if the original driver implements QueryerContext | ||||||
| queryerContext, ok := s.originalConn.(driver.QueryerContext) | ||||||
| if !ok { | ||||||
| return nil, driver.ErrSkip | ||||||
| } | ||||||
|
|
||||||
| parentSpan := sentry.SpanFromContext(ctx) | ||||||
| if parentSpan == nil { | ||||||
| return queryerContext.QueryContext(ctx, query, args) | ||||||
| } | ||||||
|
|
||||||
| span := parentSpan.StartChild("db.sql.query", sentry.WithDescription(query)) | ||||||
| if s.config.databaseSystem != "" { | ||||||
| span.SetData("db.system", s.config.databaseSystem) | ||||||
| } | ||||||
| if s.config.databaseName != "" { | ||||||
| span.SetData("db.name", s.config.databaseName) | ||||||
| } | ||||||
| if s.config.serverAddress != "" { | ||||||
| span.SetData("server.address", s.config.serverAddress) | ||||||
| } | ||||||
| if s.config.serverPort != "" { | ||||||
| span.SetData("server.port", s.config.serverPort) | ||||||
| } | ||||||
| defer span.Finish() | ||||||
|
|
||||||
| rows, err := queryerContext.QueryContext(ctx, query, args) | ||||||
|
||||||
| rows, err := queryerContext.QueryContext(ctx, query, args) | |
| rows, err := queryerContext.QueryContext(span.Context(), query, args) |
Outdated
Contributor
There was a problem hiding this comment.
Suggested change
| rows, err := execerContext.ExecContext(ctx, query, args) | |
| rows, err := execerContext.ExecContext(span.Context(), query, args) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| package sentrysql | ||
|
|
||
| import ( | ||
| "context" | ||
| "database/sql/driver" | ||
| ) | ||
|
|
||
| type sentrySQLDriver struct { | ||
| originalDriver driver.Driver | ||
| config *sentrySQLConfig | ||
| } | ||
|
|
||
| func (s *sentrySQLDriver) OpenConnector(name string) (driver.Connector, error) { | ||
| driverContext, ok := s.originalDriver.(driver.DriverContext) | ||
| if !ok { | ||
| return nil, driver.ErrSkip | ||
| } | ||
|
|
||
| connector, err := driverContext.OpenConnector(name) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &sentrySQLConnector{originalConnector: connector, config: s.config}, nil | ||
| } | ||
|
|
||
| func (s *sentrySQLDriver) Open(name string) (driver.Conn, error) { | ||
| conn, err := s.originalDriver.Open(name) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &sentryConn{originalConn: conn, config: s.config}, nil | ||
| } | ||
|
|
||
| type sentrySQLConnector struct { | ||
| originalConnector driver.Connector | ||
| config *sentrySQLConfig | ||
| } | ||
|
|
||
| func (s *sentrySQLConnector) Connect(ctx context.Context) (driver.Conn, error) { | ||
| conn, err := s.originalConnector.Connect(ctx) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &sentryConn{originalConn: conn, ctx: ctx, config: s.config}, nil | ||
| } | ||
|
|
||
| func (s *sentrySQLConnector) Driver() driver.Driver { | ||
| return s.originalConnector.Driver() | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.