Skip to content
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

Jump to bottom

Provide consistency and clarity with how we display fingerprints on the Session and Transaction pages within the console #71730

Closed
kevin-v-ngo opened this issue Oct 19, 2021 · 0 comments · Fixed by #71817
Closed

Provide consistency and clarity with how we display fingerprints on the Session and Transaction pages within the console #71730

kevin-v-ngo opened this issue Oct 19, 2021 · 0 comments · Fixed by #71817
Assignees
@lindseyjin
Labels
A-sql-console-general SQL Observability issues on the DB console spanning multiple areas. Includes Cockroach Cloud Console C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception)

Comments

@kevin-v-ngo
Copy link

kevin-v-ngo commented Oct 19, 2021 •
edited
Loading

We addressed an issue significantly improving how we display statement fingerprints on the Statement page.

The rules for how we display the statement fingerprints should also be applied to transaction fingerprints. The rules for displaying statement fingerprints should also apply to the statement column on the Sessions page.

Note: transaction fingerprints can be comprised of multiple statements so we'd need to determine a reasonable character limit (perhaps the same as statement fingerprints). cc @Annebirzin
@kevin-v-ngo kevin-v-ngo added C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) A-sql-console-general SQL Observability issues on the DB console spanning multiple areas. Includes Cockroach Cloud Console labels Oct 19, 2021
@kevin-v-ngo kevin-v-ngo changed the title Provide consistency and clarity with how we display transaction fingerprints in the console Provide consistency and clarity with how we display fingerprints on the Session and Transaction pages within the console Oct 19, 2021
@lindseyjin lindseyjin mentioned this issue Oct 21, 2021
Merged
lindseyjin added a commit to lindseyjin/cockroach that referenced this issue Oct 21, 2021
@lindseyjin
sql/server/ui: Use summarized statement formats on Sessions and Trans…
323250d 
…actions pages

Resolves cockroachdb#71730

Previously, we implemented new statement summaries (for SELECT,
INSERT/UPSERT, and UPDATE statement types) to be used on the Statements
page to provide more detail and reduce ambiguity between short
statements.

For consistency's sake, we are also going to default to using these
summarized formats on the Sessions and Transactions pages. For Sessions,
this change involves adding a new field "sql_summary", to the active
queries proto so that it can be passed to the front-end. For
Transactions, instead of showing all the query text concatenated as
the label, we now show all the query summary text concatenated.

Additionally, we now also hide "Mean Rows Written" on the Transaction
Details page if all statements in the transaction are SELECT statements,
to be consistent with the Statement Details page.

Release note (ui change): Use new summarized formats for SELECT,
INSERT/UPSERT, and UPDATE statements on the Sessions and Transaction
pages, to be consistent with the Statements page. Hide "Mean rows
written" as a metric on the Transaction Details page if all statements
in the transaction were SELECT statements, to be consistent with the
Statement Details page.
lindseyjin added a commit to lindseyjin/cockroach that referenced this issue Oct 21, 2021
@lindseyjin
sql/server/ui: Use summarized statement formats on Sessions and Trans…
2c058a8 
…actions pages

Resolves cockroachdb#71730

Previously, we implemented new statement summaries (for SELECT,
INSERT/UPSERT, and UPDATE statement types) to be used on the Statements
page to provide more detail and reduce ambiguity between short
statements.

For consistency's sake, we are also going to default to using these
summarized formats on the Sessions and Transactions pages. For Sessions,
this change involves adding a new field "sql_summary", to the active
queries proto so that it can be passed to the front-end. For
Transactions, instead of showing all the query text concatenated as
the label, we now show all the query summary text concatenated.

Additionally, we now also hide "Mean Rows Written" on the Transaction
Details page if all statements in the transaction are SELECT statements,
to be consistent with the Statement Details page.

Release note (ui change): Use new summarized formats for SELECT,
INSERT/UPSERT, and UPDATE statements on the Sessions and Transaction
pages, to be consistent with the Statements page. Hide "Mean rows
written" as a metric on the Transaction Details page if all statements
in the transaction were SELECT statements, to be consistent with the
Statement Details page.
lindseyjin added a commit to lindseyjin/cockroach that referenced this issue Oct 21, 2021
@lindseyjin
sql/server/ui: Use summarized statement formats on Sessions and Trans…
0fb179e 
…actions pages

Resolves cockroachdb#71730

Previously, we implemented new statement summaries (for SELECT,
INSERT/UPSERT, and UPDATE statement types) to be used on the Statements
page to provide more detail and reduce ambiguity between short
statements.

For consistency's sake, we are also going to default to using these
summarized formats on the Sessions and Transactions pages. For Sessions,
this change involves adding a new field "sql_summary", to the active
queries proto so that it can be passed to the front-end. For
Transactions, instead of showing all the query text concatenated as
the label, we now show all the query summary text concatenated.

Additionally, we now also hide "Mean Rows Written" on the Transaction
Details page if all statements in the transaction are SELECT statements,
to be consistent with the Statement Details page.

