[DOCS-10784] Restore documentation for configureFailPoint command Created: 13/Sep/17  Updated: 22/Jan/24

Status: Backlog
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Jeremy Mikola Assignee: Unassigned
Resolution: Unresolved Votes: 6
Labels: backlog, feature, reopened, server-docs-bug-bash, triage
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to SERVER-29606 Implement failpoint to aid testing re... Closed
Participants:
Days since reply: 1 year, 13 weeks, 6 days ago

 Description   

The configureFailPoint command is relevant to driver testing. Older versions of the manual had a documentation page for this, and it would be helpful if we could bring that back for reference. I don't need an exhaustive list of fail points (each of which may take custom options via the command's data field), but a general example of the command and description of the common mode argument would be helpful. For instance, I was aware that mode.times existed but only recently learned that mode.skip is also supported (I'm not sure if this always existed or if it was introduced in a recent server version).

I'll note that search results for "configureFailPoint" are comprised mainly of blog posts from our past and present employees and random websites that cloned only copies of the MongoDB manual.

We may be able to infer supported options from src/mongo/util/fail_point.cpp.



 Comments   
Comment by Sarah Olson [ 03/Nov/22 ]

Thanks for the additional detail jmikola@mongodb.com. We'll look into this.

Comment by Education Bot [ 31/Oct/22 ]

Hello! This ticket has been closed due to inactivity. If you believe this ticket is still important, please reopen it and leave a comment to explain why. Thank you!

Comment by Githook User [ 16/Aug/21 ]

Author:

{'name': 'Ezra Chung', 'email': '88335979+eramongodb@users.noreply.github.com', 'username': 'eramongodb'}

Message: Add instructions to enable fail points for test suite (#817)

Several tests require use of the configureFailPoint command to trigger
server-side errors. The command must be enabled via configuration file
or command line option when starting mongod.

The configureFailPoint command is not yet documented; see DOCS-10784.
Branch: master
https://github.com/mongodb/mongo-cxx-driver/commit/7896cccddf8ad404b017dd4367d8e54dbc5e76f9

Comment by Githook User [ 16/Aug/21 ]

Author:

{'name': 'Ezra Chung', 'email': '88335979+eramongodb@users.noreply.github.com', 'username': 'eramongodb'}

Message: Add instructions to enable fail points for test suite (#846)

Several tests require use of the configureFailPoint command to trigger
server-side errors. The command must be enabled via configuration file
or command line option when starting mongod.

The configureFailPoint command is not yet documented; see DOCS-10784.
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/bd381490c141a52f149c247ed592961c734d733a

Comment by Daniel Aprahamian (Inactive) [ 20/Jun/18 ]

:+1: I would love to see this.

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