Skip to content
Elasticsearch/Solr Sandbox for exploring explain information and tweaking
JavaScript HTML CSS Dockerfile Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
app
bin
test
.editorconfig
.gitattributes
.gitignore
.jshintrc
Dockerfile
Gruntfile.js
LICENSE.txt
README.md
docker-compose.yml
mockHelpers.js
package.json
yarn.lock

README.md

The Splainer!

Build Status

The sandbox that explains your search results for you so you don't have to go digging through explain debug! Paste in your Solr or Elasticsearch query URL and go. Try it out here.

Why?

You're a search developer trying to tune search results with Solr or Elasticsearch. You're engaged in search relevancy work.

You're probably stuck with the question of why? Why do search results come back in the order that they do? Solr and Elasticsearch exposes an explain syntax for you to try to explain search scoring. Unfortunately outside the simplest tasks, its a nightmare to read through. There are parsers like explain.solr.pl but they require a lot of manual copy/pasting of explain information to the tool.

Splainer is different by being a sandbox. Paste in your Solr or Elasticsearch URL, query parameters and all. As you work with your query, changing parameters, Splainer shows you parsed and summarized explain information alongside your documents. Continue working and see how the search results change.

Read the blog post introducing Splainer here

Splainer forms the core of the open source tool Quepid that allows you to do this over multiple queries against expert-graded search results to track search changes over a longer period of time.

Using Splainer

Take the tour to see how you'd use Splainer.

If you want to work locally, we have a Docker image

docker run -d -p 9000:9000 -p 35729:35729 o19s/splainer and then go to http://localhost:9000

Running the code

Npm/Yarn Dev Environment

Splainer is written using AngularJS project. It requires npm, grunt, and yarn.

Be sure you've installed npm, yarn, and grunt on your machine.

npm install -g grunt-cli

With Npm/Yarn installed

From the root of the project, you should be able to run the following:

yarn
grunt test
grunt serve

Now browse to http://localhost:9000.

To build the project, simply run grunt dist to build the static artifacts in the dist/ folder.

grunt dist

You can test out the static artifacts via ruby -run -e httpd -- -p 5000 ./dist and going to http://localhost:5000.

With Docker installed

From the root of the project, you should run:

docker build -t splainer  .
docker run -p 9000:9000 splainer

or use the following shortcuts if you have ruby installed:

bin/docker b

then to run the server run

bin/docker s

Who?

Created by OpenSource Connections

License

Released under Apache 2

You can’t perform that action at this time.