README.md

Kibana Sunburst Visualization Plugin

This is a Sunburst diagram visType for Kibana, version 4.4.1.

This plugin is based on the excelent work done by @chenryn with the kbn_sankey_vis plugin (Thanks!), and of course on the exceptional D3 library, by @mbostock D3 Gallery (Also, Thanks!).

If you really liked this and feel like making a donation :

##Installation Steps

(Theses are optional, you can just copy the kbn_sunburst_vis folder into KIBANA_HOME/src/plugins) and run kibana.

git clone https://github.com/JuanCarniglia/kbn_sunburst_vis.git 
cd kbn_sunburst_vis
npm install
npm run build
cp -R build/kbn_sunburst_vis/ KIBANA_HOME/installedPlugins

** Note that in NTFS file systems, file paths that exceed 260 characters will fail with cp, you have to use ROBOCOPY:

robocopy /S build/kbn_sunburst_vis KIBANA_FOLDER_PATH/installedPlugins/kbn_sunburst_vis

** Also note that if npm run build fails, with a rsync.js error, it is likelly that you don't have RSYNC.EXE installed in your system, and also that you don't have it on your PATH environment variable.

Install it from https://www.itefix.net/cwrsync and run:

set PATH=%PATH%;{rsync installation directory}\bin

##How does it work

Basically, this plugin takes the information from Elasticsearch, generates a JSON structure similar to what is expected by the D3 Sunburst code, which is:

{
  "name": "flare",
  "children": [
    {
      "name": "something",
      "children": [
        {
          "name": "some_other",
          "children": null,
          "size": 138
        },
        {
          "name": "some_other_other",
          "children": null,
          "size": 305
        }
      ],
      "size": 443
    }
  ]
}

And generates two levels of Arcs. One root, and two other levels, to be exact.

The radius of the arcs are related to the "size" value.