|
<< Click to Display Table of Contents >> Raynet One Data Hub > 2026.2 > Installation Guide > Data Hub Agent > Windows > Configuration Health Check Endpoint |
The Data Hub Agent exposes a lightweight HTTP health check endpoint that can be used to verify that the agent service is running. The endpoint is intended for use with container orchestration systems such as Kubernetes, which use liveness probes to automatically restart containers that have stopped responding.
When the agent is running, a GET /health request to the configured port returns HTTP 200 with the response body:
Agent service loop is live and running.
The health check listener runs independently of any job execution. It does not reflect the state of in-progress tasks — it confirms only that the agent service loop is active.
The port on which the health check endpoint listens is controlled by the HealthCheckPort setting. The default value is 9090.
Parameter |
Default Value |
Description |
|---|---|---|
HealthCheckPort |
9090 |
The TCP port on which the agent listens for health check requests. A GET /health request on this port returns HTTP 200 when the agent service loop is active. Each agent can be assigned an individual port value. |
For MSI-based installations, the HealthCheckPort value is set in the Raynet.RayVentory.DataHub.Agent.dll.config file, located in the agent installation folder (by default C:\Program Files (x86)\RayVentory\DataHubAgent).
Add or update the following entry in the <appSettings> section:
<add key="HealthCheckPort" value="9090"/> |
Restart the agent service after saving the file to apply the change.
For Docker-based deployments, the port is configured via the DataHubAgent_HealthCheckPort environment variable. The container must also expose the port to allow external probes to reach the endpoint.
Environment Variable |
Description and Sample Value |
DataHubAgent_HealthCheckPort |
Overrides the default health check port. When not set, the agent uses the default value of 9090.
Example value: 9090 |
The health check endpoint is designed to support Kubernetes liveness probes. When configured, Kubernetes periodically issues a GET /health request to the agent. If the agent does not respond, Kubernetes automatically restarts the container.
To configure a liveness probe in your Kubernetes deployment manifest, add a livenessProbe block targeting the health check port. The probe should be directed to the /health path on the port defined by HealthCheckPort (default: 9090).
The agent writes the following log messages related to the health check endpoint:
•When the listener starts successfully: Health check listener started on port {port}. GET /health returns 200 OK.
•When the agent shuts down: Health check listener shut down.
•If the listener cannot be started (for example, because the port is already in use): a warning is written to the log and the agent continues to run without the health check endpoint.