[DOCS-12189] Docs for SERVER-36501: serverStatus support for prepared transactions Created: 07/Nov/18  Updated: 13/Nov/23  Resolved: 09/Nov/18

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 4.1.5, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Kay Kim (Inactive)
Resolution: Fixed Votes: 0
Labels: prepare_diagnostics
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-36501 serverStatus support for prepared tra... Closed
Participants:
Days since reply: 5 years, 13 weeks, 5 days ago
Epic Link: DOCS: 4.2 Server/Tools

 Description   

Description

Description:

Added 5 new fields to serverStatus.transactions:

totalPrepared (type: long, default: 0) - the total number of prepared transactions since the last server startup.

totalPreparedThenCommitted (type: long, default: 0) - the total number of prepared transaction commits.

totalPreparedThenAborted (type: long, default: 0) - the total number of prepared transaction aborts.

currentPrepared (type: long, default: 0) - the current number of transactions in the prepared state.

oldestActiveOplogEntryOpTime (type: timestamp, default: Timestamp(0, 0)) - the optime of the oldest oplog entry for any active transaction.

Engineering Ticket Description:

Similar to the transactions diagnostics project, we want to maintain certain metrics in the serverStatus section. The TransactionsSSS::generateSection method returns a BSON object that goes into the transactions section of the serverStatus output.

This ticket can be split into multiple commits if needed. We will want to output:

  • the total number of prepared transactions
  • the total number of committed prepared transactions
  • the total number of aborted prepared transactions

We will need to add these counters to ServerTransactionMetrics and the transactions_stats.idl class, so that we can serialize these counters to the serverStatus output object in the TransactionsSSS::generateSection method.

We will also update the TransactionMetricsObserver to increment/decrement the stats when appropriate.

Scope of changes

serverStatus page only

When we doc 2-phase commits, that will contain more info and affect more pages

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 09/Nov/18 ]

Author:

{'name': 'kay', 'email': 'kay.kim@10gen.com', 'username': 'kay-kim'}

Message: DOCS-12189: serverStatus transactions.prepared metrics
Branch: master
https://github.com/mongodb/docs/commit/f94599415f796724e8b3cab50ec7b417606612e7

Generated at Thu Feb 08 08:04:37 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.