Skip to content

sql: prep migration for sampled_query and sampled_transaction events #151949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 19, 2025
Merged

sql: prep migration for sampled_query and sampled_transaction events #151949

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/generated/eventlog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3364,6 +3364,11 @@ Fields in this struct should be updated in sync with apps_stats.proto.
An event of type `sampled_query` is the SQL query event logged to the telemetry channel. It
contains common SQL event/execution details.

Note: in version 26.1, these events will be moved to the `SQL_EXEC` channel.
To test compatability before this, set the cluster setting
`log.channel_compatibility_mode.enabled` to false. This will send the
events to `SQL_EXEC` instead of `TELEMETRY`.


| Field | Description | Sensitive |
|--|--|--|
Expand Down Expand Up @@ -3472,6 +3477,11 @@ contains common SQL event/execution details.

An event of type `sampled_transaction` is the event logged to telemetry at the end of transaction execution.

Note: in version 26.1, these events will be moved to the `SQL_EXEC` channel.
To test compatability before this, set the cluster setting
`log.channel_compatibility_mode.enabled` to false. This will send the
events to `SQL_EXEC` instead of `TELEMETRY`.


| Field | Description | Sensitive |
|--|--|--|
Expand Down
1 change: 1 addition & 0 deletions pkg/ccl/telemetryccl/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ go_test(
"//pkg/security/securityassets",
"//pkg/security/securitytest",
"//pkg/server",
"//pkg/settings",
"//pkg/sql",
"//pkg/sql/sem/tree",
"//pkg/sql/sqltestutils",
Expand Down
30 changes: 22 additions & 8 deletions pkg/ccl/telemetryccl/telemetry_logging_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"net/http"
"net/http/httptest"
"regexp"
"slices"
"strings"
"testing"

Expand All @@ -21,6 +22,7 @@ import (
"github.com/cockroachdb/cockroach/pkg/cloud/nodelocal"
"github.com/cockroachdb/cockroach/pkg/jobs"
"github.com/cockroachdb/cockroach/pkg/jobs/jobspb"
"github.com/cockroachdb/cockroach/pkg/settings"
"github.com/cockroachdb/cockroach/pkg/sql"
"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
"github.com/cockroachdb/cockroach/pkg/testutils"
Expand Down Expand Up @@ -155,20 +157,29 @@ type expectedSampleQueryEvent struct {
}

type telemetrySpy struct {
t *testing.T
t *testing.T
sv *settings.Values

sampledQueries []eventpb.SampledQuery
sampledQueriesRaw []logpb.Entry
recoveryEvents []eventpb.RecoveryEvent
}

func (l *telemetrySpy) channelsToIntercept() []log.Channel {
if log.ShouldMigrateEvent(l.sv) {
return []log.Channel{logpb.Channel_TELEMETRY, logpb.Channel_SQL_EXEC}
}

return []log.Channel{logpb.Channel_TELEMETRY}
}

func (l *telemetrySpy) Intercept(entry []byte) {
var rawLog logpb.Entry
if err := json.Unmarshal(entry, &rawLog); err != nil {
l.t.Errorf("failed unmarshaling %s: %s", entry, err)
}

if rawLog.Channel != logpb.Channel_TELEMETRY {
if !slices.Contains(l.channelsToIntercept(), rawLog.Channel) {
return
}

Expand Down Expand Up @@ -204,12 +215,6 @@ func TestBulkJobTelemetryLogging(t *testing.T) {

ctx := context.Background()

spy := &telemetrySpy{
t: t,
}
cleanup := log.InterceptWith(ctx, spy)
defer cleanup()

st := logtestutils.StubTime{}
sqm := logtestutils.StubQueryStats{}
sts := logtestutils.StubTracingStatus{}
Expand All @@ -229,6 +234,15 @@ func TestBulkJobTelemetryLogging(t *testing.T) {
ExternalIODir: dir,
},
})

spy := &telemetrySpy{
t: t,
sv: &testCluster.Server(0).ClusterSettings().SV,
}

cleanup := log.InterceptWith(ctx, spy)
defer cleanup()

sqlDB := testCluster.ServerConn(0)
defer func() {
testCluster.Stopper().Stop(context.Background())
Expand Down
13 changes: 11 additions & 2 deletions pkg/sql/exec_log.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,7 @@ func (p *planner) maybeLogStatementInternal(

*sampledQuery = eventpb.SampledQuery{
CommonSQLExecDetails: execDetails,
CommonSQLEventDetails: p.getCommonSQLEventDetails(),
SkippedQueries: skippedQueries,
CostEstimate: p.curPlan.instrumentation.costEstimate,
Distribution: p.curPlan.instrumentation.distribution.String(),
Expand Down Expand Up @@ -436,7 +437,11 @@ func (p *planner) maybeLogStatementInternal(
SchemaChangerMode: p.curPlan.instrumentation.schemaChangerMode.String(),
}

p.logEventsOnlyExternally(ctx, sampledQuery)
migrator := log.NewStructuredEventMigrator(func() bool {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's not obvious to me that logEventsOnlyExternally is equivalent to migrator.StructuredEvent

Is there some test coverage for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alyshanjahani-crl There are a decent amount of tests that cover logging SampledQuery events. The main functionality that logEventsOnlyExternally provides over using log.StructuredEvent are:

  1. It supports a variable amount of events as the last parameter, which isn't used here
  2. It adds sql event details via p.getCommonSQLEventDetails, which i added above

IMO this function should just be removed as its not a very beneficial wrapper, but I'll leave that for another PR

return log.ShouldMigrateEvent(p.ExecCfg().SV())
}, logpb.Channel_SQL_EXEC)

migrator.StructuredEvent(ctx, severity.INFO, sampledQuery)
}
}

Expand Down Expand Up @@ -521,7 +526,11 @@ func (p *planner) logTransaction(
}
}

log.StructuredEvent(ctx, severity.INFO, sampledTxn)
migrator := log.NewStructuredEventMigrator(func() bool {
return log.ShouldMigrateEvent(p.ExecCfg().SV())
}, logpb.Channel_SQL_EXEC)

migrator.StructuredEvent(ctx, severity.INFO, sampledTxn)
}

func (p *planner) logEventsOnlyExternally(ctx context.Context, entries ...logpb.EventPayload) {
Expand Down
9 changes: 4 additions & 5 deletions pkg/sql/telemetry_datadriven_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,12 @@ func TestTelemetryLoggingDataDriven(t *testing.T) {

sc := log.Scope(t)
defer sc.Close(t)

appName := "telemetry-logging-datadriven"
ignoredAppname := "telemetry-datadriven-ignored-appname"
ctx := context.Background()
stmtSpy := logtestutils.NewStructuredLogSpy(
t,
[]logpb.Channel{logpb.Channel_TELEMETRY},
[]logpb.Channel{logpb.Channel_TELEMETRY, logpb.Channel_SQL_EXEC},
[]string{"sampled_query"},
logtestutils.FormatEntryAsJSON,
func(_ logpb.Entry, logStr string) bool {
Expand All @@ -79,7 +78,7 @@ func TestTelemetryLoggingDataDriven(t *testing.T) {

txnsSpy := logtestutils.NewStructuredLogSpy(
t,
[]logpb.Channel{logpb.Channel_TELEMETRY},
[]logpb.Channel{logpb.Channel_TELEMETRY, logpb.Channel_SQL_EXEC},
[]string{"sampled_transaction"},
logtestutils.FormatEntryAsJSON,
func(_ logpb.Entry, logStr string) bool {
Expand Down Expand Up @@ -209,13 +208,13 @@ func TestTelemetryLoggingDataDriven(t *testing.T) {
}

newStmtLogCount := stmtSpy.Count()
sb.WriteString(strings.Join(stmtSpy.GetLastNLogs(logpb.Channel_TELEMETRY, newStmtLogCount-stmtLogCount), "\n"))
sb.WriteString(strings.Join(stmtSpy.GetLastNLogs(getSampleQueryLoggingChannel(&s.ClusterSettings().SV), newStmtLogCount-stmtLogCount), "\n"))
if newStmtLogCount > stmtLogCount {
sb.WriteString("\n")
}

newTxnLogCount := txnsSpy.Count()
sb.WriteString(strings.Join(txnsSpy.GetLastNLogs(logpb.Channel_TELEMETRY, newTxnLogCount-txnLogCount), "\n"))
sb.WriteString(strings.Join(txnsSpy.GetLastNLogs(getSampleQueryLoggingChannel(&s.ClusterSettings().SV), newTxnLogCount-txnLogCount), "\n"))
return sb.String()
case "reset-last-sampled":
telemetryLogging.resetLastSampledTime()
Expand Down
Loading