TrueSight Health Check Tool

The TrueSight Health Check Tool checks for the following:

  • If your environment is optimized for performance and stability.
  • If your environment has upgrade impact issues. 

When you run the tool, it generates an HTML report that lists the actual and recommended values for parameters such as OS settings, database, logs, configuration files, and so on.

You can also schedule the tool to automatically run periodically. 


To download the TrueSight Health Check Tool

Download the tool from this TrueSight Presentation Server  or from the knowledge article  https://communities.bmc.com/docs/DOC-122750 .


To run the TrueSight Health Check Tool

  1. As the user who installed TrueSight Operations Management, go to the following folder using a command prompt:  
    (TrueSight Presentation Server) %TRUESIGHTPSERVER_HOME%\utility\TrueSightHealthCheck (Windows) or $TRUESIGHTPSERVER_HOME/utility/TrueSightHealthCheck (Linux).
    (TrueSight Infrastructure Management) %BPPM_SERVER_HOME%\utility\TrueSightHealthCheck (Windows) or $BPPM_SERVER_HOME/utility/TrueSightHealthCheck (Linux).
  2. Run the following command:
    (Windows) TrueSightHealthCheck.bat
    (Linux) sh TrueSightHealthCheck.sh
  3. Check the summary report that is generated at utility\TrueSightHealthCheck\reports (Windows) or utility/TrueSightHealthCheck/reports (Linux).
    For example, C:\Program Files\BMC Software\TrueSight\utility\TrueSightHealthCheck\reports\TSIM_TruesightHealth_2019082801530.html.
    Using the recommendations from the generated report, you can reconfigure your system to improve performance and reliability.


To schedule the tool to run automatically

You can schedule the TrueSight Health Check Tool to run periodically on TrueSight Infrastructure Management and TrueSight Presentation Server by creating a schedule job (Windows) or a cron job (Linux).

In release 11.3.07, the TrueSight Health Check Tool is scheduled to run every Monday at 6:30 AM. You can change the cronjob or the task schedule according to your requirement. If you have configured an email ID in TrueSight Infrastructure Management and TrueSight Presentation Server, the TrueSight Health Check Tool reports are automatically sent to this email.

Important

If you have already added a crontab entry for scheduling the TrueSight Health Check Tool execution before upgrading to version 11.3.07, the crontab entry is overwritten during the upgrade. Ensure that you customize the configurations again after the upgrade.



(Windows) Creating a schedule job for TrueSight Infrastructure Management

  1. In the same folder where the TrueSightHealthCheck.bat is located, create a new bat file called TSIMHCTScheduler.bat.
    The TrueSightHealthCheck.bat file is located at:  %BPPM_SERVER_HOME%\utility\TrueSightHealthCheck

    Click here to view a TSIMHCTScheduler.bat sample file
    @echo off
    set BPPM_SERVER_HOME="C:\Program Files\BMC Software\TrueSight"
    set FORCE_PRODUCT_TYPE=TSIM
    cd "C:\Program Files\BMC Software\TrueSight\utility\TrueSightHealthCheck"
    TrueSightHealthCheck.bat -email
    exit /b 0

  2. Add the following contents to the TSIMHCTScheduler.bat file:

    @echo off

    set BPPM_SERVER_HOME=<path to BPPM SERVER HOEM>

    set FORCE_PRODUCT_TYPE=TSIM

    cd "%BPPM_SERVER_HOME%\utility\TrueSightHealthCheck."

    TrueSightHealthCheck.bat -email

  3. Add the scheduler job bu using the following command:

    schtasks /create /tn "TSIMHCT_ScheduleJob" /tr "%BPPM_SERVER_HOME%\utility\TrueSightHealthCheck\TSIMHCTScheduler.bat" /sc <frequency> /st <time> /ru "" /F

    Replace %BPPM_SERVER_HOME%\utility\TrueSightHealthCheck\TSIMHCTScheduler.bat with the path of the TSIMHCTScheduler.bat file.

