Skip to content

Commit

Permalink
cli: add redacted sql stmts to debug zip
Browse files Browse the repository at this point in the history
Closes #88823

This commit adds the following fields to the redacted
debug zip:

crdb_internal.create_statements:
- create_statement
- create_nofks
- alter_statements (each elem is redacted)

crdb_internal.create_function_statements:
- create_statement

crdb_internal.{node,cluster}_distsql_flows:
- stmt

crdb_internal.{cluster,node}_sessions:
- last_active
- active_queries

crdb_internal.{cluster,node}_queries:
- query

Release note (cli change):
The following fields have been redacted and added to
the redacted debug zip:
crdb_internal.create_statements:
- create_statement
- create_nofks
- alter_statements (each elem is redacted)
crdb_internal.create_function_statements:
- create_statement
crdb_internal.{node,cluster}_distsql_flows:
- stmt
crdb_internal.{cluster,node}_sessions:
- last_active
- active_queries
crdb_internal.{cluster,node}_queries:
- query
  • Loading branch information
xinhaoz committed Dec 2, 2022
1 parent f5c6a56 commit 1224138
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions pkg/cli/zip_table_registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,12 @@ var zipInternalTablesPerCluster = DebugZipTableRegistry{
},
},
"crdb_internal.cluster_distsql_flows": {
// `stmt` column contains unredacted SQL statement strings.
nonSensitiveCols: NonSensitiveColumns{
"flow_id",
"node_id",
"since",
"status",
"crdb_internal.anonymize_sql_constants(stmt) as stmt",
},
},
"crdb_internal.cluster_execution_insights": {
Expand Down Expand Up @@ -183,7 +183,6 @@ var zipInternalTablesPerCluster = DebugZipTableRegistry{
},
},
"crdb_internal.cluster_queries": {
// `query` column contains unredacted SQL statement strings.
// `client_address` contains unredacted client IP addresses.
nonSensitiveCols: NonSensitiveColumns{
"query_id",
Expand All @@ -196,11 +195,10 @@ var zipInternalTablesPerCluster = DebugZipTableRegistry{
"distributed",
"phase",
"full_scan",
"crdb_internal.anonymize_sql_constants(query) as query",
},
},
"crdb_internal.cluster_sessions": {
// `active_queries` and `last_active_query` columns contain unredacted
// SQL statement strings.
// `client_address` contains unredacted client IP addresses.
nonSensitiveCols: NonSensitiveColumns{
"node_id",
Expand All @@ -215,6 +213,8 @@ var zipInternalTablesPerCluster = DebugZipTableRegistry{
"max_alloc_bytes",
"status",
"session_end",
"crdb_internal.anonymize_sql_constants(active_queries) as active_queries",
"crdb_internal.anonymize_sql_constants(last_active_query) as last_active_query",
},
},
"crdb_internal.cluster_settings": {
Expand Down Expand Up @@ -245,14 +245,13 @@ var zipInternalTablesPerCluster = DebugZipTableRegistry{
},
},
`"".crdb_internal.create_function_statements`: {
// `create_statement` column contains unredacted CREATE FUNCTION
// statements which may contain customer-supplied constants.
nonSensitiveCols: NonSensitiveColumns{
"database_id",
"database_name",
"schema_id",
"function_id",
"function_name",
"crdb_internal.anonymize_sql_constants(create_statement) as create_statement",
},
},
// The synthetic SQL CREATE statements for all tables.
Expand All @@ -267,8 +266,6 @@ var zipInternalTablesPerCluster = DebugZipTableRegistry{
},
},
`"".crdb_internal.create_statements`: {
// `create_statement,` create_nofks`, and `alter_statements` columns
// contain unredacted SQL statement strings.
nonSensitiveCols: NonSensitiveColumns{
"database_id",
"database_name",
Expand All @@ -281,6 +278,9 @@ var zipInternalTablesPerCluster = DebugZipTableRegistry{
"is_multi_region",
"is_virtual",
"is_temporary",
"crdb_internal.anonymize_sql_constants(create_statement) as create_statement",
"crdb_internal.anonymize_sql_constants(alter_statements) as alter_statements",
"crdb_internal.anonymize_sql_constants(create_nofks) as create_nofks",
},
},
// Ditto, for CREATE TYPE.
Expand Down Expand Up @@ -584,6 +584,7 @@ var zipInternalTablesPerNode = DebugZipTableRegistry{
"stmt",
"since",
"status",
"crdb_internal.anonymize_sql_constants(stmt) as stmt",
},
},
"crdb_internal.node_execution_insights": {
Expand Down Expand Up @@ -633,7 +634,6 @@ var zipInternalTablesPerNode = DebugZipTableRegistry{
},
},
"crdb_internal.node_queries": {
// `query` column contains unredacted SQL statement strings.
// `client_address` contains unredacted client IP addresses.
nonSensitiveCols: NonSensitiveColumns{
"query_id",
Expand All @@ -646,6 +646,7 @@ var zipInternalTablesPerNode = DebugZipTableRegistry{
"distributed",
"phase",
"full_scan",
"crdb_internal.anonymize_sql_constants(query) as query",
},
},
"crdb_internal.node_runtime_info": {
Expand All @@ -657,8 +658,6 @@ var zipInternalTablesPerNode = DebugZipTableRegistry{
},
},
"crdb_internal.node_sessions": {
// `active_queries` and `last_active_query` columns contain unredacted
// SQL statement strings.
// `client_address` contains unredacted client IP addresses.
nonSensitiveCols: NonSensitiveColumns{
"node_id",
Expand All @@ -673,6 +672,8 @@ var zipInternalTablesPerNode = DebugZipTableRegistry{
"max_alloc_bytes",
"status",
"session_end",
"crdb_internal.anonymize_sql_constants(active_queries) as active_queries",
"crdb_internal.anonymize_sql_constants(last_active_query) as last_active_query",
},
},
"crdb_internal.node_statement_statistics": {
Expand Down

0 comments on commit 1224138

Please sign in to comment.