.. _health-report:

Login Report
---------------


.. _19.2.1|VOSS-542|EKB-1564:
.. _21.4|EKB-13259:   
.. _21.4-PB2|EKB-14337:   

On login, the system displays a report indicating the status of the system
before displaying the CLI user prompt. This report shows the following:

.. parsed-literal::

   Last login: Mon Oct 31 13:45:17 UTC 2022 from 172.29.99.43 on pts/2
   
   host: VOSS, role: webproxy,application,database, load: 0.58, USERS: 3
   date: 2022-10-31 13:53:46 +00:00, up: 4:24
   network: 192.168.160.3, ntp: 172.29.68.56
   database: 3.5GB
   WARNING: TRANSACTION DATABASE MAINTENANCE NOT SCHEDULED - SETUP SCHEDULE FOR REGULAR MAINTENANCE
   WARNING: CURRENT LICENSE FOR 6049914029c384002787ef2e (Automate) IS SET TO EXPIRE ON 2022-11-07
   
   
       mail - local mail management          keys - ssh/sftp credentials       
    network - network management           backup - manage backups             
       voss - voss management tools           log - manage system logs         
   database - database management          notify - notifications control      
   schedule - scheduling commands        selfservice - selfservice management    
       diag - system diagnostic tools      system - system administration      
       snmp - snmp configuration             user - manage users               
    cluster - cluster management           drives - manage disk drives         
        web - web server management           app - manage applications        
    license - license management




The report explanation is shown below:

+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name                                               | Description                                                                                                                                                               |
+====================================================+===========================================================================================================================================================================+
| host                                               | hostname                                                                                                                                                                  |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| role                                               | The role of the node: any of webproxy, application, database.                                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Last login                                         | Last console login and IP address source. This is only shown if there has been a previous login.                                                                          |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| load                                               | The load average of the system.                                                                                                                                           |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| USERS                                              | The number of CLI users currently logged in. This is only shown if more than one user is logged in.                                                                       |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| up                                                 | The system uptime.                                                                                                                                                        |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| services                                           | The status of the system services.                                                                                                                                        |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| HEALTH                                             | A Health notification, for example a scheduled mail message, is set up or not.                                                                                            |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| database                                           | Current database size.                                                                                                                                                    |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DATABASE TRANSACTION SIZE                          | If the size of the TRANSACTION database collection exceeds 20GB, the current size is reported.                                                                            |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| DATABASE TRANSACTION COUNT                         | If the number of entries in the TRANSACTION database collection exceeds 500,000, the current number is reported.                                                          |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| CURRENT LICENSE FOR <platform ID> (<product>)      | INFO, WARNING and ERROR notifications on license status, raised according to number of days before expiry - see below.                                                    |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| TRANSACTION DATABASE MAINTENANCE NOT SCHEDULED     | A schedule with either the command ``voss transaction archive`` or ``voss transaction delete`` is not set up.                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Failed logins                                      | If the user failed to log in prior to a successful login, the count, date and origin of the attempts are shown. A successful login resets this login count.               |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Please note: some checks took too long to complete | If the health checks do not complete within 100 seconds, these are terminated with a message.                                                                             |
| and were terminated                                |                                                                                                                                                                           |
+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


* disk, CPU and memory warnings are shown if applicable
* warnings are displayed in upper-case to draw attention
* DATABASE TRANSACTION warnings are shown for the following thresholds:

  * Transaction collection exceeds 500,000 documents
  * Transaction collection exceeds 20GB

* <INFO|WARNING|ERROR>: CURRENT LICENSE FOR <platform ID> (<product>) <IS SET TO EXPIRE|EXPIRED> ON <date>

  Note: The <platform ID> value is shown as platform ID on the Grace period license. After licensing, it is changed
  to the *platform description* as in the obtained license.

  The message levels are according to remaining number of days on the license, as follows:

  * INFO: 90 < remaining days <= 120
  * WARNING: 0 < remaining days <= 90
  * ERROR: 0 >= remaining days


  .. note::
    
     * No messages are displayed while licenses have more than 120 days remaining.
     * License status messages are ony displayed on
       
       * unified nodes in a Unified Node Topology
       * application nodes in a Modular Cluster Topology
       
  For details on license management, refer to:
 
  * :ref:`product-licensing-cli`
  * 
    .. raw:: html
    
       <a href="../concepts-voss-license-management.html">Product License Management</a>

    .. raw:: latex

       The topic on Product License management in the Core Feature Guide.

A list of diagnostic tools is available in the topic on Diagnostic Tools.

* For schedule setups if the ``HEALTH: NOT MONITORED`` message is shown, see :ref:`enable_health_monitoring`.
* For schedule setups if the ``TRANSACTION DATABASE MAINTENANCE NOT SCHEDULED``
  message shows, see :ref:`enable-database-schedule`.
* See ``diag health`` at :ref:`diagnostic-troubleshoot`.
