Broadleaf Microservices
  • v1.0.0-latest-prod

Debugging Tips

Search Request Parameters

Additional parameters on the search request can be added to make debugging the search request to Solr easier. It’s recommended to use Postman or the OpenAPI docs to add these additional parameters for testing.

debug parameter

If the debug parameter is passed in with "true", then the response contains a JSON string with all the data returned from Solr, including the queryUrl string. That queryUrl string can be pasted in the Solr admin query console in the Raw Query Parameters field and on Execute Query will be parsed into the appropriate fields in Solr. Note, the q field in Solr has a default *:* value which may need to be removed before pasting the queryUrl since it may not be cleared when the raw params are parsed.

Important
Do note that the debug parameter is not efficient and is not intended for production. Calls made with this parameter should be reserved for debugging purposes only.

showScores parameter

Tip
Since 2.2.0

If the showScores parameter is passed in, the "score" string will be added to the Field List (fl param) in the Solr Query. This means that on the query response, the score of each document will be returned as a field. This can be helpful when evaluating boosts for a particular query and understanding the scored results, especially when debugging Field Queries or Relevancy Rules