Merge pull request cockroachdb#84848 from THardy98/backport21.2-84195

release-21.2: sql: Add database ID to sampled query log
THardy98 · Jul 21, 2022 · 0009dbf · 0009dbf
2 parents b0b7bda + c633d13
commit 0009dbf
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 46 deletions.
diff --git a/docs/generated/eventlog.md b/docs/generated/eventlog.md
@@ -2244,6 +2244,7 @@ contains common SQL event/execution details.
 | `Database` | Name of the database that initiated the query. | no |
 | `StatementID` | Statement ID of the query. | no |
 | `TransactionID` | Transaction ID of the query. | no |
+| `DatabaseID` | Database ID of the query. | no |
 
 
 #### Common fields

diff --git a/pkg/sql/exec_log.go b/pkg/sql/exec_log.go
@@ -377,7 +377,8 @@ func (p *planner) maybeLogStatementInternal(
 		}
 		if telemetryMetrics.maybeUpdateLastEmittedTime(telemetryMetrics.timeNow(), requiredTimeElapsed) {
 			skippedQueries := telemetryMetrics.resetSkippedQueryCount()
-			p.logOperationalEventsOnlyExternally(ctx, eventLogEntry{event: &eventpb.SampledQuery{
+			databaseName := p.CurrentDatabase()
+			sampledQuery := eventpb.SampledQuery{
 				CommonSQLExecDetails: execDetails,
 				SkippedQueries:       skippedQueries,
 				CostEstimate:         p.curPlan.instrumentation.costEstimate,
@@ -386,7 +387,12 @@ func (p *planner) maybeLogStatementInternal(
 				Database:             p.CurrentDatabase(),
 				StatementID:          p.stmt.QueryID.String(),
 				TransactionID:        p.txn.ID().String(),
-			}})
+			}
+			db, _ := p.Descriptors().GetImmutableDatabaseByName(ctx, p.txn, databaseName, tree.DatabaseLookupFlags{Required: true})
+			if db != nil {
+				sampledQuery.DatabaseID = uint32(db.GetID())
+			}
+			p.logOperationalEventsOnlyExternally(ctx, eventLogEntry{event: &sampledQuery})
 		} else {
 			telemetryMetrics.incSkippedQueryCount()
 		}

diff --git a/pkg/sql/telemetry_logging_test.go b/pkg/sql/telemetry_logging_test.go
@@ -12,9 +12,11 @@ package sql
 
 import (
 	"context"
+	gosql "database/sql"
 	"fmt"
 	"math"
 	"regexp"
+	"strconv"
 	"strings"
 	"testing"
 	"time"
@@ -94,10 +96,14 @@ func TestTelemetryLogging(t *testing.T) {
 
 	var sessionID string
 	var databaseName string
+	var dbID uint32
 
 	db := sqlutils.MakeSQLRunner(sqlDB)
+	conn := db.DB.(*gosql.DB)
+
 	db.QueryRow(t, `SHOW session_id`).Scan(&sessionID)
 	db.QueryRow(t, `SHOW database`).Scan(&databaseName)
+	dbID = sqlutils.QueryDatabaseID(t, conn, databaseName)
 	db.Exec(t, `SET application_name = 'telemetry-logging-test'`)
 	db.Exec(t, `SET CLUSTER SETTING sql.telemetry.query_sampling.enabled = true;`)
 	db.Exec(t, "CREATE TABLE t();")
@@ -263,6 +269,9 @@ func TestTelemetryLogging(t *testing.T) {
 				if !strings.Contains(e.Message, "\"Database\":\""+databaseName+"\"") {
 					t.Errorf("expected to find Database: %s", databaseName)
 				}
+				if !strings.Contains(e.Message, "\"DatabaseID\":"+strconv.Itoa(int(dbID))) {
+					t.Errorf("expected to find DatabaseID: %v", dbID)
+				}
 			}
 		}
 		if logCount != expectedLogCount {

diff --git a/pkg/util/log/eventpb/json_encode_generated.go b/pkg/util/log/eventpb/json_encode_generated.go
diff --git a/pkg/util/log/eventpb/telemetry.pb.go b/pkg/util/log/eventpb/telemetry.pb.go
diff --git a/pkg/util/log/eventpb/telemetry.proto b/pkg/util/log/eventpb/telemetry.proto
@@ -55,6 +55,9 @@ message SampledQuery {
 
   // Transaction ID of the query.
   string transaction_id = 11 [(gogoproto.customname) = "TransactionID", (gogoproto.jsontag) = ',omitempty', (gogoproto.moretags) = "redact:\"nonsensitive\""];
+
+  // Database ID of the query.
+  uint32 database_id = 12 [(gogoproto.customname) = "DatabaseID", (gogoproto.jsontag) = ",omitempty"];
 }
 
 // CapturedIndexUsageStats