Performing health checks on the PingIntelligence Dashboard

About this task

Use the following commands to check the health status of the PingIntelligence Dashboard and its components:

Steps

To check the health status of the Dashboard data engine:
1. Run the status command to check the status of the Dashboard process:
  $ ./bin/cli.sh status
It returns the status as Running or Not Running.
1. If the Dashboard data engine is running as a systemctl service, use the following command to check the status of the service:
  $ systemctl status pi-data-engine
2. To check the Dashboard log file for errors or exceptions, verify the /pingidentity/dataengine/logs/admin/dataengine.log file to detect connectivity issues between the Dashboard data engine and ABS or Elasticsearch:
  $ tail logs/admin/dataengine.log
To check the health status of the WebGUI:
1. To check if the WebGUI component is running, use the following health check URL in a browser or the curl command.
  
  Choose from:
  - The browser URL: https://<WebGUI Hostname/IP>:<port>/status
  - The curl command:
    
    $ curl -k -o /dev/null -s -w "%{http_code}\n" https://<webgui>:8030/status 200
A 200 OK response results if the component is running.
1. To show the status of the WebGUI process, run the status command:
  $ ./bin/cli.sh status
2. If the WebGUI is running as a systemctl service, use the following command to check the status of the service:
  $ systemctl status pi-webgui.service
3. To check the WebGUI admin log file for errors or exceptions, verify the/pingidentity/webgui/admin/logs/ admin.log file to detect the connectivity issues between WebGUI and ABS or Elasticsearch:
  $ tail logs/admin/admin.log
To check the health status of Elasticsearch:
1. To check the health status of Elasticsearch using a health check URL:
  
  Choose from:
  - Using anonymous access:
    
    To enable access for anonymous user, add the following line to the elasticsearch.yaml:
    
    xpack.security.authc.anonymous.roles: monitoring_user
    
    You can update this during initial setup or later.
    
    If you are making the change on a running instance, restart Elasticsearch.
    
    After updating the elasticsearch.yaml, to check the status of Elasticsearch, go to https://<Elasticsearch Hostname/IP>:9200/.
    
    You can use a browser or the following curl command:
    
    +
    
    $ curl -k -o /dev/null -s -w "%{http_code}\n" https://<Elasticsearch Hostname/IP>:9200/
  A 200 OK response indicates a running Elasticsearch.
  - Using a health check user:
    
    This approach does not require an Elasticsearch restart.
    
    To add a health check user to Elasticsearch, run the following command:
    
    curl -u elastic:<elastic user password> -k -X POST "https://localhost:9200/_xpack/security/user/<health_check_user>?pretty" -H 'Content-Type: application/json' -d' { "password" : "<password for health_check_user>", "roles": ["monitoring_user"] } '
    
    After adding the health check user, to check the status of Elasticsearch, go to https://<health_check_user>:<password>@<Elastcisearch hostname/IP>:9200/.
    
    You can use a browser or the following curl command:
    
    +
    
    $ curl -k -o /dev/null -s -w "%{http_code}\n" https://<health_check_user>:<password>@<Elastcisearch hostname/IP>:9200/
A 200 OK response indicates a running Elasticsearch.
- Using Elasticsearch username and password:
  - To query the health status of Elasticsearch using the elastic user and its password to see a more comprehensive output, which also reports the state of the cluster, run the following curl command:
    
    $ curl -XGET -k -H 'content-type: application/json; charset=UTF-8' -u "elastic:<password>" 'https://<elasticsearch hostname/IP>:9200/_cluster/health?pretty'
    
    To check the health status of Elasticsearch when it is running as a systemctl service, run the following command:
    
    $ systemctl status pi-elasticsearch.service
    
    To check the Elasticsearch log for errors or exceptions, verify the Elasticsearch log for any exceptions or errors by running the following command:
    
    $ tail logs/elasticsearch.log

To check the health status of Kibana:

To check the health status of Kibana using a health check URL:

Choose from:

Using anonymous access:
1. To enable access, add the following line to the kibana.yaml:
  status.allowAnonymous: true
You can update this during initial setup or later.
1. If you are making the change on a running instance, restart Kibana.
2. After updating the kibana.yaml, to check the status, go to https://<Kibana Hostname/IP>:5601/pi/ui/dataengine/api/status.
  You can use a browser or the following curl command:
  
  +
  
  $ curl -k -o /dev/null -s -w "%{http_code}\n" https://<Kibana Hostname/IP>:5601/pi/ui/dataengine/api/status

A 200 OK response indicates a running Kibana instance.

Using health check user:

To add a health check user to Kibana, run the following command:

curl -u elastic:<elastic user password>  -k -X POST "https://localhost:9200/_xpack/security/user/<health_check_user>?pretty" -H 'Content-Type: application/json' -d'
{
  "password" : "<password for health_check_user>",
  "roles": ["monitoring_user"]
}
'

After adding the health check user, to check the status of Kibana, go to https://<health_check_user>:<password>@<Kibana hostname/IP>:5601/pi/ui/dataengine/api/status.

You can use a browser or the following curl command:

$ curl -k -o /dev/null -s -w "%{http_code}\n"https://<health_check_user>:<password>@<Kibana hostname/IP>:5601/pi/ui/dataengine/api/status

A 200 OK response indicates a running Kibana.

To check the health status of Kibana when it is running as a systemctl service, run the following command to check the status of the service:
```
$ systemctl status pi-kibana.service
```
To check Kibana log for errors or exceptions, verify the Kibana log for any exceptions or errors by running the following command:
```
$ tail logs/kibana.log
```