feat: add tracing for sql #1610
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| package tracing | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/nhatthm/otelsql" | ||
| semconv "go.opentelemetry.io/otel/semconv/v1.7.0" | ||
| "go.opentelemetry.io/otel/trace" | ||
| "golang.org/x/xerrors" | ||
| ) | ||
|
|
||
| // Postgres driver will register a new tracing sql driver and return the driver name. | ||
| func PostgresDriver(tp trace.TracerProvider, service string) (string, error) { | ||
| // Register the otelsql wrapper for the provided postgres driver. | ||
| driverName, err := otelsql.Register("postgres", | ||
| otelsql.WithDefaultAttributes( | ||
| semconv.ServiceNameKey.String(service), | ||
| ), | ||
| otelsql.TraceQueryWithoutArgs(), | ||
| otelsql.WithSystem(semconv.DBSystemPostgreSQL), | ||
| otelsql.WithTracerProvider(tp), | ||
| otelsql.WithSpanNameFormatter(formatPostgresSpan), | ||
| ) | ||
| if err != nil { | ||
| return "", xerrors.Errorf("registering postgres tracing driver: %w", err) | ||
| } | ||
|
|
||
| return driverName, nil | ||
| } | ||
|
|
||
| func formatPostgresSpan(ctx context.Context, op string) string { | ||
|
There was a problem hiding this comment. Should we add the There was a problem hiding this comment. I'm just copying the format I've seen before with other database tracing tools (New Relic) and also mimicing the format of the http spans. Since an http span is I don't love the prefix because I already can see where the span is coming from by the instrumentation library (see the screenshots in description), but I also don't know if this is the case on other tools like Jaeger, which I'd like to setup eventually. I'm down to change it if we find it hard to parse as we use it, does that sound ok? There was a problem hiding this comment. Yeah, that sounds perfectly reasonable. 👍🏻 |
||
| const qPrefix = "-- name: " | ||
| q := otelsql.QueryFromContext(ctx) | ||
| if q == "" || !strings.HasPrefix(q, qPrefix) { | ||
| return strings.ToUpper(op) | ||
| } | ||
|
|
||
| // Remove the qPrefix and then grab the method name. | ||
| // We expect the first line of the query to be in | ||
| // the format "-- name: GetAPIKeyByID :one". | ||
| s := strings.SplitN(strings.TrimPrefix(q, qPrefix), " ", 2)[0] | ||
| return fmt.Sprintf("%s %s", strings.ToUpper(op), s) | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
potential bug: If
tracing.PostgresDriverencounters an error here,sqlDriverwill be the empty string; I believe that would cause us to fail to connect to the DB. We should probably fall back to the original driver name in this case and degrade gracefully.