Part 3: vCOps Custom UI Series – Customizing the Health Status Widget
Part 3 of the series will go into detail about the Health Status widget, the use case for it, and details on how to configure the widget to your liking. (You can find additional posts regarding other widgets and more on this page.) The Health Status widget can be used, like heat maps, to quickly see the health status of many objects. However, the Health Status widget provides a “history” within the view so you can see where, if any, problems might have occurred. Like the Heat Map, and most other widgets, the Health Status widget will change colors based on values and be can modified to display a status history from just the last hour all the way to the last month (and many options in between). Below is an example of the Health Status widget followed by details on configuration.
1) Ensure you’re on the dashboard you want to add the Health Status on, click Edit under the Dashboard Tools options. Drag and drop the Health Status widget from the left column over to the right. Click Ok.
2) You should now have a blank, unconfigured Health Status widget on your dashboard. Look at it…..it’s blank….and it’s just begging to be configured and display your data. So….let’s put it to work. Click that Gear icon to Edit the widget.
3) Once inside the Edit ‘Health Status’ widget window, you can configure what data you need it to display. A few of the “important” settings are highlighted in the screenshot below but I’ll explain most of them here:
- Widget title: Title displayed on the widget within the Live Dashboard. (See first screenshot and look for Sharepoint – Health Status)
- Self Provider: Set to “ON” if the widget will reach out pull it’s own data without having to click on another widget first.
- Mode: Selects what resources to display. Self will display the selected resources in the Tags section below. Children will display child resources of your selection. Parents will display the parent resources of your selection. Also note that if you select Children or Parents, the selected resources themselves will not be displayed within the widget.
- Widget Refresh Interval: Time (in seconds) to automatically refresh the displayed data.
- Order By: Select how you’d like the resources to be sorted within the widget. Options include Name or Value. Use the radio buttons to indicate Ascending or Descending order.
- Pagination Number: Select how many displayed resources are shown within the widget before a page menu appears at the bottom of the live widget.
- Period Length: Select how much historical data you’d like to display within the widget. Options range from the last hour to the last month. The time frame is displayed on the live widget for quick reference. (see first screenshot – see “Last 24 Hours)
- Metric: Choose what type of data to display. You can simply use the Health metric or select from a wealth of preconfigured metrics in the drop-down list. *Note: If you select Custom you are given the option to configure the Yellow, Orange, and Red thresholds.
4) At the bottom of the Edit ‘Health Status’ widget configuration is the “Select which tags to filter” box. This is where you’ll select your resources to display. Simply click on each resource to include it in the widget. *Note: Clicking the resources is kind of like holding control and doing a multiple select. Clicking on the resource will highlight it and include it – click it again to deselect it.
5) After changing your preferences at the top and selecting your resources (or tags) at the bottom, click Ok to complete the configuration. The “Edit ‘Health Status’ widget” screenshot above displays all the configurations used that creates the live widget as shown below.
You should have now a completely configured Health Status widget displaying your data. If you selected the Health metric, the threshold colors are based on the “Global” settings rather than individual settings for this particular widget. Those can be modified under Admin –> Global Settings –> Health States – but remember that modifying this will affect more than just this individual widget.
A few other points of interest here on the Health Status widget:
- Details: To view details of a resource you can double click anywhere within that resources history or health badge.
- Groups: In the standard UI you can create groups of servers (ie web servers, database servers, Exchange, Sharepoint, etc) and select the group as a whole as a resource.