Document collection behavior of transaction_contention_events
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 62/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- databases, documentation
Research direction
Read the transaction_contention_events section on the linked crdb-internal.html page, then review the expected collection behavior described in issue 149613's linked comment. Update the documentation to explain when contention events are collected and how the table should be used, so its behavior no longer appears random.
Written by the indexing model from the issue text.
Description
Page: https://www.cockroachlabs.com/docs/v25.3/crdb-internal.html#transaction_contention_events
What is the reason for your feedback?
[X] Missing the information I need
[ ] Too complicated
[ ] Out of date
[ ] Something is broken
[ ] Other
Additional details
In https://github.com/cockroachdb/cockroach/issues/149613#issuecomment-3225419219, @alyshanjahani-crl described the expected collection behavior of the crdb_internal.transaction_contention_events table.
Without knowing what the collection behavior of the table is supposed to be, the behavior of the table is confusing: it appears random that sometimes a contention event is recorded and sometimes it isn't.
Documenting the collection behavior of the table would avoid this confusion, avoid the appearance of a bug, and explain how the table can be used.
Jira issue: DOC-14823
- Dominant language
- HTML
- Stars
- 212
- Forks
- 477
- Avg merge
- 40m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cockroachdb/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
cockroachdb/docs#23456 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
cockroachdb/docs#23454 ·
-
Difficulty 2/5 1-2 days Newbie friendliness 68/100
cockroachdb/docs#23445 · 1 comment ·
-
sql-diagram-validation
Difficulty 1/5 Under an hour Newbie friendliness 85/100
cockroachdb/docs#23444 · 4 comments ·
-
Feedback: BACKUP Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
cockroachdb/docs#23394 ·
All issues in cockroachdb/docs
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
OpenLiberty/open-liberty#35839 ·
-
affects-9.0 found-by-ai may-affects-25.10 may-affects-26.3 may-affects-26.9 may-affects-7.5 may-affects-8.1 may-affects-8.5 severity/major sig/execution type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
antlr/grammars-v4#5014 · 1 comment ·