From 0845ca67267ff6b74510d8c77c4891c028513cc1 Mon Sep 17 00:00:00 2001 From: Thomas Hardy Date: Thu, 14 Jul 2022 16:37:12 -0400 Subject: [PATCH] sql: add troubleshooting mode session variable Resolves: #84429 This change introduces a `troubleshooting_mode_enabled` session variable. When enabled, this session variable is intended to be used as a way to avoid performing additional work on queries, particularly when the cluster is experiencing issues/unavailability/failure. By default, this session variable is disabled. Currently, this session variable is only used to avoid collecting/emitting telemetry data. Release note (sql change): Introduce new `troubleshooting_mode_enabled` session variable, to avoid doing additional work on queries when possible (i.e. collection telemetry data). By default, this session variable is disabled. --- pkg/cli/clisqlcfg/context.go | 12 ++ .../test_client_side_checking.tcl | 6 + pkg/sql/exec_log.go | 2 +- pkg/sql/exec_util.go | 4 + .../testdata/logic_test/information_schema | 1 + .../logictest/testdata/logic_test/pg_catalog | 3 + .../logictest/testdata/logic_test/show_source | 1 + pkg/sql/sessiondatapb/session_data.pb.go | 174 +++++++++++------- pkg/sql/sessiondatapb/session_data.proto | 5 + pkg/sql/telemetry_logging_test.go | 109 +++++++++++ pkg/sql/vars.go | 17 ++ 11 files changed, 266 insertions(+), 68 deletions(-) diff --git a/pkg/cli/clisqlcfg/context.go b/pkg/cli/clisqlcfg/context.go index 76a640b0ddc7..eb60e2bc5f16 100644 --- a/pkg/cli/clisqlcfg/context.go +++ b/pkg/cli/clisqlcfg/context.go @@ -204,6 +204,18 @@ func (c *Context) Run(conn clisqlclient.Conn) error { } } + if err := c.maybeSetTroubleshootingMode(conn); err != nil { + return err + } + shell := clisqlshell.NewShell(c.CliCtx, c.ConnCtx, c.ExecCtx, &c.ShellCtx, conn) return shell.RunInteractive(c.cmdIn, c.CmdOut, c.CmdErr) } + +func (c *Context) maybeSetTroubleshootingMode(conn clisqlclient.Conn) error { + if !c.ConnCtx.DebugMode { + return nil + } + // If we are in debug mode, enable "troubleshooting mode". + return conn.Exec("SET troubleshooting_mode = on", nil) +} diff --git a/pkg/cli/interactive_tests/test_client_side_checking.tcl b/pkg/cli/interactive_tests/test_client_side_checking.tcl index 3f1e58b0483a..9df64c66086c 100644 --- a/pkg/cli/interactive_tests/test_client_side_checking.tcl +++ b/pkg/cli/interactive_tests/test_client_side_checking.tcl @@ -80,6 +80,12 @@ end_test start_test "Check that --debug-sql-cli sets suitable simplified client-side options." send "$argv sql --debug-sql-cli\r" eexpect "Welcome" + +# Check that troubleshooting mode is enabled in debug mode. +eexpect "root@" +send "show troubleshooting_mode;\r" +eexpect "on" + eexpect "root@" send "\\set display_format csv\r\\set\r" eexpect "check_syntax,false" diff --git a/pkg/sql/exec_log.go b/pkg/sql/exec_log.go index 570e7a617fdf..28c69aa638da 100644 --- a/pkg/sql/exec_log.go +++ b/pkg/sql/exec_log.go @@ -368,7 +368,7 @@ func (p *planner) maybeLogStatementInternal( p.logEventsOnlyExternally(ctx, eventLogEntry{event: &eventpb.AdminQuery{CommonSQLExecDetails: execDetails}}) } - if telemetryLoggingEnabled { + if telemetryLoggingEnabled && !p.SessionData().TroubleshootingMode { // We only log to the telemetry channel if enough time has elapsed from // the last event emission. requiredTimeElapsed := 1.0 / float64(maxEventFrequency) diff --git a/pkg/sql/exec_util.go b/pkg/sql/exec_util.go index 59a88cbaa384..c919b0e15520 100644 --- a/pkg/sql/exec_util.go +++ b/pkg/sql/exec_util.go @@ -2984,6 +2984,10 @@ func (m *sessionDataMutator) SetMultipleModificationsOfTable(val bool) { m.data.MultipleModificationsOfTable = val } +func (m *sessionDataMutator) SetTroubleshootingModeEnabled(val bool) { + m.data.TroubleshootingMode = val +} + // Utility functions related to scrubbing sensitive information on SQL Stats. // quantizeCounts ensures that the Count field in the diff --git a/pkg/sql/logictest/testdata/logic_test/information_schema b/pkg/sql/logictest/testdata/logic_test/information_schema index d869dba245d7..f569d36e1455 100644 --- a/pkg/sql/logictest/testdata/logic_test/information_schema +++ b/pkg/sql/logictest/testdata/logic_test/information_schema @@ -4690,6 +4690,7 @@ transaction_rows_read_log 0 transaction_rows_written_err 0 transaction_rows_written_log 0 transaction_status NoTxn +troubleshooting_mode off # information_schema can be used with the anonymous database. # It should show information across all databases. diff --git a/pkg/sql/logictest/testdata/logic_test/pg_catalog b/pkg/sql/logictest/testdata/logic_test/pg_catalog index 545fb69e6a77..2bf54bbf4562 100644 --- a/pkg/sql/logictest/testdata/logic_test/pg_catalog +++ b/pkg/sql/logictest/testdata/logic_test/pg_catalog @@ -4117,6 +4117,7 @@ transaction_rows_read_log 0 NULL transaction_rows_written_err 0 NULL NULL NULL string transaction_rows_written_log 0 NULL NULL NULL string transaction_status NoTxn NULL NULL NULL string +troubleshooting_mode off NULL NULL NULL string vectorize on NULL NULL NULL string query TTTTTTT colnames @@ -4220,6 +4221,7 @@ transaction_rows_read_log 0 NULL transaction_rows_written_err 0 NULL user NULL 0 0 transaction_rows_written_log 0 NULL user NULL 0 0 transaction_status NoTxn NULL user NULL NoTxn NoTxn +troubleshooting_mode off NULL user NULL off off vectorize on NULL user NULL on on query TTTTTT colnames @@ -4321,6 +4323,7 @@ transaction_rows_read_log NULL NULL NULL transaction_rows_written_err NULL NULL NULL NULL NULL transaction_rows_written_log NULL NULL NULL NULL NULL transaction_status NULL NULL NULL NULL NULL +troubleshooting_mode NULL NULL NULL NULL NULL vectorize NULL NULL NULL NULL NULL # pg_catalog.pg_sequence diff --git a/pkg/sql/logictest/testdata/logic_test/show_source b/pkg/sql/logictest/testdata/logic_test/show_source index 7cdcb903e0fa..563453caeff1 100644 --- a/pkg/sql/logictest/testdata/logic_test/show_source +++ b/pkg/sql/logictest/testdata/logic_test/show_source @@ -118,6 +118,7 @@ transaction_rows_read_log 0 transaction_rows_written_err 0 transaction_rows_written_log 0 transaction_status NoTxn +troubleshooting_mode off vectorize on query T colnames diff --git a/pkg/sql/sessiondatapb/session_data.pb.go b/pkg/sql/sessiondatapb/session_data.pb.go index dad8ba30c405..d418101ad768 100644 --- a/pkg/sql/sessiondatapb/session_data.pb.go +++ b/pkg/sql/sessiondatapb/session_data.pb.go @@ -157,6 +157,10 @@ type SessionData struct { // OnUpdateRehomeRowEnabled controls whether the ON UPDATE rehome_row() // will actually trigger on row updates. OnUpdateRehomeRowEnabled bool `protobuf:"varint,17,opt,name=on_update_rehome_row_enabled,json=onUpdateRehomeRowEnabled,proto3" json:"on_update_rehome_row_enabled,omitempty"` + // Troubleshooting mode determines whether we refuse to do additional work with + // the query (i.e. collect & emit telemetry data). Troubleshooting mode is + // disabled by default. + TroubleshootingMode bool `protobuf:"varint,21,opt,name=troubleshooting_mode,json=troubleshootingMode,proto3" json:"troubleshooting_mode,omitempty"` } func (m *SessionData) Reset() { *m = SessionData{} } @@ -319,73 +323,74 @@ func init() { } var fileDescriptor_9fa1c5a4e61eec38 = []byte{ - // 1041 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x84, 0x54, 0x4f, 0x6f, 0x1b, 0x45, - 0x14, 0xf7, 0xc6, 0x49, 0x6a, 0x8f, 0x63, 0x67, 0x33, 0x4d, 0xab, 0x25, 0x0d, 0x6b, 0x13, 0x21, - 0xe4, 0x46, 0x68, 0x0d, 0xa1, 0xe2, 0x58, 0x09, 0x37, 0x89, 0x88, 0xd4, 0x94, 0xb0, 0x26, 0x45, - 0xe2, 0xc0, 0x68, 0xbc, 0xfb, 0x6c, 0x0f, 0xd9, 0x9d, 0x59, 0xef, 0x8c, 0xf3, 0x8f, 0x2f, 0xc0, - 0x91, 0x23, 0x77, 0x38, 0xf0, 0x3d, 0xb8, 0xe4, 0x82, 0xd4, 0x63, 0xc5, 0x21, 0x40, 0xf2, 0x2d, - 0x38, 0xa1, 0x19, 0xaf, 0xd7, 0x71, 0x5a, 0xa5, 0xa7, 0x9d, 0xf7, 0xde, 0xef, 0xf7, 0xe6, 0xed, - 0xfb, 0xcd, 0x7b, 0xe8, 0x43, 0x39, 0x8c, 0x5a, 0x12, 0xa4, 0x64, 0x82, 0x87, 0x54, 0xd1, 0xa4, - 0x3b, 0xb1, 0x88, 0x36, 0xbd, 0x24, 0x15, 0x4a, 0xe0, 0x47, 0x81, 0x08, 0x8e, 0x52, 0x41, 0x83, - 0x81, 0x27, 0x87, 0x91, 0x37, 0x83, 0x5f, 0x5b, 0x1f, 0x29, 0x16, 0xb5, 0xc2, 0x51, 0x4a, 0x15, - 0x13, 0x3c, 0x3f, 0x8c, 0xa9, 0x6b, 0x1f, 0x98, 0xa8, 0x62, 0x31, 0x98, 0x43, 0xd2, 0x0f, 0xa9, - 0x82, 0xec, 0x93, 0x41, 0x56, 0xfb, 0xa2, 0x2f, 0xcc, 0xb1, 0xa5, 0x4f, 0x99, 0xd7, 0xed, 0x0b, - 0xd1, 0x8f, 0xa0, 0x65, 0xac, 0xee, 0xa8, 0x77, 0x2b, 0xf1, 0xc6, 0x5f, 0xf7, 0x50, 0xa5, 0x33, - 0x2e, 0x64, 0x9b, 0x2a, 0x8a, 0xd7, 0x50, 0x49, 0x17, 0xd4, 0xa5, 0x12, 0x1c, 0xab, 0x61, 0x35, - 0xcb, 0x7e, 0x6e, 0xe3, 0xc7, 0xc8, 0xa6, 0x49, 0x12, 0xb1, 0xc0, 0x24, 0x20, 0x9c, 0xc6, 0xe0, - 0xcc, 0x19, 0xcc, 0xf2, 0x0d, 0xff, 0x0b, 0x1a, 0x03, 0xa6, 0x08, 0x8d, 0x24, 0xa4, 0xc4, 0x5c, - 0xe2, 0x14, 0x35, 0xa8, 0xdd, 0xfe, 0xef, 0xb2, 0xfe, 0xb4, 0xcf, 0xd4, 0x60, 0xd4, 0xf5, 0x02, - 0x11, 0xb7, 0xf2, 0x6e, 0x84, 0xdd, 0xe9, 0xb9, 0x95, 0x1c, 0xf5, 0x5b, 0x12, 0x82, 0x51, 0xca, - 0xd4, 0x99, 0xd7, 0xf9, 0xfa, 0xf9, 0xa1, 0x84, 0x54, 0xdf, 0x74, 0xa0, 0x33, 0xf9, 0x65, 0x9d, - 0xd5, 0x1c, 0x71, 0x8c, 0x1e, 0xea, 0xca, 0x48, 0x20, 0xf8, 0x31, 0xa4, 0xa6, 0xd7, 0x81, 0xe0, - 0x3d, 0xd6, 0x77, 0xe6, 0x1b, 0x56, 0xb3, 0xb2, 0xf5, 0xa9, 0x77, 0x47, 0xbb, 0x3d, 0xfd, 0xb3, - 0xcf, 0x72, 0xe6, 0x33, 0x43, 0x6c, 0xcf, 0x5f, 0x5c, 0xd6, 0x0b, 0xfe, 0x6a, 0xf8, 0x96, 0x18, - 0x3e, 0x44, 0xb5, 0x63, 0x08, 0x94, 0x48, 0xd9, 0x39, 0x90, 0x58, 0x84, 0xe0, 0x2c, 0x34, 0xac, - 0x66, 0x6d, 0xcb, 0xbb, 0xf3, 0x9a, 0x97, 0x13, 0xca, 0xce, 0x29, 0x04, 0xfb, 0x22, 0x04, 0xbf, - 0x9a, 0x67, 0xd1, 0x26, 0xde, 0x41, 0x75, 0x05, 0x52, 0x31, 0xde, 0x27, 0xd3, 0xf4, 0x8c, 0xff, - 0x00, 0x81, 0x22, 0x09, 0xe5, 0x2c, 0x90, 0xce, 0x62, 0xc3, 0x6a, 0x96, 0xfc, 0xf5, 0x0c, 0x96, - 0x67, 0xdc, 0x33, 0xa0, 0x03, 0x83, 0xc1, 0x4d, 0x64, 0x87, 0xd0, 0xa3, 0xa3, 0x48, 0x11, 0xc6, - 0x15, 0x91, 0xec, 0x1c, 0x9c, 0x7b, 0x0d, 0xab, 0xb9, 0xe0, 0xd7, 0x32, 0xff, 0x1e, 0x57, 0x1d, - 0x76, 0x0e, 0x5a, 0xe0, 0x48, 0x8c, 0x95, 0x72, 0x4a, 0x63, 0x81, 0x27, 0x36, 0xae, 0xa3, 0x8a, - 0x04, 0x9a, 0x06, 0x03, 0x92, 0x50, 0x35, 0x70, 0xca, 0x8d, 0x62, 0xb3, 0xec, 0xa3, 0xb1, 0xeb, - 0x80, 0xaa, 0x01, 0xde, 0x42, 0x0f, 0x14, 0xc4, 0x89, 0x48, 0x69, 0x7a, 0x46, 0x64, 0x30, 0x80, - 0x98, 0x8e, 0x9f, 0x01, 0x32, 0x99, 0xee, 0xe7, 0xc1, 0x8e, 0x89, 0x99, 0xa7, 0xb0, 0x8f, 0xca, - 0x12, 0x86, 0x44, 0x2a, 0xaa, 0xc0, 0xa9, 0x18, 0x69, 0x36, 0xef, 0xec, 0x59, 0x07, 0x86, 0x23, - 0xe0, 0x01, 0x74, 0x34, 0x23, 0xd3, 0xa4, 0x24, 0x61, 0x68, 0x6c, 0xbc, 0x81, 0x96, 0xbe, 0x15, - 0xe9, 0xd1, 0x3e, 0xc4, 0xcf, 0x59, 0xcc, 0x94, 0xb3, 0xd4, 0xb0, 0x9a, 0x45, 0x7f, 0xc6, 0x87, - 0x9f, 0xa0, 0x87, 0x8c, 0x2b, 0x48, 0x8f, 0x69, 0x44, 0xa4, 0x3a, 0x8b, 0x80, 0x00, 0xa7, 0xdd, - 0x08, 0x42, 0xa7, 0x6a, 0x7a, 0xb9, 0x3a, 0x89, 0x76, 0x74, 0x70, 0x67, 0x1c, 0xc3, 0x1f, 0x23, - 0xac, 0xc7, 0xe9, 0x16, 0xa3, 0x66, 0x18, 0xb6, 0x8e, 0xcc, 0xa0, 0x77, 0xd1, 0x52, 0x24, 0x82, - 0x23, 0xa2, 0x67, 0x52, 0x8c, 0x94, 0xb3, 0x6c, 0xfe, 0xec, 0x3d, 0x6f, 0x3c, 0x6f, 0xde, 0x64, - 0xde, 0xbc, 0xed, 0x6c, 0xde, 0xda, 0x25, 0xfd, 0x23, 0xbf, 0xfc, 0x5d, 0xb7, 0xfc, 0x8a, 0x26, - 0x7e, 0x33, 0xe6, 0x69, 0x3d, 0x4c, 0x35, 0x9c, 0x46, 0x8e, 0x6d, 0xee, 0xca, 0x6d, 0xfc, 0x14, - 0xad, 0x0b, 0x4e, 0x46, 0x89, 0x29, 0x2b, 0x85, 0x81, 0x88, 0x81, 0xa4, 0xe2, 0x24, 0xaf, 0x6d, - 0xc5, 0xe0, 0x1d, 0xc1, 0x0f, 0x0d, 0xc4, 0x37, 0x08, 0x5f, 0x9c, 0x64, 0x35, 0x6e, 0xfc, 0x31, - 0x87, 0x56, 0xdf, 0xf6, 0xd0, 0xf1, 0xf7, 0xe8, 0x7e, 0xf7, 0x4c, 0x81, 0x24, 0xc0, 0x03, 0x11, - 0x02, 0xe9, 0x89, 0x34, 0xa6, 0xca, 0x0c, 0xfc, 0xbb, 0x5e, 0x74, 0x5b, 0xf3, 0x76, 0x0c, 0x6d, - 0xd7, 0xb0, 0xfc, 0x95, 0xee, 0x6d, 0x97, 0x6e, 0x25, 0x9c, 0xaa, 0x94, 0x92, 0x5e, 0x24, 0xa8, - 0x22, 0x21, 0xeb, 0x33, 0x25, 0xcd, 0xae, 0x58, 0xf0, 0x6d, 0x13, 0xd9, 0xd5, 0x81, 0x6d, 0xe3, - 0xc7, 0xfb, 0xa8, 0x36, 0x2b, 0x97, 0x59, 0x18, 0xb5, 0xad, 0x8f, 0x6e, 0x14, 0xa2, 0xd7, 0x9e, - 0x97, 0xef, 0xae, 0xbd, 0x9b, 0xfa, 0xf9, 0xd5, 0x19, 0x39, 0xf1, 0x0b, 0x84, 0xa6, 0x3a, 0x66, - 0xcb, 0xe0, 0xf1, 0xed, 0x54, 0x93, 0x55, 0xea, 0x65, 0x3b, 0x74, 0x7b, 0xa2, 0x6f, 0xf6, 0xe0, - 0xca, 0xb9, 0xe0, 0x1b, 0x7f, 0x5a, 0xa8, 0x3a, 0xf3, 0x26, 0x71, 0x1b, 0xcd, 0x4b, 0x18, 0x4a, - 0xc7, 0x6a, 0x14, 0x9b, 0x95, 0x77, 0xf4, 0x6b, 0x86, 0xa9, 0x2d, 0xdf, 0x70, 0xf1, 0x27, 0x68, - 0x35, 0xa2, 0x52, 0x11, 0x3d, 0x1b, 0x8c, 0x07, 0x29, 0xc4, 0xc0, 0x15, 0x84, 0xa6, 0x49, 0x55, - 0x1f, 0xeb, 0x58, 0x07, 0x86, 0x7b, 0xd3, 0xc8, 0xda, 0x2e, 0x2a, 0x76, 0x60, 0x88, 0x1b, 0x68, - 0xd1, 0x70, 0x42, 0x23, 0x57, 0xb5, 0x5d, 0xbe, 0xba, 0xac, 0x2f, 0x68, 0xe8, 0xb6, 0xbf, 0x20, - 0x61, 0xb8, 0x17, 0xe2, 0xf7, 0x11, 0x8a, 0xa8, 0x5e, 0x17, 0xe4, 0x98, 0x46, 0x26, 0x61, 0xd1, - 0x2f, 0x8f, 0x3d, 0x2f, 0x69, 0xb4, 0x49, 0xd0, 0xca, 0x1b, 0x22, 0x62, 0x8c, 0x6a, 0x37, 0x9c, - 0x5f, 0xc2, 0xa9, 0x5d, 0xc0, 0x0f, 0x66, 0x80, 0x3b, 0x32, 0xa0, 0x09, 0xd8, 0xd6, 0x2d, 0x77, - 0x9b, 0x4a, 0xf8, 0xfc, 0x89, 0x3d, 0xb7, 0x56, 0xfa, 0xe9, 0x57, 0xb7, 0xf0, 0xfb, 0x6f, 0x6e, - 0x61, 0xf3, 0x47, 0xb4, 0xf2, 0xc6, 0xde, 0xd3, 0x17, 0xe4, 0xce, 0x43, 0x2e, 0x41, 0xd9, 0x05, - 0xbc, 0x8c, 0x2a, 0xb9, 0xef, 0x2b, 0x6e, 0xcf, 0xe1, 0x3a, 0x7a, 0x74, 0x83, 0x99, 0x40, 0xca, - 0xf4, 0xbf, 0xd3, 0xe8, 0x8b, 0xe8, 0x84, 0x9e, 0x49, 0xbb, 0x88, 0x6d, 0xb4, 0x34, 0x65, 0xf4, - 0x7a, 0xf6, 0xfc, 0xf4, 0xda, 0x8d, 0xf9, 0x92, 0x65, 0x5b, 0xed, 0xd6, 0xc5, 0xbf, 0x6e, 0xe1, - 0xe2, 0xca, 0xb5, 0x5e, 0x5d, 0xb9, 0xd6, 0xeb, 0x2b, 0xd7, 0xfa, 0xe7, 0xca, 0xb5, 0x7e, 0xbe, - 0x76, 0x0b, 0xaf, 0xae, 0xdd, 0xc2, 0xeb, 0x6b, 0xb7, 0xf0, 0x5d, 0x75, 0x46, 0xa0, 0xee, 0xa2, - 0x19, 0xd5, 0xcf, 0xfe, 0x0f, 0x00, 0x00, 0xff, 0xff, 0xd8, 0x22, 0x3c, 0x01, 0xc4, 0x07, 0x00, - 0x00, + // 1063 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x84, 0x54, 0x4f, 0x6f, 0xe3, 0x44, + 0x14, 0x8f, 0x9b, 0xb6, 0x24, 0x93, 0x26, 0x75, 0xa7, 0xe9, 0xca, 0x74, 0x8b, 0x13, 0x2a, 0x84, + 0xb2, 0x15, 0x72, 0xd8, 0xb2, 0xe2, 0xb8, 0x12, 0xd9, 0xb6, 0xa2, 0xd2, 0x76, 0x29, 0x0e, 0x5d, + 0x24, 0x0e, 0x8c, 0x26, 0xf6, 0x4b, 0x32, 0xd4, 0xf6, 0x38, 0x9e, 0x71, 0xff, 0xf1, 0x05, 0xb8, + 0x20, 0x71, 0xe4, 0x0e, 0x07, 0xbe, 0x07, 0x97, 0x5e, 0x90, 0xf6, 0xb8, 0xa7, 0x02, 0xed, 0xb7, + 0xe0, 0x84, 0x66, 0x92, 0x38, 0x7f, 0x76, 0xd5, 0x3d, 0x79, 0xde, 0x7b, 0xbf, 0xdf, 0x7b, 0xcf, + 0xef, 0x1f, 0xfa, 0x48, 0x0c, 0x82, 0xa6, 0x00, 0x21, 0x18, 0x8f, 0x7c, 0x2a, 0x69, 0xdc, 0x19, + 0x4b, 0x44, 0x89, 0x4e, 0x9c, 0x70, 0xc9, 0xf1, 0x43, 0x8f, 0x7b, 0xa7, 0x09, 0xa7, 0x5e, 0xdf, + 0x11, 0x83, 0xc0, 0x99, 0xc1, 0x6f, 0x6e, 0xa5, 0x92, 0x05, 0x4d, 0x3f, 0x4d, 0xa8, 0x64, 0x3c, + 0xca, 0x1e, 0x43, 0xea, 0xe6, 0x87, 0xda, 0x2a, 0x59, 0x08, 0xfa, 0x11, 0xf7, 0x7c, 0x2a, 0x61, + 0xf4, 0x19, 0x41, 0xaa, 0x3d, 0xde, 0xe3, 0xfa, 0xd9, 0x54, 0xaf, 0x91, 0xd6, 0xee, 0x71, 0xde, + 0x0b, 0xa0, 0xa9, 0xa5, 0x4e, 0xda, 0x9d, 0x73, 0xbc, 0xfd, 0x73, 0x01, 0x95, 0xda, 0xc3, 0x44, + 0xf6, 0xa8, 0xa4, 0x78, 0x13, 0x15, 0x54, 0x42, 0x1d, 0x2a, 0xc0, 0x32, 0xea, 0x46, 0xa3, 0xe8, + 0x66, 0x32, 0x7e, 0x84, 0x4c, 0x1a, 0xc7, 0x01, 0xf3, 0xb4, 0x03, 0x12, 0xd1, 0x10, 0xac, 0x05, + 0x8d, 0x59, 0x9d, 0xd2, 0xbf, 0xa0, 0x21, 0x60, 0x8a, 0x50, 0x2a, 0x20, 0x21, 0x3a, 0x88, 0x95, + 0x57, 0xa0, 0x56, 0xeb, 0xbf, 0x9b, 0xda, 0xd3, 0x1e, 0x93, 0xfd, 0xb4, 0xe3, 0x78, 0x3c, 0x6c, + 0x66, 0xd5, 0xf0, 0x3b, 0x93, 0x77, 0x33, 0x3e, 0xed, 0x35, 0x05, 0x78, 0x69, 0xc2, 0xe4, 0xa5, + 0xd3, 0xfe, 0xfa, 0xf9, 0x89, 0x80, 0x44, 0x45, 0x3a, 0x56, 0x9e, 0xdc, 0xa2, 0xf2, 0xaa, 0x9f, + 0x38, 0x44, 0x0f, 0x54, 0x66, 0xc4, 0xe3, 0xd1, 0x19, 0x24, 0xba, 0xd6, 0x1e, 0x8f, 0xba, 0xac, + 0x67, 0x2d, 0xd6, 0x8d, 0x46, 0x69, 0xf7, 0xb1, 0x73, 0x4f, 0xb9, 0x1d, 0xf5, 0xb3, 0xcf, 0x32, + 0xe6, 0x33, 0x4d, 0x6c, 0x2d, 0x5e, 0xdf, 0xd4, 0x72, 0x6e, 0xd5, 0x7f, 0x8b, 0x0d, 0x9f, 0xa0, + 0xca, 0x19, 0x78, 0x92, 0x27, 0xec, 0x0a, 0x48, 0xc8, 0x7d, 0xb0, 0x96, 0xea, 0x46, 0xa3, 0xb2, + 0xeb, 0xdc, 0x1b, 0xe6, 0xe5, 0x98, 0xb2, 0x7f, 0x01, 0xde, 0x11, 0xf7, 0xc1, 0x2d, 0x67, 0x5e, + 0x94, 0x88, 0xf7, 0x51, 0x4d, 0x82, 0x90, 0x2c, 0xea, 0x91, 0x89, 0x7b, 0x16, 0xfd, 0x00, 0x9e, + 0x24, 0x31, 0x8d, 0x98, 0x27, 0xac, 0xe5, 0xba, 0xd1, 0x28, 0xb8, 0x5b, 0x23, 0x58, 0xe6, 0xf1, + 0x50, 0x83, 0x8e, 0x35, 0x06, 0x37, 0x90, 0xe9, 0x43, 0x97, 0xa6, 0x81, 0x24, 0x2c, 0x92, 0x44, + 0xb0, 0x2b, 0xb0, 0xde, 0xab, 0x1b, 0x8d, 0x25, 0xb7, 0x32, 0xd2, 0x1f, 0x46, 0xb2, 0xcd, 0xae, + 0x40, 0x35, 0x38, 0xe0, 0xc3, 0x4e, 0x59, 0x85, 0x61, 0x83, 0xc7, 0x32, 0xae, 0xa1, 0x92, 0x00, + 0x9a, 0x78, 0x7d, 0x12, 0x53, 0xd9, 0xb7, 0x8a, 0xf5, 0x7c, 0xa3, 0xe8, 0xa2, 0xa1, 0xea, 0x98, + 0xca, 0x3e, 0xde, 0x45, 0x1b, 0x12, 0xc2, 0x98, 0x27, 0x34, 0xb9, 0x24, 0xc2, 0xeb, 0x43, 0x48, + 0x87, 0x63, 0x80, 0xb4, 0xa7, 0xf5, 0xcc, 0xd8, 0xd6, 0x36, 0x3d, 0x0a, 0x47, 0xa8, 0x28, 0x60, + 0x40, 0x84, 0xa4, 0x12, 0xac, 0x92, 0x6e, 0xcd, 0xce, 0xbd, 0x35, 0x6b, 0xc3, 0x20, 0x85, 0xc8, + 0x83, 0xb6, 0x62, 0x8c, 0x7a, 0x52, 0x10, 0x30, 0xd0, 0x32, 0xde, 0x46, 0x2b, 0xdf, 0xf2, 0xe4, + 0xf4, 0x08, 0xc2, 0xe7, 0x2c, 0x64, 0xd2, 0x5a, 0xa9, 0x1b, 0x8d, 0xbc, 0x3b, 0xa3, 0xc3, 0x4f, + 0xd0, 0x03, 0x16, 0x49, 0x48, 0xce, 0x68, 0x40, 0x84, 0xbc, 0x0c, 0x80, 0x40, 0x44, 0x3b, 0x01, + 0xf8, 0x56, 0x59, 0xd7, 0xb2, 0x3a, 0xb6, 0xb6, 0x95, 0x71, 0x7f, 0x68, 0xc3, 0x9f, 0x20, 0xac, + 0xd6, 0x69, 0x8e, 0x51, 0xd1, 0x0c, 0x53, 0x59, 0x66, 0xd0, 0x07, 0x68, 0x25, 0xe0, 0xde, 0x29, + 0x51, 0x3b, 0xc9, 0x53, 0x69, 0xad, 0xea, 0x3f, 0x7b, 0xdf, 0x19, 0xee, 0x9b, 0x33, 0xde, 0x37, + 0x67, 0x6f, 0xb4, 0x6f, 0xad, 0x82, 0xfa, 0x91, 0x5f, 0xff, 0xae, 0x19, 0x6e, 0x49, 0x11, 0xbf, + 0x19, 0xf2, 0x54, 0x3f, 0x74, 0x36, 0x11, 0x0d, 0x2c, 0x53, 0xc7, 0xca, 0x64, 0xfc, 0x14, 0x6d, + 0xf1, 0x88, 0xa4, 0xb1, 0x4e, 0x2b, 0x81, 0x3e, 0x0f, 0x81, 0x24, 0xfc, 0x3c, 0xcb, 0x6d, 0x4d, + 0xe3, 0x2d, 0x1e, 0x9d, 0x68, 0x88, 0xab, 0x11, 0x2e, 0x3f, 0x1f, 0xe7, 0xf8, 0x18, 0x55, 0x65, + 0xc2, 0xd3, 0x4e, 0x00, 0xa2, 0xcf, 0xb9, 0x1e, 0x32, 0x3d, 0xb9, 0x1b, 0x9a, 0xb7, 0x3e, 0x67, + 0x53, 0xf3, 0xb8, 0xfd, 0xe7, 0x02, 0xaa, 0xbe, 0x6d, 0x37, 0xf0, 0xf7, 0x68, 0xbd, 0x73, 0x29, + 0x41, 0x10, 0x88, 0x3c, 0xee, 0x03, 0xe9, 0xf2, 0x24, 0xa4, 0x52, 0xdf, 0x88, 0x77, 0x2d, 0x41, + 0x4b, 0xf1, 0xf6, 0x35, 0xed, 0x40, 0xb3, 0xdc, 0xb5, 0xce, 0xbc, 0x4a, 0x55, 0x1f, 0x2e, 0x64, + 0x42, 0x49, 0x37, 0xe0, 0x54, 0x12, 0x9f, 0xf5, 0x98, 0x14, 0xfa, 0xbc, 0x2c, 0xb9, 0xa6, 0xb6, + 0x1c, 0x28, 0xc3, 0x9e, 0xd6, 0xe3, 0x23, 0x54, 0x99, 0xed, 0xb0, 0xbe, 0x31, 0x95, 0xdd, 0x8f, + 0xa7, 0x12, 0x51, 0x97, 0xd2, 0xc9, 0xce, 0xdd, 0xe1, 0x74, 0xcb, 0xdd, 0xf2, 0xcc, 0x04, 0xe0, + 0x17, 0x08, 0x4d, 0x5a, 0x3f, 0xba, 0x1f, 0x8f, 0xe6, 0x5d, 0x8d, 0xaf, 0xaf, 0x33, 0x3a, 0xbb, + 0x7b, 0xe3, 0x91, 0x18, 0xcd, 0x68, 0x31, 0x9b, 0x91, 0xed, 0xbf, 0x0c, 0x54, 0x9e, 0x19, 0x63, + 0xdc, 0x42, 0x8b, 0x02, 0x06, 0xc2, 0x32, 0xea, 0xf9, 0x46, 0xe9, 0x1d, 0xf5, 0x9a, 0x61, 0x2a, + 0xc9, 0xd5, 0x5c, 0xfc, 0x29, 0xaa, 0x06, 0x54, 0x48, 0xa2, 0xd6, 0x89, 0x45, 0x5e, 0x02, 0x21, + 0x44, 0x12, 0x7c, 0x5d, 0xa4, 0xb2, 0x8b, 0x95, 0xad, 0x0d, 0x83, 0xc3, 0x89, 0x65, 0xf3, 0x00, + 0xe5, 0xdb, 0x30, 0xc0, 0x75, 0xb4, 0xac, 0x39, 0xbe, 0x6e, 0x57, 0xb9, 0x55, 0xbc, 0xbd, 0xa9, + 0x2d, 0x29, 0xe8, 0x9e, 0xbb, 0x24, 0x60, 0x70, 0xe8, 0xe3, 0x0f, 0x10, 0x0a, 0xa8, 0xba, 0x30, + 0xe4, 0x8c, 0x06, 0xda, 0x61, 0xde, 0x2d, 0x0e, 0x35, 0x2f, 0x69, 0xb0, 0x43, 0xd0, 0xda, 0x1b, + 0x4d, 0xc4, 0x18, 0x55, 0xa6, 0x94, 0x5f, 0xc2, 0x85, 0x99, 0xc3, 0x1b, 0x33, 0xc0, 0x7d, 0xe1, + 0xd1, 0x18, 0x4c, 0x63, 0x4e, 0xdd, 0xa2, 0x02, 0x3e, 0x7f, 0x62, 0x2e, 0x6c, 0x16, 0x7e, 0xfa, + 0xcd, 0xce, 0xfd, 0xf1, 0xbb, 0x9d, 0xdb, 0xf9, 0x11, 0xad, 0xbd, 0x71, 0x2a, 0x55, 0x80, 0x4c, + 0x79, 0x12, 0x09, 0x90, 0x66, 0x0e, 0xaf, 0xa2, 0x52, 0xa6, 0xfb, 0x2a, 0x32, 0x17, 0x70, 0x0d, + 0x3d, 0x9c, 0x62, 0xc6, 0x90, 0x30, 0xf5, 0xef, 0x34, 0xf8, 0x22, 0x38, 0xa7, 0x97, 0xc2, 0xcc, + 0x63, 0x13, 0xad, 0x4c, 0x18, 0xdd, 0xae, 0xb9, 0x38, 0x09, 0xbb, 0xbd, 0x58, 0x30, 0x4c, 0xa3, + 0xd5, 0xbc, 0xfe, 0xd7, 0xce, 0x5d, 0xdf, 0xda, 0xc6, 0xab, 0x5b, 0xdb, 0x78, 0x7d, 0x6b, 0x1b, + 0xff, 0xdc, 0xda, 0xc6, 0x2f, 0x77, 0x76, 0xee, 0xd5, 0x9d, 0x9d, 0x7b, 0x7d, 0x67, 0xe7, 0xbe, + 0x2b, 0xcf, 0x34, 0xa8, 0xb3, 0xac, 0xb7, 0xfb, 0xb3, 0xff, 0x03, 0x00, 0x00, 0xff, 0xff, 0x37, + 0x73, 0x75, 0xd6, 0xf7, 0x07, 0x00, 0x00, } func (m *SessionData) Marshal() (dAtA []byte, err error) { @@ -408,6 +413,18 @@ func (m *SessionData) MarshalToSizedBuffer(dAtA []byte) (int, error) { _ = i var l int _ = l + if m.TroubleshootingMode { + i-- + if m.TroubleshootingMode { + dAtA[i] = 1 + } else { + dAtA[i] = 0 + } + i-- + dAtA[i] = 0x1 + i-- + dAtA[i] = 0xa8 + } if m.OnUpdateRehomeRowEnabled { i-- if m.OnUpdateRehomeRowEnabled { @@ -748,6 +765,9 @@ func (m *SessionData) Size() (n int) { if m.OnUpdateRehomeRowEnabled { n += 3 } + if m.TroubleshootingMode { + n += 3 + } return n } @@ -1287,6 +1307,26 @@ func (m *SessionData) Unmarshal(dAtA []byte) error { } } m.OnUpdateRehomeRowEnabled = bool(v != 0) + case 21: + if wireType != 0 { + return fmt.Errorf("proto: wrong wireType = %d for field TroubleshootingMode", wireType) + } + var v int + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return ErrIntOverflowSessionData + } + if iNdEx >= l { + return io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + v |= int(b&0x7F) << shift + if b < 0x80 { + break + } + } + m.TroubleshootingMode = bool(v != 0) default: iNdEx = preIndex skippy, err := skipSessionData(dAtA[iNdEx:]) diff --git a/pkg/sql/sessiondatapb/session_data.proto b/pkg/sql/sessiondatapb/session_data.proto index 342b9b368bf9..6665b12b78e4 100644 --- a/pkg/sql/sessiondatapb/session_data.proto +++ b/pkg/sql/sessiondatapb/session_data.proto @@ -79,6 +79,11 @@ message SessionData { // OnUpdateRehomeRowEnabled controls whether the ON UPDATE rehome_row() // will actually trigger on row updates. bool on_update_rehome_row_enabled = 17; + + // Troubleshooting mode determines whether we refuse to do additional work with + // the query (i.e. collect & emit telemetry data). Troubleshooting mode is + // disabled by default. + bool troubleshooting_mode = 21; } // DataConversionConfig contains the parameters that influence the output diff --git a/pkg/sql/telemetry_logging_test.go b/pkg/sql/telemetry_logging_test.go index 481f890fe449..bfcb930689a1 100644 --- a/pkg/sql/telemetry_logging_test.go +++ b/pkg/sql/telemetry_logging_test.go @@ -279,3 +279,112 @@ func TestTelemetryLogging(t *testing.T) { } } } + +func TestNoTelemetryLogOnTroubleshootMode(t *testing.T) { + defer leaktest.AfterTest(t)() + sc := log.ScopeWithoutShowLogs(t) + defer sc.Close(t) + + cleanup := installTelemetryLogFileSink(sc, t) + defer cleanup() + + st := stubTime{} + + s, sqlDB, _ := serverutils.StartServer(t, base.TestServerArgs{ + Knobs: base.TestingKnobs{ + TelemetryLoggingKnobs: &TelemetryLoggingTestingKnobs{ + getTimeNow: st.TimeNow, + }, + }, + }) + db := sqlutils.MakeSQLRunner(sqlDB) + defer s.Stopper().Stop(context.Background()) + + db.Exec(t, `SET CLUSTER SETTING sql.telemetry.query_sampling.enabled = true;`) + db.Exec(t, "CREATE TABLE t();") + + stubMaxEventFrequency := int64(1) + telemetryMaxEventFrequency.Override(context.Background(), &s.ClusterSettings().SV, stubMaxEventFrequency) + + /* + Testing Cases: + - run query when troubleshoot mode is enabled + - ensure no log appears + - run another query when troubleshoot mode is disabled + - ensure log appears + */ + testData := []struct { + name string + query string + expectedLogStatement string + enableTroubleshootingMode bool + expectedNumLogs int + }{ + { + "select-troubleshooting-enabled", + "SELECT * FROM t LIMIT 1;", + `SELECT * FROM \"\".\"\".t LIMIT ‹1›`, + true, + 0, + }, + { + "select-troubleshooting-disabled", + "SELECT * FROM t LIMIT 2;", + `SELECT * FROM \"\".\"\".t LIMIT ‹2›`, + false, + 1, + }, + } + + for idx, tc := range testData { + // Set the time for when we issue a query to enable/disable + // troubleshooting mode. + setTroubleshootModeTime := timeutil.FromUnixMicros(int64(idx * 1e6)) + st.setTime(setTroubleshootModeTime) + if tc.enableTroubleshootingMode { + db.Exec(t, `SET troubleshooting_mode = true;`) + } else { + db.Exec(t, `SET troubleshooting_mode = false;`) + } + // Advance time 1 second from previous query. Ensure enough time has passed + // from when we set troubleshooting mode for this query to be sampled. + setQueryTime := timeutil.FromUnixMicros(int64((idx + 1) * 1e6)) + st.setTime(setQueryTime) + db.Exec(t, tc.query) + } + + log.Flush() + + entries, err := log.FetchEntriesFromFiles( + 0, + math.MaxInt64, + 10000, + regexp.MustCompile(`"EventType":"sampled_query"`), + log.WithMarkedSensitiveData, + ) + + if err != nil { + t.Fatal(err) + } + + if len(entries) == 0 { + t.Fatal(errors.Newf("no entries found")) + } + + for _, tc := range testData { + numLogsFound := 0 + for i := len(entries) - 1; i >= 0; i-- { + e := entries[i] + if strings.Contains(e.Message, tc.expectedLogStatement) { + if tc.enableTroubleshootingMode { + t.Errorf("%s: unexpected log entry when troubleshooting mode enabled:\n%s", tc.name, entries[0].Message) + } else { + numLogsFound++ + } + } + } + if numLogsFound != tc.expectedNumLogs { + t.Errorf("%s: expected %d log entries, found %d", tc.name, tc.expectedNumLogs, numLogsFound) + } + } +} diff --git a/pkg/sql/vars.go b/pkg/sql/vars.go index ff3a00645577..6ec6a8f31755 100644 --- a/pkg/sql/vars.go +++ b/pkg/sql/vars.go @@ -1130,6 +1130,23 @@ var varGen = map[string]sessionVar{ // See https://www.postgresql.org/docs/10/static/runtime-config-preset.html#GUC-SERVER-VERSION-NUM `server_version_num`: makeReadOnlyVar(PgServerVersionNum), + // CockroachDB extension. + `troubleshooting_mode`: { + GetStringVal: makePostgresBoolGetStringValFn(`troubleshooting_mode`), + Set: func(_ context.Context, m sessionDataMutator, s string) error { + b, err := paramparse.ParseBoolVar("troubleshooting_mode", s) + if err != nil { + return err + } + m.SetTroubleshootingModeEnabled(b) + return nil + }, + Get: func(evalCtx *extendedEvalContext) string { + return formatBoolAsPostgresSetting(evalCtx.SessionData().TroubleshootingMode) + }, + GlobalDefault: globalFalse, + }, + // This is read-only in Postgres also. // See https://www.postgresql.org/docs/14/sql-show.html and // https://www.postgresql.org/docs/14/locale.html