.. _health-report:

Health Report
-------------

.. index:: security;security update

.. _19.2.1|VOSS-542|EKB-1564:

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

.. parsed-literal::

   Last login: Fri Aug 23 07:26:25 UTC 2019 from 172.29.41.201 on pts/0
   host: VOSS-UN-1, role: webproxy,application,database, load: 0.27
   date: 2019-08-23 07:28:14 +00:00, up: 1 day, 18:09
   network: 192.168.100.3, ntp: 172.29.1.15
   SECURITY: There are security updates available for your system. Please 
    run 'security check' for more information.
   HEALTH: NOT MONITORED
   database: 25Gb
   DATABASE TRANSACTION SIZE: 21.75GB
   DATABASE TRANSACTION COUNT: 500003
   Failed logins: 1 since Thu Aug 22 13:44:47 2019 from atlantic.biz


       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            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        template - template pack creator      
   security - security update tools      

   platform@development:~$


The report explanation is shown below:

+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name                                           | Description                                                                                                                                                               |
+================================================+===========================================================================================================================================================================+
| 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.                                                                                                                                        |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| SECURITY                                       | Whether security updates are available - shown if updates are available. Refer to the Security Patches section. Security updates are installed using **security update**. |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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.                                                          |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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.               |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


* 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

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`.

.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM