Skip to content

DOCS-11246: add appName connection string option #3340

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.

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

Merged
merged 1 commit into from
Jun 12, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 3 additions & 5 deletions source/includes/fact-client-appname.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.. versionadded:: 3.4

The identifier of the client application which ran the operation.
If the operation was run in :doc:`the MongoDB shell</mongo>`,
the appName is always ``"MongoDB Shell"``. If the operation
originated from a :ecosystem:`driver</drivers>`, ``appName`` may
be set to a custom string.
The identifier of the client application which ran the operation. Use
the :urioption:`appName` connection string option to set a custom value
for the ``appName`` field.
18 changes: 18 additions & 0 deletions source/reference/connection-string.txt
Original file line number Diff line number Diff line change
Expand Up @@ -671,6 +671,24 @@ Miscellaneous Configuration
* - Connection Option
- Description

* - .. urioption:: appName

- Specify a custom app name. The app name appears in

- :binary:`~bin.mongod` and :binary:`~bin.mongos` :doc:`logs
</reference/log-messages>`,

- the :data:`currentOp.appName` field in the :dbcommand:`currentOp`
command and :method:`db.currentOp()` method output,

- the :data:`system.profile.appName` field in the :doc:`database
profiler </reference/database-profiler>` output.

If you do not specify a custom app name, the :binary:`~bin.mongo`
shell uses the default "``MongoDB Shell``".

.. versionadded:: 4.0

* - .. urioption:: retryWrites

- Enable :ref:`retryable writes <retryable-writes>`.
Expand Down
7 changes: 7 additions & 0 deletions source/release-notes/4.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,13 @@ Miscellaneous
created outside of a session, you cannot call :dbcommand:`getMore`
inside a session.

- MongoDB 4.0 adds support for using the :urioption:`appName` connection
string option for setting a custom app name when connecting from the
:binary:`~bin.mongo` shell. Previously, only MongoDB drivers supported
using the :urioption:`appName` to set a custom value and the
:binary:`~bin.mongo` shell used the default ``MongoDB Shell`` value as the
app name.

Changes Affecting Compatibility
-------------------------------

Expand Down