Release note (ui change): Use new summarized formats for SELECT,
INSERT/UPSERT, and UPDATE statements on the Sessions and Transaction
pages, to be consistent with the Statements page. Hide "Mean rows
written" as a metric on the Transaction Details page if all statements
in the transaction were SELECT statements, to be consistent with the
Statement Details page.
lindseyjin added a commit to lindseyjin/cockroach that referenced this issue Oct 21, 2021
@lindseyjin
sql/server/ui: Use summarized statement formats on Sessions and Trans…
dc012a9 
…actions pages

Resolves cockroachdb#71730

Previously, we implemented new statement summaries (for SELECT,
INSERT/UPSERT, and UPDATE statement types) to be used on the Statements
page to provide more detail and reduce ambiguity between short
statements.

For consistency's sake, we are also going to default to using these
summarized formats on the Sessions and Transactions pages. For Sessions,
this change involves adding a new field "sql_summary", to the active
queries proto so that it can be passed to the front-end. For
Transactions, instead of showing all the query text concatenated as
the label, we now show all the query summary text concatenated.

Additionally, we now also hide "Mean Rows Written" on the Transaction
Details page if all statements in the transaction are SELECT statements,
to be consistent with the Statement Details page.

Release note (ui change): Use new summarized formats for SELECT,
INSERT/UPSERT, and UPDATE statements on the Sessions and Transaction
pages, to be consistent with the Statements page. Hide "Mean rows
written" as a metric on the Transaction Details page if all statements
in the transaction were SELECT statements, to be consistent with the
Statement Details page.
craig bot pushed a commit that referenced this issue Oct 25, 2021
@lindseyjin
Merge #71817
322dd53 
71817: sql/server/ui: Use summarized statement formats on Sessions and Transactions pages r=lindseyjin a=lindseyjin

Resolves #71730

Previously, we implemented new statement summaries (for SELECT,
INSERT/UPSERT, and UPDATE statement types) to be used on the Statements
page to provide more detail and reduce ambiguity between short
statements.

For consistency's sake, we are also going to default to using these
summarized formats on the Sessions and Transactions pages. For Sessions,
this change involves adding a new field "sql_summary", to the active
queries proto so that it can be passed to the front-end. For
Transactions, instead of showing all the query text concatenated as
the label, we now show all the query summary text concatenated.

Sessions page
![image](https://user-images.githubusercontent.com/29153209/138318658-9605e82c-39ed-4fb0-bb56-5bb1d7009d5c.png)
<img width="514" alt="Screen Shot 2021-10-21 at 2 07 26 PM" src="https://user-images.githubusercontent.com/29153209/138333416-9aa6a877-844c-4f89-9122-e40d0048915d.png">


Transactions page
![image](https://user-images.githubusercontent.com/29153209/138318623-172c23c2-509f-4880-85cc-bed7abbbb95e.png)

Additionally, we now show "Mean Rows Written" as a metric on the
Statement Details page for all statement types, including SELECT
statements, since we realized there's an edge case where SELECT
statements that embed INSERT statements may still modify rows.

Release note (ui change): Use new summarized formats for SELECT,
INSERT/UPSERT, and UPDATE statements on the Sessions and Transaction
pages, to be consistent with the Statements page. Show "Mean rows
written" as a metric for all statement types on the Statements page,
instead of hiding this metric for SELECT statements.

Co-authored-by: Lindsey Jin <[email protected]>
@craig craig bot closed this as completed in 01d2097 Oct 25, 2021
lindseyjin added a commit to lindseyjin/cockroach that referenced this issue Dec 10, 2021
@lindseyjin
sql/server/ui: Use summarized statement formats on Sessions and Trans…
983e0d4 
…actions pages

Resolves cockroachdb#71730

Previously, we implemented new statement summaries (for SELECT,
INSERT/UPSERT, and UPDATE statement types) to be used on the Statements
page to provide more detail and reduce ambiguity between short
statements.

For consistency's sake, we are also going to default to using these
summarized formats on the Sessions and Transactions pages. For Sessions,
this change involves adding a new field "sql_summary", to the active
queries proto so that it can be passed to the front-end. For
Transactions, instead of showing all the query text concatenated as
the label, we now show all the query summary text concatenated.

Additionally, we now show "Mean Rows Written" as a metric on the
Statement Details page for all statement types, including SELECT
statements, since we realized there's an edge case where SELECT
statements that embed INSERT statements may still modify rows.

Release note (ui change): Use new summarized formats for SELECT,
INSERT/UPSERT, and UPDATE statements on the Sessions and Transaction
pages, to be consistent with the Statements page. Show "Mean rows
written" as a metric for all statement types on the Statements page,
instead of hiding this metric for SELECT statements.
@lindseyjin lindseyjin mentioned this issue Dec 10, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lindseyjin lindseyjin

Labels
A-sql-console-general SQL Observability issues on the DB console spanning multiple areas. Includes Cockroach Cloud Console C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception)
Projects
None yet
Milestone
No milestone
2 participants
@lindseyjin @kevin-v-ngo