db.hostInfo.txt

=============
db.hostInfo()
=============

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

.. method:: db.hostInfo()

   Returns a document with information about the underlying system
   that the :binary:`~bin.mongod` or :binary:`~bin.mongos` runs on. Some of the
   returned fields are only included on some platforms.

   :method:`db.hostInfo()` provides a :binary:`~bin.mongosh` helper
   method around the :dbcommand:`hostInfo` command. The output of
   :method:`db.hostInfo()` on a Linux system will resemble the
   following:

   .. code-block:: javascript

      {
         "system" : {
                "currentTime" : ISODate("<timestamp>"),
                "hostname" : "<hostname>",
                "cpuAddrSize" : <number>,
                "memSizeMB" : <number>, 
                "memLimitMB" : <number>,  
                "numCores" : <number>,
                "cpuArch" : "<identifier>",
                "numaEnabled" : <boolean>
         },
         "os" : {
                "type" : "<string>",
                "name" : "<string>",
                "version" : "<string>"
         },
         "extra" : {
                "versionString" : "<string>",
                "libcVersion" : "<string>",
                "kernelVersion" : "<string>",
                "cpuFrequencyMHz" : "<string>",
                "cpuFeatures" : "<string>",
                "pageSize" : <number>,
                "numPages" : <number>,
                "maxOpenFiles" : <number>
         },
         "ok" : <return>
      }

   See :data:`hostInfo` for full documentation of the output of
   :method:`db.hostInfo()`.


Compatibility
-------------

.. |command| replace:: method

This method is available in deployments hosted in the following environments:

.. include:: /includes/fact-environments-atlas-only.rst

.. include:: /includes/fact-environments-atlas-support-no-free.rst

.. include:: /includes/fact-environments-onprem-only.rst