SearchBlox

SearchBlox Developer Documentation

Welcome to the SearchBlox developer documentation. Here you will find comprehensive technical documentation to help you start working with SearchBlox as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides

Monitoring

URLs to Monitor in SearchBlox

SearchBlox can be monitored by the system administrators by checking the following endpoints.

1. Admin Access Endpoint:

http://exampledomain:port/searchblox/admin/main.jsp
Default: http://localhost/searchblox/admin/main.jsp

The page should load successfully and return HTTP status code 200.
If the page is not accessible, SearchBlox service may not be running and may require a start/restart.

2. Search Access Endpoint:

http://exampledomain:port/searchblox/plugin/index.html
Default: http://localhost/searchblox/plugin/index.html

The page should load successfully and return HTTP status code 200.
If the page is not accessible, SearchBlox service may not be running and may require a start/restart.

3. Elasticsearch Access Endpoint:

https://IP_Address:9200/_cat/indices
Default: https://localhost:9200/_cat/indices

Please check if the page load is successful and whether you are able to view all the indices.

The page should load successfully and return HTTP status code 200.
If the page is not accessible, Elasticsearch service may not be running and may require a start/restart.

If Elasticsearch service is accessible, please check the status of indexes.

  • Please check the color and status of all the indices.
  • Color of index is red
    If the color of any of the index is red, then please try restarting SearchBlox. If it does not help, please delete the respective index using curl command or using API console request in Kibana(refer help link below)
  • Status of the index is closed
    If the status of any of the index is closed, then please try to open the index using a curl command or API console in Kibana (refer help link below). If it does not help, please try restarting, if the index does not open even on a restart, then please delete the respective index using curl command or using API console request in Kibana.
  • Please refer the following links:
    status-of-indices-red-or-closed
    deleting-elasticsearch-indices

4. Search servlet endpoint

http://exampledomain:port/searchblox/searchblox/rest/v2/api/search?query=*
example: http://localhost:8080/searchblox/rest/v2/api/search?query=*

The page should load successfully and return HTTP status code 200.
If the page is not accessible, SearchBlox service may not be running and may require a start/restart.

Updated about a month ago



Monitoring


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.