Skip to content

DOCS-5189: Add missing hostInfo fields on OSX #2332

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

Closed
wants to merge 1 commit into from
Closed

DOCS-5189: Add missing hostInfo fields on OSX #2332

Show file tree
Hide file tree
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
78 changes: 39 additions & 39 deletions source/reference/command/buildInfo.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,67 +44,67 @@ buildInfo
"ok" : <num>
}

Consider the following documentation of the output of
:dbcommand:`buildInfo`:
Output
------

.. data:: buildInfo
.. data:: buildInfo

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

.. data:: buildInfo.gitVersion
.. data:: buildInfo.gitVersion

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

.. data:: buildInfo.sysInfo
.. data:: buildInfo.sysInfo

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

.. data:: buildInfo.loaderFlags
.. data:: buildInfo.loaderFlags

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

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

The flags passed to the compiler that builds the
:program:`mongod` binary.
The flags passed to the compiler that builds the
:program:`mongod` binary.

.. data:: buildInfo.allocator
.. data:: buildInfo.allocator

.. versionchanged:: 2.2
.. versionchanged:: 2.2

The memory allocator that :program:`mongod` uses. By default
this is ``tcmalloc`` after version 2.2, and ``system`` before
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.versionArray
.. data:: buildInfo.versionArray

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

.. TODO:: document buildInfo.version
.. TODO:: document buildInfo.version

.. data:: buildInfo.javascriptEngine
.. data:: buildInfo.javascriptEngine

.. versionchanged:: 2.4
.. versionchanged:: 2.4

A string that reports the JavaScript engine used in the
:program:`mongod` instance. By default, this is ``V8`` after
version 2.4, and ``SpiderMonkey`` before 2.4.
A string that reports the JavaScript engine used in the
:program:`mongod` instance. By default, this is ``V8`` after
version 2.4, and ``SpiderMonkey`` before 2.4.

.. data:: buildInfo.bits
.. data:: buildInfo.bits

A number that reflects the target processor architecture of the
:program:`mongod` binary.
A number that reflects the target processor architecture of the
:program:`mongod` binary.

.. data:: buildInfo.debug
.. data:: buildInfo.debug

A boolean. ``true`` when built with debugging options.
A boolean. ``true`` when built with debugging options.

.. data:: buildInfo.maxBsonObjectSize
.. data:: buildInfo.maxBsonObjectSize

A number that reports the :limit:`Maximum BSON Document Size
<BSON Document Size>`.
A number that reports the :limit:`Maximum BSON Document Size
<BSON Document Size>`.
174 changes: 95 additions & 79 deletions source/reference/command/hostInfo.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,137 +57,153 @@ hostInfo
"ok" : <return>
}

Consider the following documentation of these fields:

.. data:: hostInfo
Output
------

The document returned by the :dbcommand:`hostInfo`.
.. data:: hostInfo

.. data:: hostInfo.system
The document returned by the :dbcommand:`hostInfo`.

An embedded document providing information about the underlying
environment of the system running the :program:`mongod` or :program:`mongos`
.. data:: hostInfo.system

.. data:: hostInfo.system.currentTime
An embedded document providing information about the underlying
environment of the system running the :program:`mongod` or :program:`mongos`

A time stamp of the current system time.
.. data:: hostInfo.system.currentTime

.. data:: hostInfo.system.hostname
A timestamp of the current system time.

The system name, which should correspond to the output of
``hostname -f`` on Linux systems.
.. data:: hostInfo.system.hostname

.. data:: hostInfo.system.cpuAddrSize
The system name, which should correspond to the output of
``hostname -f`` on Linux systems.

A number reflecting the architecture of the system. Either
``32`` or ``64``.
.. data:: hostInfo.system.cpuAddrSize

.. data:: hostInfo.system.memSizeMB
A number reflecting the architecture of the system. Either
``32`` or ``64``.

The total amount of system memory (RAM) in megabytes.
.. data:: hostInfo.system.memSizeMB

.. data:: hostInfo.system.numCores
The total amount of system memory (RAM) in megabytes.

The total number of available logical processor cores.
.. data:: hostInfo.system.numCores

.. data:: hostInfo.system.cpuArch
The total number of available logical processor cores.

A string that represents the system architecture. Either ``x86``
or ``x86_64``.
.. data:: hostInfo.system.cpuArch

.. data:: hostInfo.system.numaEnabled
A string that represents the system architecture. Either ``x86``
or ``x86_64``.

A boolean value. ``false`` if NUMA is interleaved (i.e. disabled),
otherwise ``true``.
.. data:: hostInfo.system.numaEnabled

.. data:: hostInfo.os
A boolean value. ``false`` if NUMA is interleaved (i.e. disabled),
otherwise ``true``.