(Windows) Creating a schedule job for TrueSight Presentation Server

  1. In the same folder where the TrueSightHealthCheck.bat is located, create a new bat file called TSPSHCTScheduler.bat.
    The TrueSightHealthCheck.bat file is located at:  %TRUESIGHTPSERVER_HOME%\utility\TrueSightHealthCheck

    Click here to view a TSPSHCTScheduler.bat sample file
    @echo off
    set BPPM_SERVER_HOME="C:\Program Files\BMC Software\TrueSight"
    set FORCE_PRODUCT_TYPE=TSIM
    cd "C:\Program Files\BMC Software\TrueSight\utility\TrueSightHealthCheck"
    TrueSightHealthCheck.bat -email
    exit /b 0

  2. Add the following contents to the TSPSHCTScheduler.bat file:

    @echo off

    set TRUESIGHTPSERVER_HOME=<path to TSPS HOME>

    set FORCE_PRODUCT_TYPE=TSPS

    cd "%TRUESIGHTPSERVER_HOME%\utility\TrueSightHealthCheck"

    TrueSightHealthCheck.bat -email

  3. Add the scheduler job bu using the following command:

    schtasks /create /tn "TSPSHCT_ScheduleJob" /tr "%TRUESIGHTPSERVER_HOME%\utility\TrueSightHealthCheck\TSPSHCTScheduler.bat" /sc <frequency> /st <time> /ru "" /F

    Replace %TRUESIGHTPSERVER_HOME%\utility\TrueSightHealthCheck\TSPSHCTScheduler.bat with the path of the TSPSHCTScheduler.bat file.

(Linux) Adding a cron job for TrueSight Infrastructure Management

  1. Log in as the user with which TrueSight Infrastructure Management is installed.

  2. In the same folder where the TrueSightHealthCheck.sh is located, create a new bat file called TSIMHCTScheduler.sh.
    The TrueSightHealthCheck.sh file is located at:  %BPPM_SERVER_HOME%\utility\TrueSightHealthCheck

    Click here to view a TSIMHCTScheduler.sh sample file
    set echo off
    export BPPM_SERVER_HOME=/auto_product/tsim
    export FORCE_PRODUCT_TYPE=TSIM
    cd /auto_product/tsim/utility/TrueSightHealthCheck
    ./TrueSightHealthCheck.sh -email
    exit


  3. Add the following contents to the TSIMHCTScheduler.bat file:

    set echo off

    export BPPM_SERVER_HOME=<PATH TO SERVER HOME installation dir>

    export FORCE_PRODUCT_TYPE=TSIM

    cd  $BPPM_SERVER_HOME/utility/TrueSightHealthCheck

    ./TrueSightHealthCheck.sh -email

    exit
  4. Create the cron job entry with crontab -e by replacing $BPPM_SERVER_HOME with the actual path.

  5. Set the schedule for the job, for example once a day or once a week.

    Click here to view an example

    Schedule the cron job to run on Sunday at 5:30 AM by using the following command:

    30 5 * * 0  . /opt/bmc/TrueSight/utility/TrueSightHealthCheck/TSIMHCTScheduler.sh > /opt/bmc/TrueSight/utility/TrueSightHealthCheck/logs/hctCronjob.log 2>&1

    Schedule the cron job to run daily at 6:30 PM by using the following command:

    30 18 * * 1-6  . /opt/bmc/TrueSight/utility/TrueSightHealthCheck/TSIMHCTScheduler.sh > /opt/bmc/TrueSight/utility/TrueSightHealthCheck/logs/hctCronjob.log 2>&1

(Linux) Adding a cron job for TrueSight Presentation Server

  1. Log in as the user with which TrueSight Presentation Server is installed.

  2. In the same folder where the TrueSightHealthCheck.sh is located, create a new bat file called TSPSHCTScheduler.sh.
    The TrueSightHealthCheck.sh file is located at: %TRUESIGHTPSERVER_HOME%\utility\TrueSightHealthCheck

    Click here to view a TSPSHCTScheduler.sh sample file
    set echo off
    export BPPM_SERVER_HOME=/auto_product/tsim
    export FORCE_PRODUCT_TYPE=TSIM
    cd /auto_product/tsim/utility/TrueSightHealthCheck
    ./TrueSightHealthCheck.sh -email
    exit


  3. Add the following contents to the TSPSHCTScheduler.bat file:

    set echo off

    export TRUESIGHTPSERVER_HOME=<PATH TO SERVER HOME installation dir>

    export FORCE_PRODUCT_TYPE=TSPS

    cd  $TRUESIGHTPSERVER_HOME/utility/TrueSightHealthCheck

    ./TrueSightHealthCheck.sh -email

    exit
  4. Create the cron job entry with crontab -e by replacing $TRUESIGHTPSERVER_HOME with the actual path.

  5. Set the schedule for the job, for example once a day or once a week.

    Click here to view an example

    Schedule the cron job to run on Sunday at 5:30 AM by using the following command:

    30 5 * * 0  . /opt/bmc/TrueSightPserver/utility/TrueSightHealthCheck/TSPSHCTScheduler.sh > /opt/bmc/TrueSightPserver/utility/TrueSightHealthCheck/logs/hctCronjob.log 2>&1

    Schedule the cron job to run daily at 6:30 PM by using the following command:

    30 18 * * 1-6  . /opt/bmc/TrueSightPserver/utility/TrueSightHealthCheck/TSPSHCTScheduler.sh > /opt/bmc/TrueSightPserver/utility/TrueSightHealthCheck/logs/hctCronjob.log 2>&1


