shclusterready

## Introduction This applications purpose is to provide a REST endpoint that can be used by a load balancer to check the search head status The status is based on the response to the REST endpoint: ```/services/shcluster/member/info``` ## How do I use this application? You can hit the endpoint via curl, for example ```curl -k https://localhost:8089/services/searchheadstatus``` And this will return the response based on the internal REST call, such as "Up", or "ManualDetention" ## Are there alternatives? As of Splunk 9.1.x, a new endpoint exists: ```/shcluster/member/ready``` You can use this via: ```curl -k https://localhost:8089/services/shcluster/member/ready``` or on the web port via: ```curl -k http://localhost:8000/en-GB/splunkd/__raw/services/searchheadstatus``` This is not documented as of the 2024-04-16 but may be documented in the future, it returns an XML response such as: ``` shclusterready https://localhost:8089/services/shcluster/member/ready 2024-04-13T15:50:05+10:00 Splunk 0 30 0 ``` Or when the SHC member is in detention: ``` Search Head is in detention ``` This application was developed because such an endpoint didn't exist prior to 9.1.x ## Feedback? Feel free to open an issue on github or use the contact author on the SplunkBase link and I will try to get back to you when possible, thanks! ## Other Thanks to Harshil Marvania (harsmarvania57) for bringing the new endpoint to my attention. Icons by Bing CoPilot ## Release Notes ### 0.0.1 Initial version

SearchHeadStatus