sql, insights: record error message for failed stmts #110565

xinhaoz · 2023-09-13T15:30:30Z

Commit 1 sql: modify HasViewActivityOrViewActivityRedactedRole signature

This commit adds an additional return value to the function
HasViewActivityOrViewActivityRedactedRole which returns true if
the user has either VIEWACTIVITY or VIEWACTIVITYREDACTED roles.

In addition to that, the function will now return a boolean indicating
whether the user is not admin and has the VIEWACTIVITYREDACTED role.
This simplifies areas where we need to redact values based on the
presence of this role, allowing callers to skip an additional role check
for admin and VIEWACTIVITYREDACTED.

Epic: none

Release note: None

Commit 2 sql, insights: record error message for failed stmts

Part of: #87785.

Previously, the insights subsystem did not keep track of the error messages for failed executions, only the error codes.

This commit updates the [cluster|node]_execution_insights and [cluster|node]_txn_execution_insights virtual tables to include a last_error column which contains the most recent error message.

Release note (sql change): adds last_error column to the [cluster|node]_execution_insights and [cluster|node]_txn_execution_insights tables which keeps track of the error message for failed executions.

cockroach-teamcity · 2023-09-13T15:30:40Z

This change is

maryliag

Reviewed 5 of 5 files at r1, 9 of 10 files at r2, all commit messages.
Reviewable status: complete! 0 of 0 LGTMs obtained (waiting on @xinhaoz)

pkg/ccl/logictestccl/testdata/logic_test/crdb_internal line 206 at r2 (raw file):

tenant_id  capability_name    capability_value
1          can_admin_split  true
5          can_admin_split  true

is this intentional? seems unrelated to this PR

pkg/sql/sqlstats/insights/integration/insights_test.go line 209 at r2 (raw file):

	// Create VIEWACTIVITY and VIEWACTIVITYREDACTED users.
	//const viewUser = "view_user"

looks like you need to do some cleanup on these comments

xinhaoz

Reviewable status: complete! 0 of 0 LGTMs obtained (waiting on @ericharmeling and @maryliag)

pkg/ccl/logictestccl/testdata/logic_test/crdb_internal line 206 at r2 (raw file):

Previously, maryliag (Marylia Gutierrez) wrote…

is this intentional? seems unrelated to this PR

I used --rewrite since I added some columns to the internal tables. Not sure why this part was changed, too. I'll check if removing this change will break the test.

pkg/sql/sqlstats/insights/integration/insights_test.go line 209 at r2 (raw file):

Previously, maryliag (Marylia Gutierrez) wrote…

looks like you need to do some cleanup on these comments

Done.

maryliag

Reviewed 2 of 2 files at r3, 10 of 11 files at r4, 11 of 11 files at r5, all commit messages.
Reviewable status: complete! 1 of 0 LGTMs obtained (waiting on @ericharmeling)

j82w

Reviewed 1 of 11 files at r4.
Reviewable status: complete! 1 of 0 LGTMs obtained (waiting on @ericharmeling, @maryliag, and @xinhaoz)

pkg/cli/zip_table_registry.go line 165 at r5 (raw file):

			"retries",
			"last_retry_reason",
			"error_code",

Shouldn't this be a sensitive column?

xinhaoz · 2023-09-18T14:18:45Z

pkg/cli/zip_table_registry.go line 165 at r5 (raw file):

Previously, j82w (Jake) wrote…

Shouldn't this be a sensitive column?

The error code itself doesn't have any sensitive info from what I can tell. Looks like the retry reason was added in a separate commit despite it being listed as sensitive 🤔 . We can take it up with sql-foundations.

xinhaoz · 2023-09-19T14:09:05Z

bors r+

knz

Reviewed 6 of 11 files at r5, 1 of 1 files at r6, all commit messages.
Reviewable status: complete! 0 of 0 LGTMs obtained (and 1 stale) (waiting on @ericharmeling, @j82w, @maryliag, and @xinhaoz)

pkg/cli/zip_table_registry.go line 165 at r5 (raw file):

Previously, xinhaoz (Xin Hao Zhang) wrote…

The error code itself doesn't have any sensitive info from what I can tell. Looks like the retry reason was added in a separate commit despite it being listed as sensitive 🤔 . We can take it up with sql-foundations.

indeed error code is safe.

