Overview
This check monitors endpoints implementing gRPC Health Checking Protocol through the Datadog Agent.
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 for guidance on applying these instructions.
Installation
Host
To install the grpc_check check on your host:
sudo -u dd-agent datadog-agent integration install -t datadog-grpc-check==1.0.2
Dockerfile
Build the Agent image with this 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
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 for all available configuration options.
Restart the Agent.
Validation
Run the Agent’s status subcommand and look for grpc_check under the Checks section.
Data Collected
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
The grpc_check integration does not include any events.
Service Checks
grpc.healthy
Returns CRITICAL if the gRPC server is unhealthy. Returns OK if the gRPC server is healthy.
Statuses: ok, critical
Troubleshooting
Need help? Contact Datadog support.
