Configure application health check on the VM

Written by

To make the application more available and make sure that it responds to requests, you can set up the application health check on the instance. Instance Groups will check and automatically recover the instance if it fails the check. Don't confuse this with the health check in the network load balancer. Read more about automatic recovery and types of checks.

This section describes how to set up application health check for an existing group.

Management console

CLI

Open the folder page in the management console.
Select Yandex Compute Cloud.
On the Virtual machines page, go to the Instance groups tab.
Select the group to update.
In the Health checks section, enable the Activate option to the right.
Select the protocol for the health checks: HTTP or TCP.
Set up the health checks:
- The port in the range 1-32767 to receive the check requests from Instance Groups.
- Path (for HTTP) — The URL path for the HTTP check requests sent from Instance Groups.
  
  Alert
  
  Only HTTP/1.1 and lower are supported.
- The response timeout in seconds.
  
  If you connected your instance group to a network load balancer, we recommend setting a smaller value here than in the load balancer.
- Check interval in seconds — This is the interval for Instance Groups to wait between health checks.
- Performance threshold — The number of successful health checks required for the managed instance to be considered healthy.
  
  If you have connected your instance group to a network load balancer, we recommend that you set a smaller value here than in the load balancer.
- Failure threshold — The number of failed health checks for the managed instance to be considered unhealthy.
  
  If you have connected your instance group to a network load balancer, we recommend that you set a higher value here than in the load balancer.
Click Save changes.

If you don't have the Yandex.Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

View a description of the update group command in the CLI:
```
$ yc compute instance-group update --help
```

Get a list of instance groups in the default folder:

yc compute instance-group list
+----------------------+-----------------------+------+
|          ID          |         NAME          | SIZE |
+----------------------+-----------------------+------+
| amc65sbgfqeqf00m02sc | first-instance-group  |    2 |
+----------------------+-----------------------+------+

Select the group ID or NAME (for example, first-instance-group).
Get information about the instance group.
Create a YAML file with any name (for example, group.yaml) and, based on the information received, describe:
- The template of the instance.
- The policies.
- The service account ID.
- The network load balancer specifications (if necessary).

Add a health check specification to the file (for example, for HTTP checks):

...
health_checks_spec:
  health_check_specs:
    - http_options:
        port: 80
        path: /
      interval: 30s
      timeout: 10s
      unhealthy_threshold: 5
      healthy_threshold: 3
...

Where:

Key	Value
`health_check_specs`	Health check specs.
`http_options`	Settings for HTTP health checks. Only HTTP/1.1 and lower are supported. If you want to use TCP, then in the `tcp_options` property specify the port number only.
`port`	The port in the range 1-32767 to receive the check requests from Instance Groups.
`path`	The URL path for the HTTP health check requests sent from Instance Groups.
`interval`	Check interval in seconds — This is the interval for Instance Groups to wait between health checks.
`timeout`	Response waiting time in seconds. If you connected your instance group to a network load balancer, we recommend setting a larger value here than in the load balancer.
`unhealthy_threshold`	Unhealthy threshold — The number of failed health checks after which the instance is considered inoperable. If you have connected your instance group to a network load balancer, we recommend that you set a higher value here than in the load balancer.
`healthy_threshold`	Healthy threshold — The number of successful health checks after which the instance is considered operable. If you have connected your instance group to a network load balancer, we recommend that you set a smaller value here than in the load balancer.

Update the instance group in the default folder:
```
$ yc compute instance-group update --name first-group --file group.yaml
```
Instance Groups starts the operation to update the instance group.

Configure application health check on the VM

Was the article helpful?