---
title: gRPC Health
description: Monitor gRPC servers based on gRPC Health Checking Protocol
breadcrumbs: Docs > Integrations > gRPC Health
---

# gRPC Health
Supported OS Integration version1.1.0
## Overview{% #overview %}

This check monitors endpoints implementing [gRPC Health Checking Protocol](https://github.com/grpc/grpc/blob/master/doc/health-checking.md) through the Datadog Agent.

## Setup{% #setup %}

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates](https://docs.datadoghq.com/agent/kubernetes/integrations.md) for guidance on applying these instructions.

### Installation{% #installation %}

#### Host{% #host %}

To install the grpc_check check on your host:

```bash
sudo -u dd-agent datadog-agent integration install -t datadog-grpc-check==1.1.0
```

#### Dockerfile{% #dockerfile %}

Build the Agent image with this Dockerfile.

```Dockerfile
FROM datadog/agent:7
RUN agent integration install -r -t datadog-grpc-check==1.0.2 \
  && /opt/datadog-agent/embedded/bin/pip3 install grpcio grpcio-health-checking
```

### Configuration{% #configuration %}

1. Edit the `grpc_check.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your grpc_check performance data. See the [sample grpc_check.d/conf.yaml](https://github.com/DataDog/integrations-extras/blob/master/grpc_check/datadog_checks/grpc_check/data/conf.yaml.example) for all available configuration options.

1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent).

### Validation{% #validation %}

[Run the Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#agent-status-and-information) and look for `grpc_check` under the Checks section.

## Data Collected{% #data-collected %}

### Metrics{% #metrics %}

|  |
|  |
| **grpc\_check.healthy**(gauge)   | Whether the grpc server is healthy, 1 if true, 0 otherwise.   |
| **grpc\_check.unhealthy**(gauge) | Whether the grpc server is unhealthy, 1 if true, 0 otherwise. |

### Events{% #events %}

The grpc_check integration does not include any events.

### Service Checks{% #service-checks %}

The grpc_check integration does not include any service checks.

**grpc.healthy**

Returns CRITICAL if the gRPC server is unhealthy. Returns OK if the gRPC server is healthy.

*Statuses: ok, critical*

## Troubleshooting{% #troubleshooting %}

Need help? Contact [Datadog support](https://app.datadoghq.com/help@datadoghq.com).