Scheduling the report email

You can schedule the generated TrueSight Health Check Tool report to be emailed automatically to the administrator.

Ensure that you have configured the administrator email. For more information, see the following links:

For TrueSight Presentation Server: Monitoring the Presentation Server environment 

For TrueSight Infrastructure Management: Configuring e-mail settings to receive alerts

On Windows:

  1. Create a batch file with the following content in a folder that is outside the product installation folder. 

    Presentation Server
    cd %TRUESIGHTPSERVER_HOME%\utility\TrueSightHealthCheck
    TrueSightHealthCheck.bat -email
    Infrastructure Management Server
    cd %BPPM_SERVER_HOME%\utility\TrueSightHealthCheck
    TrueSightHealthCheck.bat -email
  2. Schedule a task in the Windows task scheduler to run as per your requirement. BMC recommends to schedule it weekly. Provide the path of the batch file as the execution program.

On Linux:

Create a crontab scheduler as per the following sample shell file in a folder that is outside the product installation folder. 

When you create the crontab, make sure that it is applicable to the Presentation Server user. Test the shell and batch file manually before you add it in the scheduled task and crontab.

Presentation Server
TRUESIGHTPSERVER_HOME= <The Presentation Server install directory. For example: /opt/bmc/TrueSightPServer>
cd $TRUESIGHTPSERVER_HOME/utility/TrueSightHealthCheck
sh TrueSightHealthCheck.sh -email
Infrastructure Management Server
cd $BPPM_SERVER_HOME/utility/TrueSightHealthCheck
sh TrueSightHealthCheck.sh -email


TrueSight Health Check Tool validations

The command prompt displays the steps that are being processed by the TrueSight Health Check Tool. The following steps are performed in the TrueSight Infrastructure Management Health Check Tool.

Step 1 - initializes the tool and sets environment variables needed for the tool.
Step 2 - validates the OS prerequisites for running the tool.
Step 3 - validates the OS configuration for running TrueSight Infrastructure Management. This validation is the same as the installer – checks OS, RAM, CPU, disk space, and so on.
Step 4 - validates the performance tuning parameters and includes heap settings, garbage collection settings, and so on.
Step 5 - validates the properties most commonly used in the product. It looks for duplicate parameters, CTRL-M characters, and so on.
Step 6-  validates to see if a particular message exists in the log file – any errors or concerns.
Step 7 - runs several checks against the database and checks Oracle tuning parameters, MFD counts, instance counts, and so on.
Step 8 - validates the ports between components and checks if there are any issues in connecting the TrueSight Infrastructure Management to the TrueSight Presentation Server.
Step 9 - validates the other node is running (only applicable to HA).
Step 10 - executes the scripts used for netstat details, such as OS patch levels, important version details, and so on. The details are captured in the Summary Report.
Step 11 - consolidates all the reports generated in the steps above and creates the Summary Report. It displays the path to the report that was generated as a result of running the tool.

If any of these steps fail, the TrueSight Health Check Tool continues through the rest of the steps.


Uninstalling the TrueSight Health Check Tool

Perform the following steps:

  1. On the host where TrueSight Presentation Server is installed, delete the following folder:
    • (Windows) %TRUESIGHTPSERVER_HOME%\utility\TrueSightHealthCheck
    • (Linux) $TRUESIGHTPSERVER_HOME/utility/TrueSightHealthCheck
  2. On the host where TrueSight Infrastructure Management is installed, delete the following folder:
    • (Windows) %BPPM_SERVER_HOME%\utility\TrueSightHealthCheck
    • (Linux) $BPPM_SERVER_HOME/utility/TrueSightHealthCheck