Skip to content

DOCS-5619: Annotate buildInfo flag support #2437

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

Closed
wants to merge 1 commit into from
Closed
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
78 changes: 55 additions & 23 deletions source/reference/command/buildInfo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,41 +51,37 @@ Output

The document returned by the :dbcommand:`buildInfo` command.

Supported
~~~~~~~~~

These fields are stable and should provide consistent behavior.

.. data:: buildInfo.gitVersion

The commit identifier that identifies the state of the code used
to build the :program:`mongod`.

.. data:: buildInfo.sysInfo

A string that holds information about the operating system,
hostname, kernel, date, and Boost version used to compile the
:program:`mongod`.

.. data:: buildInfo.loaderFlags

The flags passed to the loader that loads the :program:`mongod`.

.. data:: buildInfo.compilerFlags
.. data:: buildInfo.versionArray

The flags passed to the compiler that builds the
:program:`mongod` binary.
An array that conveys version information about the
:program:`mongod` instance. See :data:`~buildInfo.version` for a
more readable version of this string.

.. data:: buildInfo.allocator
.. data:: document buildInfo.version

.. versionchanged:: 2.2
A string that conveys version information about the
:program:`mongod` instance. If you need to present version information to
a human, this field is preferable to :data:`~buildInfo.versionArray`.

The memory allocator that :program:`mongod` uses. By default
this is ``tcmalloc`` after version 2.2, and ``system`` before
2.2.
This string will take the format ``<major>.<minor>.<patch>`` in the case of
a release, but development builds may contain additional information.

.. data:: buildInfo.versionArray
.. data:: document buildInfo.storageEngines

An array that conveys version information about the
:program:`mongod` instance. See :data:`~buildInfo.version` for a
more readable version of this string.
.. versionadded:: 3.2

.. TODO:: document buildInfo.version
A list of :doc:`storage engines </faq/storage>` avilable to the
:program:`mongod` server.

.. data:: buildInfo.javascriptEngine

Expand All @@ -108,3 +104,39 @@ Output

A number that reports the :limit:`Maximum BSON Document Size
<BSON Document Size>`.

.. data:: buildInfo.openssl

An embedded document describing the version of OpenSSL that :program:`mongod`
was built with, as well as the version of OpenSSL that :program:`mongod`
is currently using.

.. data:: buildInfo.modules

A list of add-on modules that :program:`mongod` was built with. Possible
values currently include "enterprise" and "rocksdb".

Unstable
~~~~~~~~

These fields are for internal use only, and you should not expect their behavior
or existence to remain consistent on any level.

.. data:: buildInfo.sysInfo

.. deprecated:: 3.2

:data:`buildInfo.sysInfo` no longer contains useful information.

.. data:: buildInfo.allocator

.. versionchanged:: 2.2

The memory allocator that :program:`mongod` uses. By default
this is ``tcmalloc`` after version 2.2, and ``system`` before
2.2.

.. data:: buildInfo.buildEnvironment

An embedded document containing various debugging information about the
:program:`mongod` build environment.