Transactions Page

Note:

On a secure cluster, this area of the DB Console can only be accessed by an admin user. See DB Console access.

The Transactions page helps you:

  • Identify frequently retried or high latency transactions.
  • View transaction details.
Tip:

In contrast with the Statements page, which displays SQL statement fingerprints, the Transactions page displays SQL statement fingerprints grouped by transaction.

To view this page, access the DB Console and click Transactions in the left-hand navigation.

Search and filter by application

By default, this page shows transactions from all applications running on the cluster, and hides internal CockroachDB transactions.

To filter the transactions by application_name, use the App pulldown in the Filters menu. If you haven't set application_name in the client connection string, it appears as unset.

  • CockroachDB's internal transactions are only displayed under the $ internal app.
  • Transactions from the SQL shell are displayed under the $ cockroach sql app.

You can also search for transactions using the search bar, or by date using the date bar. To search by date pick a date range that is within the time period since the statistics were last cleared, indicated on the upper right of the table. Click reset time to reset the date.

Click Clear SQL Stats to clear the statistics.

Filter by transaction latency

You can filter transactions in which a SQL statement fingerprint exceeds a specified latency value. Use the pulldown in the Filters menu.

Understand the Transactions page

Use this page to identify transactions that you may want to troubleshoot, such as transactions that are experiencing high latencies, multiple retries, or execution failures.

Tip:

If you haven't yet run any transactions in the cluster as a user, this page will display a blank table.

Column Description
Transactions The SQL statement fingerprints that make up the transaction.

To view the transaction fingerprint and details, click this to open the Transaction Details page.
Execution Count Cumulative number of executions of this transaction within the last hour or specified time interval.

The bar indicates the ratio of runtime success (gray) to retries (red) for the transaction.
Rows Read Average number of rows read from disk while executing this transaction within the last hour or specified time interval.

The gray bar indicates the mean number of rows returned. The blue bar indicates one standard deviation from the mean.
Bytes Read Aggregation of all bytes read from disk across all operators for this transaction within the last hour or specified time interval.

The gray bar indicates the mean number of bytes read from disk. The blue bar indicates one standard deviation from the mean.
Transaction Time Average planning and execution time of this transaction within the last hour or specified time interval.

The gray bar indicates the mean latency. The blue bar indicates one standard deviation from the mean.
Contention Average time this transaction was in contention with other transactions within the last hour or specified time interval.

The gray bar indicates mean contention time. The blue bar indicates one standard deviation from the mean.
Max Memory Maximum memory used by this transaction at any time during its execution within the last hour or specified time interval.

The gray bar indicates the average max memory usage. The blue bar indicates one standard deviation from the mean.
Network Amount of data transferred over the network (e.g., between regions and nodes) for this transaction within the last hour or specified time interval.

If this value is 0, the transaction was executed on a single node.

The gray bar indicates the mean number of bytes sent over the network. The blue bar indicates one standard deviation from the mean.
Retries Cumulative number of retries of this transaction within the last hour or specified time interval.
Regions/Nodes The region and nodes in which the transaction was executed.
Statements Number of SQL statements in the transaction.
Note:

Significant transactions on your database are likely to have a high execution count or number of rows read.

Time interval

By default, the Transactions page displays all transactions executed within a one-hour time interval. The display is cleared at the end of each interval. You can change the interval with the diagnostics.reporting.interval cluster setting.

Transaction Details page

Click on a transaction fingerprint to open Transaction Details.

  • The transaction fingerprint is displayed as a list of the individual SQL statement fingerprints in the transaction.
  • The mean transaction time is the mean average time it took to execute the transaction within the last hour or specified time interval.
  • Transaction resource usage shows overall statistics about the transaction.
    • Mean rows/bytes read shows the mean average number of rows and bytes read from the storage layer during the execution of the transaction within the last hour or specified time interval.
    • Bytes read over network displays the amount of data transferred over the network (e.g., between regions and nodes) for this transaction within the last hour or specified time interval.

      If this value is 0, the statement was executed on a single node.
    • Max memory usage is the maximum memory used by this transaction at any time during its execution within the last hour or specified time interval.
    • Max scratch disk usage displays the maximum amount of data spilled to temporary storage on disk while executing this transaction within the last hour or specified time interval.

The statement table gives details for each SQL statement in the transaction:

Column Description
Statements SQL statement fingerprint.

To view additional details, click the SQL statement fingerprint to open its Statement Details page.
Execution Count Cumulative number of executions of statements with this fingerprint within the last hour or specified time interval.

The bar indicates the ratio of runtime success (gray) to retries (red) for the SQL statement fingerprint.
Rows Read Average number of rows read from disk while executing statements with this fingerprint within the last hour or specified time interval.

The gray bar indicates the mean number of rows returned. The blue bar indicates one standard deviation from the mean.
Bytes Read Aggregation of all bytes read from disk across all operators for statements with this fingerprint within the last hour or specified time interval.

The gray bar indicates the mean number of bytes read from disk. The blue bar indicates one standard deviation from the mean.
Statement Time Average planning and execution time of statements with this fingerprint within the last hour or specified time interval.

The gray bar indicates the mean latency. The blue bar indicates one standard deviation from the mean.
Contention Average time statements with this fingerprint were in contention with other transactions within the last hour or specified time interval.

The gray bar indicates mean contention time. The blue bar indicates one standard deviation from the mean.
Max Memory Maximum memory used by a statement with this fingerprint at any time during its execution within the last hour or specified time interval.

The gray bar indicates the average max memory usage. The blue bar indicates one standard deviation from the mean.
Network Amount of data transferred over the network (e.g., between regions and nodes) for statements with this fingerprint within the last hour or specified time interval.

If this value is 0, the statement was executed on a single node.

The gray bar indicates the mean number of bytes sent over the network. The blue bar indicates one standard deviation from the mean.
Retries Cumulative number of retries of statements with this fingerprint within the last hour or specified time interval.
% of All Runtime This statistic represents how much time this statement fingerprint took to execute compared to all other statements that were executed within the time period. It is expressed as a percentage. The runtime is the mean execution latency multiplied by the execution count.

See also

YesYes NoNo