An embedded document that contains information about the operating
system running the :program:`mongod` and :program:`mongos`.
.. data:: hostInfo.os

.. data:: hostInfo.os.type
An embedded document that contains information about the operating
system running the :program:`mongod` and :program:`mongos`.

A string representing the type of operating system, such as
``Linux`` or ``Windows``.
.. data:: hostInfo.os.type

.. data:: hostInfo.os.name
A string representing the type of operating system, such as
``Linux`` or ``Windows``.

If available, returns a display name for the operating
system.
.. data:: hostInfo.os.name

.. data:: hostInfo.os.version
If available, returns a display name for the operating
system.

If available, returns the name of the distribution or operating
system.
.. data:: hostInfo.os.version

.. data:: hostInfo.extra
If available, returns the name of the distribution or operating
system.

An embedded document with extra information about the operating system
and the underlying hardware. The content of the
:data:`~hostInfo.extra` embedded document depends on the operating
system.
.. data:: hostInfo.extra

.. data:: hostInfo.extra.versionString
An embedded document with extra information about the operating system
and the underlying hardware. The content of the
:data:`~hostInfo.extra` embedded document depends on the operating
system.

A complete string of the operating system version and
identification. On Linux and OS X systems, this contains output
similar to ``uname -a``.
.. data:: hostInfo.extra.cpuString

.. data:: hostInfo.extra.libcVersion
A string containing a human-readable description of the system's
processor.

The release of the system ``libc``.
:data:`~hostInfo.extra.cpuString` only appears on OS X systems.

:data:`~hostInfo.extra.libcVersion` only appears on Linux
systems.
.. data:: hostInfo.extra.versionString

.. data:: hostInfo.extra.kernelVersion
A complete string of the operating system version and
identification. On Linux and OS X systems, this contains output
similar to ``uname -a``.

The release of the Linux kernel in current use.
.. data:: hostInfo.extra.libcVersion

:data:`~hostInfo.extra.kernelVersion` only appears on Linux
systems.
The release of the system ``libc``.

.. data:: hostInfo.extra.alwaysFullSync
:data:`~hostInfo.extra.libcVersion` only appears on Linux
systems.

:data:`~hostInfo.extra.alwaysFullSync` only appears on OS X
systems.
.. data:: hostInfo.extra.kernelVersion

.. data:: hostInfo.extra.nfsAsync
The release of the Linux kernel in current use.

:data:`~hostInfo.extra.nfsAsync` only appears on OS X
systems.
:data:`~hostInfo.extra.kernelVersion` only appears on Linux
systems.

.. data:: hostInfo.extra.cpuFrequencyMHz
.. data:: hostInfo.extra.alwaysFullSync

Reports the clock speed of the system's processor in megahertz.
:data:`~hostInfo.extra.alwaysFullSync` only appears on OS X
systems.

.. data:: hostInfo.extra.cpuFeatures
.. data:: hostInfo.extra.nfsAsync

Reports the processor feature flags. On Linux systems this the
same information that ``/proc/cpuinfo`` includes in the
``flags`` fields.
:data:`~hostInfo.extra.nfsAsync` only appears on OS X
systems.

.. data:: hostInfo.extra.pageSize
.. data:: hostInfo.extra.cpuFrequencyMHz

Reports the default system page size in bytes.
Reports the clock speed of the system's processor in megahertz.

.. data:: hostInfo.extra.numPages
.. data:: hostInfo.extra.cpuFeatures

:data:`~hostInfo.extra.numPages` only appears on Linux systems.
Reports the processor feature flags. On Linux systems this the
same information that ``/proc/cpuinfo`` includes in the
``flags`` fields.

.. data:: hostInfo.extra.maxOpenFiles
.. data:: hostInfo.extra.pageSize

Reports the current system limits on open file handles. See
:doc:`/reference/ulimit` for more information.
Reports the default system page size in bytes.

:data:`~hostInfo.extra.maxOpenFiles` only appears on Linux
systems.
.. data:: hostInfo.extra.physicalCores

.. data:: hostInfo.extra.scheduler
Reports the number of physical, non-HyperThreading, cores available on the
system.

Reports the active I/O scheduler.
:data:`~hostInfo.extra.scheduler` only appears on OS
X systems.
:data:`~hostInfo.extra.physicalCores` only appears on OS X systems.

.. data:: hostInfo.extra.numPages

.. admin-only
:data:`~hostInfo.extra.numPages` only appears on Linux systems.

.. data:: hostInfo.extra.maxOpenFiles

Reports the current system limits on open file handles. See
:doc:`/reference/ulimit` for more information.

:data:`~hostInfo.extra.maxOpenFiles` only appears on Linux
systems.

.. data:: hostInfo.extra.scheduler

Reports the active I/O scheduler.
:data:`~hostInfo.extra.scheduler` only appears on OS
X systems.


.. admin-only