Creating Health Check Reports

Health Check collects and analyzes data on the configuration, status and operation of the Signiant Manager hardware, software and operating system. This report highlights any areas that may be impacting system performance. The information in the Health Check is primarily intended for analysis by the Signiant technical support team. This report can be distributed by email attachment, or written to the Manager log folder or a supplementary folder.

The Manager version, installed software packages, and user permissions may impact the data that is available in the Health Check Report.

The Health Check Report will capture most errors, as the objective is to collect data from the Manager regardless of an exception occurring. Any errors encountered during data collection are listed in the job log and in the final table of the main Health Check Report. Not all listed errors necessarily indicate a problem, as they could be the result of inadequate permissions or unavailable utilities.

The Health Check report is a ZIP file that includes:

Main report and analysis
Output from various operating system and Signiant commands
Operating system and Signiant configuration files
Signiant logs
List of trusted Certificate Authorities
List of Agents known to the Manager and their attributes
List of license keys and license descriptions
Scheduler job start analysis
Manager and Agent GMT time
The job status of maintenance, certificate, and backup job details
List of Agent tunnels
List of scheduled jobs

Creating a Health Check Job

To create a Health Check job:

In your Manager, navigate to Administration > Alarms > Health Check.
Click Add.
Configure settings on the Basic and Advanced tabs.

Notification

Specify whether the Health Check Report should be emailed as an attachment.

If Email Report is set to Yes:

Choose whether to email the report to Signiant technical support.
Enter Email To and Email Cc recipients. For multiple, addresses should be separated by semi-colons.

Note: If no email addresses are entered in Email To and the report is not being sent to Signiant, Cc email addresses are used as the Email To email addresses.

Report

Choose to write the Health Check report to a log folder or a supplementary folder on the Signiant Manager. If the report is being written to a supplementary folder, specify the path to the folder. Enter the Health Check report file name. By default this name is HealthCheck.%mgrshort%.%deforg%.%todaydate%.%todaytimefn%.zip. Specific keywords are supported in the Report Filename field.

Job Schedule

Job schedule settings can be found on both the Basic and Advanced tabs.

Select the Frequency, Start Date/Time, Time Zone, Priority, and Finish Before settings. The Finish Before option refers to the date and time before which you want the report to complete.

Configuration Options

Specifies the information returned in the Health Check Report. By default all of the options are set to Yes:

Server Configuration: Details on your operating system, hardware, CPU, and domain
Manager Configuration: The version, platform, installation folder, and default organization of your Manager
Manager Ecosystem: The number of Agents you have installed, how these Agents are configured, and job group details
Manager Processes: The top 20 processes based on CPU usage and memory usage
Manager Alarms: Lists any alarms that have been triggered, including the category, severity, date, and a description of the alarm
JVM Memory Statistics: Monitors the JVM memory status/usage to determine memory requirements
Tunnel List: All Agent tunnel details
Resource Control List: The status of your resource controls and details including the name, type, scope, concurrency, and ceiling
Media Exchange: Lists users in groups that are not Media Exchange enabled
Job Details: Details on the jobs running, including those associated with backups, maintenance, certificates and Health Check
Log Analysis: Details on the schedule log, JBoss log, and the rules server log.
Database Analysis: Information about your database, including the number of pages, the size, version, and top space consumers
Attachments: Details about the file path, size, and attachment status

In Include Agents In Manager Report, choose the Agents to include in the Health Check report. By default, Local is enabled. If you enable Specified, select Agents from the list.

Job Options

Specifies the use of the UDP Control Channel instead of TCP. This option should be used for firewall traversal when the TCP port cannot be opened. When Use UDP Control Channel is set to Yes, file transfers automatically use UDP WAN acceleration, which may override the Use WAN Accelerator setting.

Note: UDP versus TCP communication for Agent administration is controlled separately as part of Agent configuration.

Select the Log Detail Level. The default is Info. The level of log information increases in detail from Error(default) to Debug. Increasing the log level can negatively impact performance.

Advanced

Specifies the Maximum File Size that can be included in the ZIP file. If the job log exceeds this size, the errors are extracted and attached. Otherwise, the last portion of the log, up to this limit, is attached.

You can enter a custom Email Subject line for notifications. The default value is: Signiant Manager Health Check for %mgr% (%deforg%). Specific keywords are supported in the Email Subject field.

Use the Email From Name to override the specified Manager Email From name. The default value is the SCHDSVR_SUPPORT_TITLE parameterin the signiant.ini file. The signiant.ini file is located in /usr/signiant/dds/web/signiant.ini(Linux) and <Install_Directory>\web\signiant.ini(Windows).

Use the Email From Address to override the specified Manager Email From address. The default value is SCHDSVR_SUPPORT_EMAILADDRparameter in the signiant.ini file. The signiant.ini file is located in /usr/signiant/dds/web/signiant.ini(Linux) and <Install_Directory>\web\signiant.ini(Windows).

Keywords

The following Keywords can be used in Report Filename and Email Subject:

Keyword	Example	Description
%mgr%	server.example.com	Manager FQDN
%mgrshort%	server	First port of the Manager FQDN
%deforg%	Signiant	Default organization
%todaydttm%	2014-01-14 21:05:57	Current date and time
%todaydttmtz%	2014-01-14 21:05:57 EST	Current date and time with time zone
%todaydate%	2014-01-14	Current date
%todaytime%	21:05:57	Current time
%todaytimefn%	21-05-57	Current time in a filename compatible format

Running a Health Check Job

To run a Health Check job:

In your Manager, navigate to Administration > Alarms > Health Check.
In the toolbar, click Run.

Depending on the notification and report options chosen, the Health Check report will be emailed to designated recipients and/or written to a folder on the Manager.