NOTE: This is an not-actively-maintained open-source copy of Pivot, which has now become a proprietary commercial product. For discussion on the status of the open source version, and any prior concerns, please visit: https://goo.gl/s2YbjR For the commercial version, please visit: https://imply.io/ This repo is not going to be actively maintained, and exists largely as an archive. -Geobio
Pivot is a web-based exploratory visualization UI for Druid built on top of Plywood.
Pivot is best used with the Imply Analytics Platform which can be downloaded from imply.io/download and comes with the stable version of Pivot.
The project is currently undergoing rapid development. Internal and external APIs may change with little notice.
Drag-and-drop UI
Contextual exploration
Comparisons
Make sure you have node (>= 4.x.x) installed. On MacOS with homebrew you can do:
brew update
brew install node
Next simply run:
npm i -g imply-pivot
That's it. You are ready to Pivot.
Start off by running an example (static) dataset:
pivot --examples
Next connect Pivot to your broker by simply pointing it to your broker host
pivot --druid your.druid.broker.host:8082
Pivot will automatically introspect your Druid cluster and figure out your dimensions and measures.
Note: if Pivot starts up and gives you a query error it is most likely because it could not properly introspect your schema. You probably have some hyperUnique column that Pivot is trying to SUM over. You will have to provide Pivot with a config file as in the nest section.
In general Pivot will never know your schema as well as you. To get a better experience you should create a config and provide it to Pivot. The fastest way to create a config is to have Pivot do it for you.
pivot --druid your.druid.broker.host:8082 --print-config --with-comments > config.yaml
The --print-config option will make Pivot run through its regular introspection and then, instead of tarting a server, dump the YAML onto the stdout and exit.
pivot --config config.yaml
Now open the config in your favorite editor and adjust to taste. Make sure to read through the documentation about the possible configuration options.
Here are the steps to clone Pivot and run it as a developer.
Firstly make sure you have the latest node (>= 5.5.x) and gulp installed:
npm i -g gulp
Clone the project
git clone [email protected]:implydata/pivot.git
cd pivot
Inside the pivot folder run:
npm install
gulp
Finally you have to create a config.yaml file. (or use the sample)
./bin/pivot --druid your.druid.broker.host:8082 --print-config --with-comments > config.yaml
The --with-comments flag adds docs about what goes into the config.
Then you are ready to
./bin/pivot --config config.yaml
We use WebStorm 2016.1 to develop Pivot and the checked in .idea directory contains
all of the auto formatting and code styles. You are free to use any editor as all the build scripts are editor agnostic.
Running gulp watch will build the project and start all the automated watchers.
Recent improvements:
- Collections
- String / RegExp filters
- Exclusion filters
- Full support of Druid 0.9.1
- Pivot can connect to multiple clusters, also Postgres and MySQL
- Continuous dimension filtering and splitting
- Support for Druid Theta sketches (for countDistinct())
- Horizontal bars in Table
For a full list of changes see our CHANGELOG
We will be working on:
- Additional visualizations (geo, heatmap)
- Removing strict limits on queries
- Various additions, improvements and fixes to make the app more complete
For updates about new and upcoming features follow @implydata on Twitter.
Please file bugs and feature requests by opening and issue on GitHub and direct all questions to our user groups.