Skip to content

Commit

Permalink
Refactor OpenTelemetry setup and metric collection in integration tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@mantzas
mantzas committed Jun 10, 2024
1 parent c444a9e commit c0e0edc
Showing 1 changed file with 38 additions and 42 deletions.
80 changes: 38 additions & 42 deletions client/sql/integration_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,15 @@ func TestIntegration(t *testing.T) {
exp.Reset()
assert.NoError(t, db.Ping(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Ping", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Ping", "")
})

t.Run("db.Stats", func(t *testing.T) {
exp.Reset()
stats := db.Stats(ctx)
assert.NotNil(t, stats)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Stats", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Stats", "")
})

t.Run("db.Exec", func(t *testing.T) {
Expand All @@ -104,7 +104,7 @@ func TestIntegration(t *testing.T) {
assert.NoError(t, err)
assert.NotNil(t, result)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Exec", insertQuery, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Exec", insertQuery)
})

t.Run("db.Query", func(t *testing.T) {
Expand All @@ -116,39 +116,39 @@ func TestIntegration(t *testing.T) {
assert.NoError(t, err)
assert.NotNil(t, rows)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Query", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Query", query)
})

t.Run("db.QueryRow", func(t *testing.T) {
exp.Reset()
row := db.QueryRow(ctx, query)
assert.NotNil(t, row)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.QueryRow", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.QueryRow", query)
})

t.Run("db.Driver", func(t *testing.T) {
exp.Reset()
drv := db.Driver(ctx)
assert.NotNil(t, drv)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Driver", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Driver", "")
})

t.Run("stmt", func(t *testing.T) {
exp.Reset()
stmt, err := db.Prepare(ctx, query)
assert.NoError(t, err)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Prepare", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Prepare", query)

t.Run("stmt.Exec", func(t *testing.T) {
exp.Reset()
result, err := stmt.Exec(ctx)
assert.NoError(t, err)
assert.NotNil(t, result)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Exec", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Exec", query)
})

t.Run("stmt.Query", func(t *testing.T) {
Expand All @@ -159,35 +159,35 @@ func TestIntegration(t *testing.T) {
assert.NoError(t, rows.Close())
}()
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Query", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Query", query)
})

t.Run("stmt.QueryRow", func(t *testing.T) {
exp.Reset()
row := stmt.QueryRow(ctx)
assert.NotNil(t, row)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.QueryRow", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.QueryRow", query)
})

exp.Reset()
assert.NoError(t, stmt.Close(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Close", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Close", "")
})

