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

contention: store contention events on non-SQL keys #61828

Merged
merged 1 commit into from
Mar 15, 2021
Merged

contention: store contention events on non-SQL keys #61828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 34 additions & 18 deletions docs/generated/http/full.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1410,14 +1410,22 @@ Response returned by target query's gateway node.
ListContentionEvents retrieves the contention events across the entire
cluster.

On the highest level, all IndexContentionEvents objects are ordered
according to their importance (as defined by the number of contention
events within each object).
On the middle level, all SingleKeyContention objects are ordered by their
keys lexicographically.
On the lowest level, all SingleTxnContention objects are ordered by the
number of times that transaction was observed to contend with other
transactions.
For SQL keys the following orderings are maintained:
- on the highest level, all IndexContentionEvents objects are ordered
according to their importance (as defined by the number of contention
events within each object).
- on the middle level, all SingleKeyContention objects are ordered by their
keys lexicographically.
- on the lowest level, all SingleTxnContention objects are ordered by the
number of times that transaction was observed to contend with other
transactions.

For non-SQL keys the following orderings are maintained:
- on the top level, all SingleNonSQLKeyContention objects are ordered
by their keys lexicographically.
- on the bottom level, all SingleTxnContention objects are ordered by the
number of times that transaction was observed to contend with other
transactions.

Support status: [reserved](#support-status)

Expand Down Expand Up @@ -1445,7 +1453,7 @@ Response object for ListContentionEvents and ListLocalContentionEvents.

| Field | Type | Label | Description | Support status |
| ----- | ---- | ----- | ----------- | -------------- |
| events | [cockroach.sql.contentionpb.IndexContentionEvents](#cockroach.server.serverpb.ListContentionEventsResponse-cockroach.sql.contentionpb.IndexContentionEvents) | repeated | A list of contention events on this node or cluster. | [reserved](#support-status) |
| events | [cockroach.sql.contentionpb.SerializedRegistry](#cockroach.server.serverpb.ListContentionEventsResponse-cockroach.sql.contentionpb.SerializedRegistry) | | All available contention information on this node or cluster. | [reserved](#support-status) |
| errors | [ListContentionEventsError](#cockroach.server.serverpb.ListContentionEventsResponse-cockroach.server.serverpb.ListContentionEventsError) | repeated | Any errors that occurred during fan-out calls to other nodes. | [reserved](#support-status) |


Expand Down Expand Up @@ -1474,14 +1482,22 @@ An error wrapper object for ListContentionEventsResponse.

ListLocalContentionEvents retrieves the contention events on this node.

On the highest level, all IndexContentionEvents objects are ordered
according to their importance (as defined by the number of contention
events within each object).
On the middle level, all SingleKeyContention objects are ordered by their
keys lexicographically.
On the lowest level, all SingleTxnContention objects are ordered by the
number of times that transaction was observed to contend with other
transactions.
For SQL keys the following orderings are maintained:
- on the highest level, all IndexContentionEvents objects are ordered
according to their importance (as defined by the number of contention
events within each object).
- on the middle level, all SingleKeyContention objects are ordered by their
keys lexicographically.
- on the lowest level, all SingleTxnContention objects are ordered by the
number of times that transaction was observed to contend with other
transactions.

For non-SQL keys the following orderings are maintained:
- on the top level, all SingleNonSQLKeyContention objects are ordered
by their keys lexicographically.
- on the bottom level, all SingleTxnContention objects are ordered by the
number of times that transaction was observed to contend with other
transactions.

Support status: [reserved](#support-status)

Expand Down Expand Up @@ -1509,7 +1525,7 @@ Response object for ListContentionEvents and ListLocalContentionEvents.

| Field | Type | Label | Description | Support status |
| ----- | ---- | ----- | ----------- | -------------- |
| events | [cockroach.sql.contentionpb.IndexContentionEvents](#cockroach.server.serverpb.ListContentionEventsResponse-cockroach.sql.contentionpb.IndexContentionEvents) | repeated | A list of contention events on this node or cluster. | [reserved](#support-status) |
| events | [cockroach.sql.contentionpb.SerializedRegistry](#cockroach.server.serverpb.ListContentionEventsResponse-cockroach.sql.contentionpb.SerializedRegistry) | | All available contention information on this node or cluster. | [reserved](#support-status) |
| errors | [ListContentionEventsError](#cockroach.server.serverpb.ListContentionEventsResponse-cockroach.server.serverpb.ListContentionEventsError) | repeated | Any errors that occurred during fan-out calls to other nodes. | [reserved](#support-status) |


Expand Down
Loading