Merge pull request #38 from vearutop/db-instance-name

Add InstanceName trace option

Author: basvanbeek

README.md

@@ -32,7 +32,7 @@ var (
 )
 
 // Register our ocsql wrapper for the provided SQLite3 driver.
-driverName, err = ocsql.Register("sqlite3", ocsql.WithAllTraceOptions())
+driverName, err = ocsql.Register("sqlite3", ocsql.WithAllTraceOptions(), ocsql.WithInstanceName("resources"))
 if err != nil {
     log.Fatalf("unable to register our ocsql driver: %v\n", err)
 }

driver.go

@@ -92,6 +92,11 @@ func Wrap(d driver.Driver, options ...TraceOption) driver.Driver {
 	for _, option := range options {
 		option(&o)
 	}
+	if o.InstanceName == "" {
+		o.InstanceName = defaultInstanceName
+	} else {
+		o.DefaultAttributes = append(o.DefaultAttributes, trace.StringAttribute("sql.instance", o.InstanceName))
+	}
 	if o.QueryParams && !o.Query {
 		o.QueryParams = false
 	}
@@ -113,6 +118,11 @@ func WrapConn(c driver.Conn, options ...TraceOption) driver.Conn {
 	for _, option := range options {
 		option(&o)
 	}
+	if o.InstanceName == "" {
+		o.InstanceName = defaultInstanceName
+	} else {
+		o.DefaultAttributes = append(o.DefaultAttributes, trace.StringAttribute("sql.instance", o.InstanceName))
+	}
 	return wrapConn(c, o)
 }
 
@@ -123,7 +133,7 @@ type ocConn struct {
 }
 
 func (c ocConn) Ping(ctx context.Context) (err error) {
-	defer recordCallStats(ctx, "go.sql.ping")(err)
+	defer recordCallStats(ctx, "go.sql.ping", c.options.InstanceName)(err)
 
 	if c.options.Ping && (c.options.AllowRoot || trace.FromContext(ctx) != nil) {
 		var span *trace.Span
@@ -154,7 +164,7 @@ func (c ocConn) Ping(ctx context.Context) (err error) {
 }
 
 func (c ocConn) Exec(query string, args []driver.Value) (res driver.Result, err error) {
-	defer recordCallStats(context.Background(), "go.sql.exec")(err)
+	defer recordCallStats(context.Background(), "go.sql.exec", c.options.InstanceName)(err)
 
 	if exec, ok := c.parent.(driver.Execer); ok {
 		if !c.options.AllowRoot {
@@ -198,7 +208,7 @@ func (c ocConn) Exec(query string, args []driver.Value) (res driver.Result, err
 }
 
 func (c ocConn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (res driver.Result, err error) {
-	defer recordCallStats(ctx, "go.sql.exec")(err)
+	defer recordCallStats(ctx, "go.sql.exec", c.options.InstanceName)(err)
 
 	if execCtx, ok := c.parent.(driver.ExecerContext); ok {
 		parentSpan := trace.FromContext(ctx)
@@ -243,7 +253,7 @@ func (c ocConn) ExecContext(ctx context.Context, query string, args []driver.Nam
 }
 
 func (c ocConn) Query(query string, args []driver.Value) (rows driver.Rows, err error) {
-	defer recordCallStats(context.Background(), "go.sql.query")(err)
+	defer recordCallStats(context.Background(), "go.sql.query", c.options.InstanceName)(err)
 
 	if queryer, ok := c.parent.(driver.Queryer); ok {
 		if !c.options.AllowRoot {
@@ -288,7 +298,7 @@ func (c ocConn) Query(query string, args []driver.Value) (rows driver.Rows, err
 }
 
 func (c ocConn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (rows driver.Rows, err error) {
-	defer recordCallStats(ctx, "go.sql.query")(err)
+	defer recordCallStats(ctx, "go.sql.query", c.options.InstanceName)(err)
 
 	if queryerCtx, ok := c.parent.(driver.QueryerContext); ok {
 		parentSpan := trace.FromContext(ctx)
@@ -334,7 +344,7 @@ func (c ocConn) QueryContext(ctx context.Context, query string, args []driver.Na
 }
 
 func (c ocConn) Prepare(query string) (stmt driver.Stmt, err error) {
-	defer recordCallStats(context.Background(), "go.sql.prepare")(err)
+	defer recordCallStats(context.Background(), "go.sql.prepare", c.options.InstanceName)(err)
 
 	if c.options.AllowRoot {
 		_, span := trace.StartSpan(context.Background(), "sql:prepare",
@@ -373,7 +383,7 @@ func (c *ocConn) Begin() (driver.Tx, error) {
 }
 
 func (c *ocConn) PrepareContext(ctx context.Context, query string) (stmt driver.Stmt, err error) {
-	defer recordCallStats(ctx, "go.sql.prepare")(err)
+	defer recordCallStats(ctx, "go.sql.prepare", c.options.InstanceName)(err)
 
 	var span *trace.Span
 	attrs := append([]trace.Attribute(nil), c.options.DefaultAttributes...)
@@ -409,7 +419,7 @@ func (c *ocConn) PrepareContext(ctx context.Context, query string) (stmt driver.
 }
 
 func (c *ocConn) BeginTx(ctx context.Context, opts driver.TxOptions) (tx driver.Tx, err error) {
-	defer recordCallStats(ctx, "go.sql.begin")(err)
+	defer recordCallStats(ctx, "go.sql.begin", c.options.InstanceName)(err)
 
 	if !c.options.AllowRoot && trace.FromContext(ctx) == nil {
 		if connBeginTx, ok := c.parent.(driver.ConnBeginTx); ok {
@@ -518,7 +528,7 @@ type ocStmt struct {
 }
 
 func (s ocStmt) Exec(args []driver.Value) (res driver.Result, err error) {
-	defer recordCallStats(context.Background(), "go.sql.stmt.exec")(err)
+	defer recordCallStats(context.Background(), "go.sql.stmt.exec", s.options.InstanceName)(err)
 
 	if !s.options.AllowRoot {
 		return s.parent.Exec(args)
@@ -568,7 +578,7 @@ func (s ocStmt) NumInput() int {
 }
 
 func (s ocStmt) Query(args []driver.Value) (rows driver.Rows, err error) {
-	defer recordCallStats(context.Background(), "go.sql.stmt.query")(err)
+	defer recordCallStats(context.Background(), "go.sql.stmt.query", s.options.InstanceName)(err)
 
 	if !s.options.AllowRoot {
 		return s.parent.Query(args)
@@ -609,7 +619,7 @@ func (s ocStmt) Query(args []driver.Value) (rows driver.Rows, err error) {
 }
 
 func (s ocStmt) ExecContext(ctx context.Context, args []driver.NamedValue) (res driver.Result, err error) {
-	defer recordCallStats(ctx, "go.sql.stmt.exec")(err)
+	defer recordCallStats(ctx, "go.sql.stmt.exec", s.options.InstanceName)(err)
 
 	parentSpan := trace.FromContext(ctx)
 	if !s.options.AllowRoot && parentSpan == nil {
@@ -654,7 +664,7 @@ func (s ocStmt) ExecContext(ctx context.Context, args []driver.NamedValue) (res
 }
 
 func (s ocStmt) QueryContext(ctx context.Context, args []driver.NamedValue) (rows driver.Rows, err error) {
-	defer recordCallStats(ctx, "go.sql.stmt.query")(err)
+	defer recordCallStats(ctx, "go.sql.stmt.query", s.options.InstanceName)(err)
 
 	parentSpan := trace.FromContext(ctx)
 	if !s.options.AllowRoot && parentSpan == nil {
@@ -863,7 +873,7 @@ type ocTx struct {
 }
 
 func (t ocTx) Commit() (err error) {
-	defer recordCallStats(context.Background(), "go.sql.commit")(err)
+	defer recordCallStats(context.Background(), "go.sql.commit", t.options.InstanceName)(err)
 
 	_, span := trace.StartSpan(t.ctx, "sql:commit",
 		trace.WithSpanKind(trace.SpanKindClient),
@@ -882,7 +892,7 @@ func (t ocTx) Commit() (err error) {
 }
 
 func (t ocTx) Rollback() (err error) {
-	defer recordCallStats(context.Background(), "go.sql.rollback")(err)
+	defer recordCallStats(context.Background(), "go.sql.rollback", t.options.InstanceName)(err)
 
 	_, span := trace.StartSpan(t.ctx, "sql:rollback",
 		trace.WithSpanKind(trace.SpanKindClient),

driver_go1.10.go

@@ -6,6 +6,8 @@ import (
 	"context"
 	"database/sql"
 	"database/sql/driver"
+
+	"go.opencensus.io/trace"
 )
 
 var errConnDone = sql.ErrConnDone
@@ -19,15 +21,20 @@ var (
 // WrapConnector allows wrapping a database driver.Connector which eliminates
 // the need to register ocsql as an available driver.Driver.
 func WrapConnector(dc driver.Connector, options ...TraceOption) driver.Connector {
-	opts := TraceOptions{}
-	for _, o := range options {
-		o(&opts)
+	o := TraceOptions{}
+	for _, option := range options {
+		option(&o)
+	}
+	if o.InstanceName == "" {
+		o.InstanceName = defaultInstanceName
+	} else {
+		o.DefaultAttributes = append(o.DefaultAttributes, trace.StringAttribute("sql.instance", o.InstanceName))
 	}
 
 	return &ocDriver{
 		parent:    dc.Driver(),
 		connector: dc,
-		options:   opts,
+		options:   o,
 	}
 }
 

observability.go

@@ -11,6 +11,8 @@ import (
 
 // The following tags are applied to stats recorded by this package.
 var (
+	// GoSQLInstance is the SQL instance name.
+	GoSQLInstance, _ = tag.NewKey("go_sql_instance")
 	// GoSQLMethod is the SQL method called.
 	GoSQLMethod, _ = tag.NewKey("go_sql_method")
 	// GoSQLError is the error received while calling a SQL method.
@@ -79,64 +81,71 @@ var (
 		Description: "The distribution of latencies of various calls in milliseconds",
 		Measure:     MeasureLatencyMs,
 		Aggregation: DefaultMillisecondsDistribution,
-		TagKeys:     []tag.Key{GoSQLMethod, GoSQLError, GoSQLStatus},
+		TagKeys:     []tag.Key{GoSQLInstance, GoSQLMethod, GoSQLError, GoSQLStatus},
 	}
 
 	SQLClientCallsView = &view.View{
 		Name:        "go.sql/client/calls",
 		Description: "The number of various calls of methods",
 		Measure:     MeasureLatencyMs,
 		Aggregation: view.Count(),
-		TagKeys:     []tag.Key{GoSQLMethod, GoSQLError, GoSQLStatus},
+		TagKeys:     []tag.Key{GoSQLInstance, GoSQLMethod, GoSQLError, GoSQLStatus},
 	}
 
 	SQLClientOpenConnectionsView = &view.View{
 		Name:        "go.sql/db/connections/open",
 		Description: "The number of open connections",
 		Measure:     MeasureOpenConnections,
 		Aggregation: view.LastValue(),
+		TagKeys:     []tag.Key{GoSQLInstance},
 	}
 
 	SQLClientIdleConnectionsView = &view.View{
 		Name:        "go.sql/db/connections/idle",
 		Description: "The number of idle connections",
 		Measure:     MeasureIdleConnections,
 		Aggregation: view.LastValue(),
+		TagKeys:     []tag.Key{GoSQLInstance},
 	}
 
 	SQLClientActiveConnectionsView = &view.View{
 		Name:        "go.sql/db/connections/active",
 		Description: "The number of active connections",
 		Measure:     MeasureActiveConnections,
 		Aggregation: view.LastValue(),
+		TagKeys:     []tag.Key{GoSQLInstance},
 	}
 
 	SQLClientWaitCountView = &view.View{
 		Name:        "go.sql/db/connections/wait_count",
 		Description: "The total number of connections waited for",
 		Measure:     MeasureWaitCount,
 		Aggregation: view.LastValue(),
+		TagKeys:     []tag.Key{GoSQLInstance},
 	}
 
 	SQLClientWaitDurationView = &view.View{
 		Name:        "go.sql/db/connections/wait_duration",
 		Description: "The total time blocked waiting for a new connection",
 		Measure:     MeasureWaitDuration,
 		Aggregation: view.LastValue(),
+		TagKeys:     []tag.Key{GoSQLInstance},
 	}
 
 	SQLClientIdleClosedView = &view.View{
 		Name:        "go.sql/db/connections/idle_closed_count",
 		Description: "The total number of connections closed due to SetMaxIdleConns",
 		Measure:     MeasureIdleClosed,
 		Aggregation: view.LastValue(),
+		TagKeys:     []tag.Key{GoSQLInstance},
 	}
 
 	SQLClientLifetimeClosedView = &view.View{
 		Name:        "go.sql/db/connections/lifetime_closed_count",
 		Description: "The total number of connections closed due to SetConnMaxLifetime",
 		Measure:     MeasureLifetimeClosed,
 		Aggregation: view.LastValue(),
+		TagKeys:     []tag.Key{GoSQLInstance},
 	}
 
 	DefaultViews = []*view.View{
@@ -154,7 +163,7 @@ func RegisterAllViews() {
 	}
 }
 
-func recordCallStats(ctx context.Context, method string) func(err error) {
+func recordCallStats(ctx context.Context, method, instanceName string) func(err error) {
 	var tags []tag.Mutator
 	startTime := time.Now()
 
@@ -163,11 +172,14 @@ func recordCallStats(ctx context.Context, method string) func(err error) {
 
 		if err != nil {
 			tags = []tag.Mutator{
-				tag.Insert(GoSQLMethod, method), valueErr, tag.Insert(GoSQLError, err.Error()),
+				tag.Insert(GoSQLMethod, method),
+				valueErr,
+				tag.Insert(GoSQLError, err.Error()),
+				tag.Insert(GoSQLInstance, instanceName),
 			}
 		} else {
 			tags = []tag.Mutator{
-				tag.Insert(GoSQLMethod, method), valueOK,
+				tag.Insert(GoSQLMethod, method), valueOK, tag.Insert(GoSQLInstance, instanceName),
 			}
 		}
 

options.go

@@ -7,6 +7,8 @@ import (
 // TraceOption allows for managing ocsql configuration using functional options.
 type TraceOption func(o *TraceOptions)
 
+const defaultInstanceName = "default"
+
 // TraceOptions holds configuration of our ocsql tracing middleware.
 // By default all options are set to false intentionally when creating a wrapped
 // driver and provide the most sensible default with both performance and
@@ -51,6 +53,9 @@ type TraceOptions struct {
 	// DefaultAttributes will be set to each span as default.
 	DefaultAttributes []trace.Attribute
 
+	// InstanceName identifies database.
+	InstanceName string
+
 	// DisableErrSkip, if set to true, will suppress driver.ErrSkip errors in spans.
 	DisableErrSkip bool
 
@@ -176,3 +181,10 @@ func WithSampler(sampler trace.Sampler) TraceOption {
 		o.Sampler = sampler
 	}
 }
+
+// WithInstanceName sets database instance name.
+func WithInstanceName(instanceName string) TraceOption {
+	return func(o *TraceOptions) {
+		o.InstanceName = instanceName
+	}
+}