t.Run("conn", func(t *testing.T) {
exp.Reset()
conn, err := db.Conn(ctx)
assert.NoError(t, err)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Conn", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Conn", "")

t.Run("conn.Ping", func(t *testing.T) {
exp.Reset()
assert.NoError(t, conn.Ping(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.Ping", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.Ping", "")
})

t.Run("conn.Exec", func(t *testing.T) {
Expand All @@ -196,7 +196,7 @@ func TestIntegration(t *testing.T) {
assert.NoError(t, err)
assert.NotNil(t, result)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.Exec", insertQuery, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.Exec", insertQuery)
})

t.Run("conn.Query", func(t *testing.T) {
Expand All @@ -207,7 +207,7 @@ func TestIntegration(t *testing.T) {
assert.NoError(t, rows.Close())
}()
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.Query", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.Query", query)
})

t.Run("conn.QueryRow", func(t *testing.T) {
Expand All @@ -217,37 +217,37 @@ func TestIntegration(t *testing.T) {
var name string
assert.NoError(t, row.Scan(&id, &name))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.QueryRow", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.QueryRow", query)
})

t.Run("conn.Prepare", func(t *testing.T) {
exp.Reset()
stmt, err := conn.Prepare(ctx, query)
assert.NoError(t, err)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.Prepare", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.Prepare", query)
exp.Reset()
assert.NoError(t, stmt.Close(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Close", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Close", "")
})

t.Run("conn.BeginTx", func(t *testing.T) {
exp.Reset()
tx, err := conn.BeginTx(ctx, nil)
assert.NoError(t, err)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.BeginTx", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.BeginTx", "")
exp.Reset()
assert.NoError(t, tx.Commit(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Commit", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Commit", "")
})

exp.Reset()
assert.NoError(t, conn.Close(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.Close", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "conn.Close", "")
})

t.Run("tx", func(t *testing.T) {
Expand All @@ -256,15 +256,15 @@ func TestIntegration(t *testing.T) {
assert.NoError(t, err)
assert.NotNil(t, tx)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.BeginTx", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.BeginTx", "")

t.Run("tx.Exec", func(t *testing.T) {
exp.Reset()
result, err := tx.Exec(ctx, insertQuery, "patron")
assert.NoError(t, err)
assert.NotNil(t, result)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Exec", insertQuery, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Exec", insertQuery)
})

t.Run("tx.Query", func(t *testing.T) {
Expand All @@ -275,7 +275,7 @@ func TestIntegration(t *testing.T) {
assert.NoError(t, rows.Close())
}()
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Query", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Query", query)
})

t.Run("tx.QueryRow", func(t *testing.T) {
Expand All @@ -285,39 +285,39 @@ func TestIntegration(t *testing.T) {
var name string
assert.NoError(t, row.Scan(&id, &name))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.QueryRow", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.QueryRow", query)
})

t.Run("tx.Prepare", func(t *testing.T) {
exp.Reset()
stmt, err := tx.Prepare(ctx, query)
assert.NoError(t, err)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Prepare", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Prepare", query)
exp.Reset()
assert.NoError(t, stmt.Close(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Close", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Close", "")
})

t.Run("tx.Stmt", func(t *testing.T) {
exp.Reset()
stmt, err := db.Prepare(ctx, query)
assert.NoError(t, err)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Prepare", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Prepare", query)
exp.Reset()
txStmt := tx.Stmt(ctx, stmt)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Stmt", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Stmt", query)
exp.Reset()
assert.NoError(t, txStmt.Close(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Close", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Close", "")
exp.Reset()
assert.NoError(t, stmt.Close(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Close", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "stmt.Close", "")
})

t.Run("tx.Rollback", func(t *testing.T) {
Expand All @@ -326,32 +326,32 @@ func TestIntegration(t *testing.T) {
assert.NoError(t, err)
assert.NotNil(t, db)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.BeginTx", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.BeginTx", "")
exp.Reset()
row := tx.QueryRow(ctx, query)
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.QueryRow", query, 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.QueryRow", query)
var id int
var name string
assert.NoError(t, row.Scan(&id, &name))
exp.Reset()
assert.NoError(t, tx.Rollback(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Rollback", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Rollback", "")
})

exp.Reset()
assert.NoError(t, tx.Commit(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Commit", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "tx.Commit", "")
exp.Reset()
assert.NoError(t, db.Close(ctx))
assert.NoError(t, tracePublisher.ForceFlush(ctx))
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Close", "", 1)
assertSpanAndMetric(t, exp.GetSpans(), read, "db.Close", "")
})
}

func assertSpanAndMetric(t *testing.T, spans tracetest.SpanStubs, read *metric.ManualReader, opName, statement string, metricCount int) {
func assertSpanAndMetric(t *testing.T, spans tracetest.SpanStubs, read *metric.ManualReader, opName, statement string) {
assert.Len(t, spans, 1)
assert.Equal(t, opName, spans[0].Name)
for _, v := range spans[0].Attributes {
Expand All @@ -370,9 +370,5 @@ func assertSpanAndMetric(t *testing.T, spans tracetest.SpanStubs, read *metric.M
// Metrics
collectedMetrics := &metricdata.ResourceMetrics{}
assert.NoError(t, read.Collect(context.Background(), collectedMetrics))
assert.Equal(t, metricCount, len(collectedMetrics.ScopeMetrics))

// TODO: Fix metric collection.
// assert.Equal(t, metricCount, testutil.CollectAndCount(opDurationMetrics, "client_sql_cmd_duration_seconds"))
// opDurationMetrics.Reset()
assert.Equal(t, 1, len(collectedMetrics.ScopeMetrics))
}

0 comments on commit c0e0edc

Please sign in to comment.