The health check endpoint in R2R provides a quick and easy way to verify the status of your R2R deployment. This guide will walk you through how to use this endpoint, interpret its results, and integrate it into your monitoring systems.
The health check endpoint is a specific URL that, when accessed, returns information about the current state of the R2R system. It typically checks various components and dependencies to ensure everything is functioning correctly.
The health check endpoint is usually available at /v2/health
. Here are different ways to access it:
You can use cURL to make a GET request to the health check endpoint:
If your R2R instance is accessible via a web browser, you can simply navigate to:
Replace localhost:7272
with the appropriate host and port if your setup is different.
R2R provides a CLI command to check the health of the system:
If you’re using the R2R Python client:
The health check endpoint typically returns a JSON response. Here’s an example of what it might look like:
Key elements to look for:
status
: Should be “healthy” if everything is okay.version
: Indicates the current version of R2R.components
: Shows the status of individual components.timestamp
: When the health check was performed.If the health check returns a non-healthy status, here are some common issues and how to address them:
If the database component shows as unhealthy:
For vector store issues:
If the LLM service is unhealthy:
To ensure continuous monitoring of your R2R deployment:
If you’re using Prometheus for monitoring:
If deploying R2R in Kubernetes, use the health check as a liveness probe:
For AWS deployments:
R2R allows for customization of the health check endpoint. You can add custom checks or modify existing ones by editing the health check configuration. Refer to the R2R documentation for detailed instructions on how to customize health checks for your specific deployment needs.
The health check endpoint is a crucial tool for maintaining the reliability and performance of your R2R deployment. By regularly utilizing this endpoint and integrating it into your monitoring systems, you can ensure quick detection and resolution of any issues that may arise in your R2R system.
For more detailed information on R2R’s features and advanced configurations, refer to the official R2R documentation or join the R2R Discord community for support and discussions.
The health check endpoint in R2R provides a quick and easy way to verify the status of your R2R deployment. This guide will walk you through how to use this endpoint, interpret its results, and integrate it into your monitoring systems.
The health check endpoint is a specific URL that, when accessed, returns information about the current state of the R2R system. It typically checks various components and dependencies to ensure everything is functioning correctly.
The health check endpoint is usually available at /v2/health
. Here are different ways to access it:
You can use cURL to make a GET request to the health check endpoint:
If your R2R instance is accessible via a web browser, you can simply navigate to:
Replace localhost:7272
with the appropriate host and port if your setup is different.
R2R provides a CLI command to check the health of the system:
If you’re using the R2R Python client:
The health check endpoint typically returns a JSON response. Here’s an example of what it might look like:
Key elements to look for:
status
: Should be “healthy” if everything is okay.version
: Indicates the current version of R2R.components
: Shows the status of individual components.timestamp
: When the health check was performed.If the health check returns a non-healthy status, here are some common issues and how to address them:
If the database component shows as unhealthy:
For vector store issues:
If the LLM service is unhealthy:
To ensure continuous monitoring of your R2R deployment:
If you’re using Prometheus for monitoring:
If deploying R2R in Kubernetes, use the health check as a liveness probe:
For AWS deployments:
R2R allows for customization of the health check endpoint. You can add custom checks or modify existing ones by editing the health check configuration. Refer to the R2R documentation for detailed instructions on how to customize health checks for your specific deployment needs.
The health check endpoint is a crucial tool for maintaining the reliability and performance of your R2R deployment. By regularly utilizing this endpoint and integrating it into your monitoring systems, you can ensure quick detection and resolution of any issues that may arise in your R2R system.
For more detailed information on R2R’s features and advanced configurations, refer to the official R2R documentation or join the R2R Discord community for support and discussions.