pkg/sql/crdb_internal.go line 8089 at r6 (raw file):

		errorMsg := tree.DNull
		if insight.Transaction.LastErrorMsg != "" && shouldRedactError {

can you store the error in the insight data structure as a redact.RedactableString and call .Redact() here instead of deleting everything?

xinhaoz · 2023-09-19T14:58:21Z

bors r-

craig · 2023-09-19T14:58:23Z

Canceled.

j82w · 2023-09-19T18:07:23Z

pkg/cli/zip_table_registry.go line 165 at r5 (raw file):

Previously, knz (Raphael 'kena' Poss) wrote…

indeed error code is safe.

I was referring to the last_retry_reason. A separate issue can be opened for it.

j82w · 2023-09-19T18:43:45Z

pkg/sql/crdb_internal.go line 8089 at r6 (raw file):

Previously, knz (Raphael 'kena' Poss) wrote…

can you store the error in the insight data structure as a redact.RedactableString and call .Redact() here instead of deleting everything?

If it's a redacted string can we add it to the debug zip?

knz · 2023-09-19T19:07:39Z

If it's a redacted string can we add it to the debug zip?

redactable != redacted

at the point it is still Redactable it still contains PII. Once redacted it does not.

So debug zip by default can only capture redacted errors.

xinhaoz · 2023-09-19T21:19:04Z

pkg/cli/zip_table_registry.go line 165 at r5 (raw file):

Previously, j82w (Jake) wrote…

I was referring to the last_retry_reason. A separate issue can be opened for it.

Filed #110938.
For this PR the last_error has been changed to last_error_redactable for both tables. It's redacted for the debug zip and directly for VIEWACTIVITYREDACTED users.

knz

Nice tests.

LGTM modulo reverting the change to the logic test with the 'retry' clause.

Reviewed 1 of 11 files at r5, 11 of 11 files at r7, all commit messages.
Reviewable status: complete! 0 of 0 LGTMs obtained (and 1 stale) (waiting on @ericharmeling, @j82w, and @maryliag)

pkg/ccl/logictestccl/testdata/logic_test/crdb_internal line 206 at r2 (raw file):

Previously, xinhaoz (Xin Hao Zhang) wrote…

I used --rewrite since I added some columns to the internal tables. Not sure why this part was changed, too. I'll check if removing this change will break the test.

Yeah let's revert that. that seems incorrect. Generally "--rewrite" is unsafe/inconsistent with the "retry" clause in logic tests.

This commit adds an additional return value to the function `HasViewActivityOrViewActivityRedactedRole` which returns true if the user has either `VIEWACTIVITY` or `VIEWACTIVITYREDACTED` roles. In addition to that, the function will now return a boolean indicating whether the user is not admin and has the `VIEWACTIVITYREDACTED` role. This simplifies areas where we need to redact values based on the presence of this role, allowing callers to skip an additional role check for admin and VIEWACTIVITYREDACTED. Epic: none Release note: None

Part of: cockroachdb#87785. Previously, the insights subsystem did not keep track of the error messages for failed executions, only the error codes. This commit updates the `[cluster|node]_execution_insights` and `[cluster|node]_txn_execution_insights` virtual tables to include a `last_error` column which contains the most recent error message. Release note (sql change): adds `last_error` column to the `[cluster|node]_execution_insights` and `[cluster|node]_txn_execution_insights` tables which keeps track of the error message for failed executions. Co-authored-by: gtr <gerardo@cockroachlabs.com>

xinhaoz · 2023-09-21T17:35:45Z

Thanks for the reviews!
bors r+

xinhaoz · 2023-09-21T17:42:26Z

bors r-

craig · 2023-09-21T17:42:29Z

Canceled.

xinhaoz · 2023-09-21T17:48:08Z

Oops, mistakenly canceled bc I thought there was a CI issue. TFTR!
bors r+

yuzefovich · 2023-09-22T03:18:31Z

bors timed out, courtesy merge

bors r+

craig · 2023-09-22T05:23:22Z

This PR was included in a batch that timed out, it will be automatically retried

craig · 2023-09-22T07:18:22Z

Build succeeded:

Bazel Essential CI (Cockroach)

xinhaoz force-pushed the record-err-msgs-insights branch from cec95d1 to 3998167 Compare September 13, 2023 21:32

xinhaoz marked this pull request as ready for review September 14, 2023 14:26

xinhaoz requested review from a team as code owners September 14, 2023 14:26

xinhaoz mentioned this pull request Sep 14, 2023

sql, insights: record error message for failed stmts #107084

Closed

maryliag reviewed Sep 14, 2023

View reviewed changes

xinhaoz force-pushed the record-err-msgs-insights branch from 3998167 to 962731b Compare September 14, 2023 17:40

xinhaoz requested review from a team as code owners September 14, 2023 17:40

xinhaoz requested review from ericharmeling and removed request for a team September 14, 2023 17:40

xinhaoz force-pushed the record-err-msgs-insights branch from 962731b to 0ee97b5 Compare September 14, 2023 18:22

xinhaoz commented Sep 14, 2023

View reviewed changes

xinhaoz requested a review from a team September 14, 2023 18:25

maryliag approved these changes Sep 15, 2023

View reviewed changes

j82w reviewed Sep 15, 2023

View reviewed changes

xinhaoz force-pushed the record-err-msgs-insights branch from 0ee97b5 to 64645a3 Compare September 18, 2023 18:26

knz reviewed Sep 19, 2023

View reviewed changes

xinhaoz force-pushed the record-err-msgs-insights branch 2 times, most recently from 4a1337f to 4338f0f Compare September 19, 2023 21:10

xinhaoz force-pushed the record-err-msgs-insights branch from 4338f0f to 5b24932 Compare September 19, 2023 21:21

xinhaoz requested review from j82w and knz September 19, 2023 21:39

xinhaoz force-pushed the record-err-msgs-insights branch 4 times, most recently from b02162f to 118c717 Compare September 20, 2023 17:10

knz approved these changes Sep 20, 2023

View reviewed changes

xinhaoz force-pushed the record-err-msgs-insights branch from 118c717 to e54f5a9 Compare September 21, 2023 14:10

xinhaoz and others added 2 commits September 21, 2023 11:04

xinhaoz force-pushed the record-err-msgs-insights branch from e54f5a9 to 3b1adac Compare September 21, 2023 15:08

craig bot merged commit 989af00 into cockroachdb:master Sep 22, 2023
8 checks passed

xinhaoz mentioned this pull request Sep 27, 2023

sql: create new system observability tables and update job #104714

Merged

xinhaoz deleted the record-err-msgs-insights branch April 1, 2024 17:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sql, insights: record error message for failed stmts #110565

sql, insights: record error message for failed stmts #110565

xinhaoz commented Sep 13, 2023 •

edited

cockroach-teamcity commented Sep 13, 2023

maryliag left a comment

xinhaoz left a comment

maryliag left a comment

j82w left a comment

xinhaoz commented Sep 18, 2023

xinhaoz commented Sep 19, 2023

knz left a comment

xinhaoz commented Sep 19, 2023

craig bot commented Sep 19, 2023

j82w commented Sep 19, 2023

j82w commented Sep 19, 2023

knz commented Sep 19, 2023

xinhaoz commented Sep 19, 2023

knz left a comment

xinhaoz commented Sep 21, 2023

xinhaoz commented Sep 21, 2023

craig bot commented Sep 21, 2023

xinhaoz commented Sep 21, 2023

yuzefovich commented Sep 22, 2023

craig bot commented Sep 22, 2023

craig bot commented Sep 22, 2023

sql, insights: record error message for failed stmts #110565

sql, insights: record error message for failed stmts #110565

Conversation

xinhaoz commented Sep 13, 2023 • edited

Commit 1 sql: modify HasViewActivityOrViewActivityRedactedRole signature

Commit 2 sql, insights: record error message for failed stmts

cockroach-teamcity commented Sep 13, 2023

maryliag left a comment

Choose a reason for hiding this comment

xinhaoz left a comment

Choose a reason for hiding this comment

maryliag left a comment

Choose a reason for hiding this comment

j82w left a comment

Choose a reason for hiding this comment

xinhaoz commented Sep 18, 2023

xinhaoz commented Sep 19, 2023

knz left a comment

Choose a reason for hiding this comment

xinhaoz commented Sep 19, 2023

craig bot commented Sep 19, 2023

j82w commented Sep 19, 2023

j82w commented Sep 19, 2023

knz commented Sep 19, 2023

xinhaoz commented Sep 19, 2023

knz left a comment

Choose a reason for hiding this comment

xinhaoz commented Sep 21, 2023

xinhaoz commented Sep 21, 2023

craig bot commented Sep 21, 2023

xinhaoz commented Sep 21, 2023

yuzefovich commented Sep 22, 2023

craig bot commented Sep 22, 2023

craig bot commented Sep 22, 2023

xinhaoz commented Sep 13, 2023 •

edited