[DOCS-10836] Docs for SERVER-31170: Add support for session and transaction number to benchRun Created: 27/Sep/17  Updated: 27/Oct/23  Resolved: 20/Nov/17

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 3.6.0-rc0

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

Participants:
Days since reply: 6 years, 12 weeks, 3 days ago
Epic Link: DOCS: 3.6 Server

 Description   

Documentation Request Summary:

Not sure if we document the benchRun parameters somewhere, but if we do we need to include the two new parameters listed in the description.

Engineering Ticket Description:

The benchRun utility is used by both mongo-perf and sys-perf. In order to test the performance of retryable writes we need to make benchRun use sessions and send transaction numbers.

In order to achieve this, benchRun will be extended with the following options:

  • useSessions (bool) - when this option is enabled, benchRun will call startSession for each connection that it creates and will add the returned session id along with every command that it sends to the server.
  • useIdempotentWrites (bool) - when this option is enabled, benchRun will keep an always-incrementing transaction number for each workload thread and will send that as a txnNumber.

Both these parameters may only be specified if useWriteCmd is true and will fail with a BadOptions error code otherwise.

NOTE: The combination of sessionId/txnNumber makes the write retryable, but this ticket will not add any functionality to benchRun to actually retry since this is a much more involved task.



 Comments   
Comment by Kay Kim (Inactive) [ 20/Nov/17 ]

We don't have documentation on benchRun.

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