Azure Health Check (Enterprise Only)

Available in PagerDuty Runbook Automation Commercial products.

Overview

The Azure Health Check plugin checks the status of Azure VMs. If the host is running the plugin will return a "healthy" status.

Authentication

Follow the steps outlined in the Azure Plugins Overview to configure authentication for Azure Job steps.
Credentials can be configured on a per Job Step basis, Project basis, or for the entire Runbook Automation system.

Setup

1. Visit the Project Settings... > Edit Nodes page. Under the Configuration tab, check the "Health Checks Enabled" checkbox:
   • Alternately, in the project configuration properties file, add the configuration property:
     
     project.healthcheck.enabled=true
     
     The health check uses a cache to store the statuses and improve performance when requesting them. To automatically refresh the Health Checks, enable the "Refresh health status cache" and set the update period in the "Cache refresh period" field whose default value is 30 seconds.
     
     
2. Visit the sidebar link "Health Checks"
   
3. Click on the "Configure" Tab, and Add a Health Check Plugin.
4. Select Azure / HealthCheck Plugin from the list
5. Return to the Nodes Tab to see a list of nodes.
   • There may be a message saying "Unauthorized: cannot execute on node". If so, add an ACL Policy to allow the Health Check System to run commands and scripts on the target nodes. See Access Control.
     
     
     
6. Once Access Control is configured, the checks should be showing up and healthy:
   
   
   
7. Return to the "Project Settings... > Edit Nodes" page. Under "Enhancers" click "Add a new Node Enhancer" and choose "Health Status".
   
   
   
   Option to modify the settings, or keep the defaults. Make sure "UI Status Attributes" is added, to add UI indicators. Then click "Save" and "Save" again.
   
   
   
   
8. Visit the "Nodes" link in the Sidebar. There will be healthy status indicators for the nodes: