Solr Health Check

Solr Health Check

This module provides an endpoint to check the health of all Solr cores associated with a Drupal site. It is designed to help site administrators and developers quickly verify the status and performance of their Solr search server.

Features

• Checks the health status of all Solr cores configured with Search API.
• Returns a summary status report for each Solr core, including response time and error messages if any.
• Excludes the health check endpoint from all caches to ensure real-time data.

Installation

1. Download and extract the module to your modules/contrib directory or install via Composer: composer require drupal/solr_health_check.
2. Enable the module on the Extend page or via Drush: drush en solr_health_check.

Usage

Once enabled, access the health check endpoint at /solr-health-check to view the status of all Solr cores.

Example Output

{
  "default_solr_content_index": {
    "status": "up",
    "response_time": 0.034
  },
  "another_solr_index": {
    "status": "down",
    "message": "Solr responded but with an error status.",
    "error_status": 500,
    "error_message": "Internal Server Error"
  }
}

Credits

Developed by Max from Demonz Media.

Support

For issues, feature requests, and general support, please visit the issue queue.