--- title: Performing health checks on the PingIntelligence Dashboard description: Use the following commands to check the health status of the PingIntelligence Dashboard and its components: component: pingintelligence version: 5.2 page_id: pingintelligence:installing_pingintelligence_for_apis:pingintelligence_health_check_dashboard canonical_url: https://docs.pingidentity.com/pingintelligence/5.2/installing_pingintelligence_for_apis/pingintelligence_health_check_dashboard.html revdate: May 6, 2024 section_ids: about-this-task: About this task steps: Steps --- # 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: ```shell $ ./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: ```shell $ 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: ```shell $ 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\://*\*:*\*/status * The curl command: ```shell $ curl -k -o /dev/null -s -w "%{http_code}\n" https://: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: ```shell $ ./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: ```shell $ 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: ```shell $ 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: 1. 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. 1. If you are making the change on a running instance, restart Elasticsearch. 2. After updating the `elasticsearch.yaml`, to check the status of Elasticsearch, go to https\://*\*:9200/. | | | | - | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | | You can use a browser or the following curl command:+```shell $ curl -k -o /dev/null -s -w "%{http_code}\n" https://:9200/ ``` | A `200 OK` response indicates a running Elasticsearch. * Using a health check user: | | | | - | -------------------------------------------------------- | | | This approach does not require an Elasticsearch restart. | 1. To add a health check user to Elasticsearch, run the following command: ```shell curl -u elastic: -k -X POST "https://localhost:9200/_xpack/security/user/?pretty" -H 'Content-Type: application/json' -d' { "password" : "", "roles": ["monitoring_user"] } ' ``` 2. After adding the health check user, to check the status of Elasticsearch, go to https\://*\*:*\*@*\*:9200/. | | | | - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | You can use a browser or the following curl command:+```shell $ curl -k -o /dev/null -s -w "%{http_code}\n" https://:@: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: ```shell $ curl -XGET -k -H 'content-type: application/json; charset=UTF-8' -u "elastic:" 'https://:9200/_cluster/health?pretty' ``` 1. To check the health status of Elasticsearch when it is running as a `systemctl` service, run the following command: ```shell $ systemctl status pi-elasticsearch.service ``` 2. To check the Elasticsearch log for errors or exceptions, verify the Elasticsearch log for any exceptions or errors by running the following command: ```shell $ tail logs/elasticsearch.log ``` * To check the health status of Kibana: 1. 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\://*\*:5601/pi/ui/dataengine/api/status. | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | You can use a browser or the following curl command:+```shell $ curl -k -o /dev/null -s -w "%{http_code}\n" https://:5601/pi/ui/dataengine/api/status ``` | A `200 OK` response indicates a running Kibana instance. * Using health check user: 1. To add a health check user to Kibana, run the following command: ```shell curl -u elastic: -k -X POST "https://localhost:9200/_xpack/security/user/?pretty" -H 'Content-Type: application/json' -d' { "password" : "", "roles": ["monitoring_user"] } ' ``` 2. After adding the health check user, to check the status of Kibana, go to https\://*\*:*\*@*\*:5601/pi/ui/dataengine/api/status. | | | | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | You can use a browser or the following curl command:+```shell $ curl -k -o /dev/null -s -w "%{http_code}\n"https://:@:5601/pi/ui/dataengine/api/status ``` | A `200 OK` response indicates a running Kibana. 1. 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: ```shell $ systemctl status pi-kibana.service ``` 2. To check Kibana log for errors or exceptions, verify the Kibana log for any exceptions or errors by running the following command: ```shell $ tail logs/kibana.log ```