Searchbox

Search UI wrapper Kibana plugin

Features

• Autocomplete quick test viewing results as you typing search terms
• Display paginated Search and Suggesters results
• Analyzer output quick test
• Type as you go (TAYG) results

TAB 1 Autocomplete quick test

Enter index, type, suggest field name , min number of chars that will trigger the search, size of the response. Using data from https://gist.github.com/zumo64/ce2534b7ac57320ad248d0906e866999 you can enter :

• index Name : bands
• type : doc
• Suggest field : name_autocomplete
• source field : name

Then try enter 'fly' on the right hand text field , you will get Pink Floyd as fuzziness is auto by default

TAB 2 Custom Search

• Enter or paste the body of the search on the textArea including parameters (use @0, @1 .. as token values).
• Specify the param values in the search box
• add/remove params values using the "+" an "-" icons
• toggle Type as you Go (TAYG) using the checkbox to see results "live"
• switch result tabs between suggestion and hits to see search/suggestion results

Example of query that returns hits and suggestions taken from https://gist.github.com/zumo64/ce2534b7ac57320ad248d0906e866999

Just paste the example code below in the Textarea on the tab "Custom Search"

{
  "query": {
    "match_all": {}
  }, 
  "suggest": {
    "my-suggest-1" : {
      "text" : "@0",
      "term" : {
        "field" : "name"
      }
    },
    "my-suggest-2" : {
      "text" : "@1",
      "phrase" : {
        "field" : "description",
        "max_errors":2,
        "highlight": {
          "pre_tag": "<em>",
          "post_tag": "</em>"
        }
      }
    }
  }
}

Enter pind and philosopical as search params on the right side of the screen (using '+' to add the second param) After pressing search the suggestions will appear as expected

Analyzer quick test

• Enter the index name
• Enter the analyzer name
• Enter the text to analyze
• press "search"

Installation

latest version available for 6.7.2 distributions available for versions 6.7.1,6.4.2, 6.1.2, 6.1.1,5.3.3, 5.4.0, 5.4.1, 6.1.2, 6.1.1, 6.2.3 check available releases

To install use as below depending on your kibana version :

./bin/kibana-plugin install https://github.com/zumo64/searchbox/releases/download/6.7.1/searchbox-2.0.0.zip

./bin/kibana-plugin install https://github.com/zumo64/searchbox/releases/download/6.1.1/searchbox-6.1.1.zip

./bin/kibana-plugin install https://github.com/zumo64/searchbox/releases/download/6.2.3/searchbox-0.0.4.zip

Development

The master branch is now using the Kibana plugin generator included in Kibana 6.3+

See the kibana contributing guide for instructions setting up your development environment. Once you have completed that, use the plugin script commands documented here