Health Check Dashboard provides a view of the health of selected Environments. Click an Environment to see the health of the Environment over the past 24 hours and any associated TECRs and TEBRs.
Any health status recorded in Plutora will only be valid for a 24-hour period. If no updates are received within a 24-hour period, the current status will default back to No Data.
- Include Test Name, Health Check Status, and an Error Log (as a text file attachment) for Environments via Plutora’s API and view them on the Health Check Dashboard:
- POST /environmentHealthCheck
- View Environment Health Check data using:
- POST /environmentHealthCheck/FullHistory
- POST /environmentHealthCheck/CurrentStatus
- Health Check Dashboard also has a new health status: Issue.
- Health check statuses can be added to an Environment via the API so it is no longer necessary to use test scripts.
Set Up Health Check Dashboard
1. Environment Setup Customization
To enable the Health Check Dashboard:
- Go to Settings > Customization > Environments.
- Click Environment Setup.
- Click to select Enable Health Check checkbox.
- Click Submit.
The yellow Your changes have been saved pop up opens and closes.
If you click away from the Customization page without clicking Submit, your changes will not save.
If Enable Health Check is disabled, all configured Environment scripts will have their schedule turned off so that they no longer run in the background.
2. Configure Environments
Health Check Test Script Template
Use the template below for Health Check scripts.
Insert your test script inside the Promise between the following statements:
console.log('Beginning EnvironmentCheck test'); //Insert test script here console.log('Completed EnvironmentCheck test');
In order for your test result to be recorded in the Health Check Dashboard, you must resolve the Promise with a boolean True or False:
- resolve(‘Online’); Sets the environment health status to ‘Online’
- resolve(‘Offline’); Sets the environment health status to ‘Offline’
*NEW* resolve(‘Issue’); Sets the environment health status to ‘Issue’
- resolve(‘Unknown’); Sets the environment health status to ‘Unknown’
If your script triggers the Reject path, either intentionally or through an uncaught throw, this will result in a status of “UNKNOWN” as the outcome of the test cannot be confirmed if the script fails to execute:
- reject(true) = the status of your environment is ‘Unknown’
The following test scripts have been created to illustrate how to insert your test script into the template and return a test result successfully.
Test Plutora SSO Login using Selenium
Test Plutora’s API using JS
Health Check Dashboard uses NodeJS Selenium NPM. All scripts must reference, spin up, and exit Chrome Driver, which contains a subset of Selenium functions.
- let driver = chromeDriver.driver;
Only the following objects from the Selenium Webdriver have been whitelisted:
Trigger Tests Remotely
If you have an existing suite of automated tests that you wish to use instead of developing new test scripts, you can modify the template to connect to the server where these tests are hosted and trigger them remotely, or trigger the execution of these test scripts through tools like Jenkins.
Update Environment Health Check Status via External APIs
If you wish to host and execute your test scripts outside of Plutora, you can modify your scripts to update the Health Check dashboard at the end of each execution using our external APIs.
Manage Health Check Dashboard
To manage Health Check Dashboard:
- Go to Environment > Health Check Dashboard.
If Health Check Dashboard does not appear under the Environment menu, enable it in Environment Setup.
Health Check Dashboard displays nothing when first opened but remembers the previously selected filter from then on.
- Click Select Filter. Available filters are:
- Environments: Select the Environments to display one by one.
- Environment Groups:
- Display all the Environments in the selected Environment Groups.
- Environment Groups are listed in the left-hand column and their Environments are visible in the same row.
- Display all the Environments in the selected Systems.
- Systems are listed in the left-hand column and their Environments are visible in the same row.
- Type the search text.
- Press the Enter key on your keyboard.
- The selected Environments display.
- The colors mean:
- Light gray: No data to display. The Environment has not been configured or the configured script has not yet run.
- Dark gray: The script has run and failed. Check and rerun the script to get the status.
- Green: The script has run and the Health Check has passed.
- If no status updates have been recorded for the last 24 hours, the current status will default to No Data.
*NEW* Amber: The script has run and the Environment has an issue.
- Red: The script has run and the Health Check has failed.
- Click an Environment to open the Environment health check details for the last 24 hours pop up.
The timeline will backfill the most recently recorded status until the previous update, or for the prior 24 hour period if no updates exist for that period.
- Click to open the blue-linked TECRs and TEBRs.
If the Environment is down, the dates of on the TECRs and TEBRs may give a clue to what brought it down.
- The Environment Health Check History pop up opens.
*NEW* Log files can now be added via the API.
- The 24-hour history will show a detailed view of all status updates for the past 24 hours. If no updates have been received within a 24-hour period then nothing will be displayed.
- Click View to open a log file in a browser tab.