Kibana Developer Plugin

A Kibana plugin with utilities to assist with development against the Kibana/Elasticsearch stack

Installation and Usage

This plugin can be installed into an existing Kibana development setup by adding it to the <kibana_code>/plugins/ directory. Plugins in this directory are excluded from the Kibana codebase by default.

Here are instructions on how to install it:

1. Ensure that your Kibana develpment environment has been bootstrap'd
2. Change directory into the plugins directory at the root of your kibana codebase

   cd plugins

3. Clone this repo (or your own fork of this repo) into the plugins directory

   git clone git@github.com:paul-tavares/dev_plugin.git

   This will create a directory named dev_plugin under the plugins and clone the source under that directory.
4. Bootstrap the newly installed plugin

   cd dev_plugin
   yarn bootstrap

5. If Kibana server is already running, stop and restart it so that it picks up the new plugin
6. From the Kibana UI, you should now see a Kibana Developer menu options at the bottom of the Kibana global side menu.

Development

To Develop against this plugin, follow the normal steps for forking a repo. You can then clone the repo to your local Kibana development environment following the instructions above for Installation and Usage.

Once the plugin has been installed/setup, run the watcher so that changes done are built and seend in the UI on the next browser refresh:

cd plugins/dev_plugin
yarn dev:watch

Scripts

yarn bootstrap

Execute this to install node_modules and setup the dependencies in your plugin and in Kibana

yarn dev

Build the plugin into the target directory, which will also enable Kibana to correctly pickup this plugin when it is started in dev mode.

yarn dev:watch

Build the plugin anytime the source changes. Use this when developing against this plugin