Skip to content

Latest commit

 

History

History
197 lines (140 loc) · 6.15 KB

README.md

File metadata and controls

197 lines (140 loc) · 6.15 KB
Raw

kibana-API

Kibana-API is an extension to Kibana that lets you tap in to the dashboard management board from your app and change the visualizations dynamically.

I recommend you read all, step by step, but if you don't have patience go to How To Use

Demo

alt text

postMessage

The plugin uses Window.postMessage() method (https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage), to connect between the applicaion and the kibana iframe

var iframe = document.getElementById('Iframe');

in javascript use:
var iWindow=iframe.contentWindow

in typescript use:
var iWindow = (<HTMLIFrameElement>iframe).contentWindow;

iWindow.postMessage({}, '*');

Events

setVisualization

In order to create a visualization you need to call the plugin with the visualization state. Kibana-API is able to recieve all the visualization's properties (isFullState = true) - fullState. In case you do not wish to define all the visualization's properties (isFullState = false), you can pass some and Kibana-API will automatically fill-in the rest. partial visState

Add visualization

Replace visualization

Filter Functions

Filter functions

Index Pattern Functions

Index pattern functions

Create Visualization's By an External Configuration File

Create visualizations by uploading a json file with an array of the visualization's properties,

Json File Example

alt text

Install

cd kibana_home, then type the appropriate command:

Kibana 5.6.3

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.6.3/kibana_api-0.2.0.zip

Kibana 5.6.2

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.6.2/kibana_api-0.2.0.zip

Kibana 5.6.1

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.6.1/kibana_api-0.2.0.zip

Kibana 5.6.0

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.6.0/kibana_api-0.2.0.zip

Kibana 5.5.3

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.5.3/kibana_api-0.2.0.zip

Kibana 5.5.2

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.5.2/kibana_api-0.2.0.zip

Kibana 5.5.1

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.5.1/kibana_api-0.2.0.zip

Kibana 5.5.0

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.5.0/kibana_api-0.2.0.zip

Kibana 5.4.3

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.4.3/kibana_api-0.2.0.zip

Kibana 5.4.2

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.4.2/kibana_api-0.2.0.zip

Kibana 5.4.1

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.4.1/kibana_api-0.2.0.zip

Kibana 5.4.0

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.4.0/kibana_api-0.2.0.zip

Kibana 5.3.2

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.3.2/kibana_api-0.2.0.zip

Kibana 5.3.1

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.3.1/kibana_api-0.2.0.zip

Kibana 5.3.0

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.3.0/kibana_api-0.2.0.zip

Kibana 5.2.2

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.2.2/kibana_api-0.2.0.zip

Kibana 5.2.1

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.2.1/kibana_api-0.2.0.zip

Kibana 5.2.0

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.2.0/kibana_api-0.2.0.zip

Kibana 5.1.2

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.1.2/kibana_api-0.2.0.zip

Kibana 5.1.1

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.1.1/kibana_api-0.2.0.zip

Kibana 5.0.2

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.0.2/kibana_api-0.2.0.zip

Kibana 5.0.1

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.0.1/kibana_api-0.2.0.zip

Kibana 5.0.0

./bin/kibana-plugin install https://github.com/Webiks/kibana-API/releases/download/5.0.0/kibana_api-0.2.0.zip

when the installation complete restart kibana.

How to Use

  1. Install the plugin, look at https://github.com/Webiks/kibana-API#install
  2. Restart Kibana
  3. Index data to elasticsearch (if you have not done so before)
  4. Navigate to localhost:5601 and:
    a) Create kibana index-pattern (you can also do that with create index pattern function
    b) Create dashboard
    c) Press on the share button and copy the Embedded iframe URL to your HTML application (don't use the save dashboard link)
  5. Give ID to the iframe element.
  6. Look At my example :https://github.com/Webiks/kibana-API/wiki/Replace-Visualization or https://github.com/Webiks/kibana-API/wiki/Add-Visualization
  7. Enjoy

Development

Build plugin

  • clone git repo in kibana_home/plugins
  • cd kibana_home/plugins/kibana-API
  • npm install

Run unit test

npm test

Help me to improve!:

If there's any problem or doubt, please, open a Github Issue (Pull Request) or contact me via email: ytzhak@webiks.com.