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

Jump to bottom

Document errorLabels option for failCommand fail point #1488

Closed
wants to merge 1 commit into from
Closed

Document errorLabels option for failCommand fail point #1488

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
6 changes: 6 additions & 0 deletions source/unified-test-format/unified-test-format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3892,6 +3892,7 @@ The ``failCommand`` fail point may be configured like so::
failCommands: [<string>, ...],
closeConnection: <boolean>,
errorCode: <integer>,
errorLabels: [<string>, ...],
writeConcernError: <object>,
appName: <string>,
blockConnection: <boolean>,
Expand All @@ -3909,6 +3910,10 @@ if desired:
* ``errorCode``: Optional integer, which is unset by default. If set, the
command will not be executed and the specified command error code will be
returned as a command error.
* ``errorLabels``: Optional array of strings. If set, this list overrides the
server's normal behavior for adding error labels. An empty array may be used
to suppress the server from adding error labels to the response. New in server
4.3.1 (`SERVER-43941 <https://jira.mongodb.org/browse/SERVER-43941>`__).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lifted from https://github.com/mongodb/mongo/wiki/The-%22failCommand%22-fail-point#failcommand-parameters

* ``appName``: Optional string, which is unset by default. If set, the fail
point will only apply to connections for MongoClients created with this
``appname``. New in server 4.4.0-rc2
Expand Down Expand Up @@ -4061,6 +4066,7 @@ Changelog
..
Please note schema version bumps in changelog entries where applicable.

:2024-01-02: Document ``errorLabels`` option for ``failCommand`` fail point.
:2023-10-04: **Schema version 1.17.**
Add ``serverHeartbeatStartedEvent``, ``serverHeartbeatSucceededEvent``, and
``serverHeartbeatFailedEvent`` for asserting on SDAM server heartbeat events.
Expand Down
Loading