IDM Health Monitor Test

This test monitors the overall health of the target VMware Horizon Identity Manager and also the health of its integrated components. Using this test, administrators can easily isolate unhealthy services and can initiate troubleshooting measures for those services at the earliest!

Note:

By default, the REST API output obtained upon execution of this test may not expose a few metrics such as IP Address, Database status etc. To this effect a few metrics may report "Unknown" as the measure value for this test. In order to pull out all the metrics relevant to this test, you should set the service.health.check.basic property in the runtime-config.properties file available in the /usr/local/horizon/conf directory to false.

Target of the test : A VMware Horizon Identity Manager

Agent deploying the test: A remote agent

Outputs of the test : One set of results for the target server being monitored.

Configurable parameters for the test
Parameters Description

Test Period

This indicates how often should the test be executed.

Host

The host for which the test is to be configured.

Port

Refers to the port used by the VMware Identity Manager.

Published URL

Specify the URL of the target VMware Identity Manager being accessed. You can provide an HTTP or an HTTPS URL here. Ensure that you provide a fully-qualified domain name of the target VMware Identity Manager here. For example, the URL can be: https://eg-idm.com

Client ID, Client Password and Confirm Password

The eG agent communicates with the target VMware Horizon Identity Manager using REST API. To collect the required metrics, the eG agent requires an Access token in the form of a Client ID and the Shared Secret value of that client. To know more about creating the Client ID and the shared secret of the Client ID, refer to Configuring the eG Agent to Monitor the VMware Horizon Identity Manager. Specify the created Client ID in the Client ID text box and the Shared Secret in the Client Password text box. Confirm the Client Password by retyping it in the Confirm Password text box.

SSL

By default, the VMware Horizon Identity Manager is SSL-enabled. Accordingly, the SSL parameter is set to true by default. This indicates that the eG agent will communicate with the VMware Horizon Identity Manager via HTTPS by default.

DD Frequency

Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD frequency.

Detailed Diagnosis

To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option.

The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

  • The eG manager license should allow the detailed diagnosis capability
  • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measurements made by the test
Measurement Description Measurement Unit Interpretation

Overall status

Indicates the overall health of the VMware Horizon Identity Manager service.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
True 1
False 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate the overall status of the VMware Horizon identity Manager services. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1.

The detailed diagnosis of this measure lists the Analytics URL, host name of the VMware Horizon Identity Manager, Elasticsearch master node, version of encryption service, whether encryption service is verified, name of encryption service, Build version, Cluster ID, Elasticsearch node, status period, service version, audit queue threshold and IP address.

Elastic search service status

Indicates the current status of the ElasticSearch service.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
True 1
False 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate the current status of the ElasticSearch service. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1.

Audit disabled

Indicates whether/not audit logging is disabled.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
True 1
False 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate whether/not audit logging is disabled. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1.

Audit poll interval

Indicates the time interval between subsequent polling in audit logs.

Milliseconds

 

Audit worker thread alive

Indicates whether/not worker thread of the audit log is alive.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
True 1
False 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate whether/not worker thread of the audit log is alive. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1.

Analytics connection status

Indicates whether/not the Analytics connection service is OK.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
True 1
False 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate the Analytics connection service is OK. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1.

Database status

Indicates the current status of the database connection.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
Connection successful 1
Connection unsuccessful 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate the current status of the database connection. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1.

Federation broker

Indicates the current status of the federation broker.

Number

 

Encryption connection

Indicates the current number of sessions that are initializing.

Number

A high value for this measure could indicate that many sessions are currently experiencing initialization problems.

Database connection

Indicates whether/not the database connection service is OK.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
True 1
False 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate whether/not the database connection service is OK. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1.

Elastic search health

Indicates the current status of the Elasticsearch cluster health.

 

Elasticsearch is an open source search and analytics solution used within VMware Workspace ONE Access.

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
Green 1
Yellow 2

Red

3

Note:

By default, this measure reports the Measure Values listed in the table above to indicate the current status of the Elasticsearch cluster health. The graph of this measure however, is represented using the numeric equivalents only i.e., 1 to 3.

Clock sync

Indicates whethe/not the clock sync status is OK.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
True 1
False 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate whether/not the clock sync status is OK. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1.

Maintenance mode

Indicates whethe/not the maintenance mode is ON.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
True 1
False 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate whether/not the maintenance mode is ON. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1.

Messaging connection

Indicates whether/not the connection to the RabbitMQ message server is OK.

 

RabbitMQ cluster services can fail due to communications issue or services stopping or background jobs/threads terminating.

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure value Numeric Value
True 1
False 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate whether/not the connection to the RabbitMQ message server is OK. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1.