Plugin Resources
editPlugin Resources
editHere are some resources that will be helpful for getting started with plugin development
Our IRC channel
editMany Kibana developers hang out on irc.freenode.net
in the #kibana
channel. We want to help you with plugin development. Even more than that, we want your help in understanding your plugin goals so we can build a great plugin system for you! If you’ve never used IRC, welcome to the fun. You can get started with the Freenode Web Client.
Some light reading
edit- Our contributing guide can help you get a development environment going
- Tim Roes' excellent blog series Writing Kibana Plugins
Videos
editPlugin Generator
editIt is recommended that you kick-start your plugin by generating it with the Kibana Plugin Generator. Run the following within the Kibana repo and you will be asked a couple questions, see some progress bars, and have a freshly generated plugin ready for you to play within Kibana’s sibling kibana-extra
folder.
node scripts/generate_plugin my_plugin_name # replace "my_plugin_name" with your desired plugin name
Directory structure for plugins
editThe Kibana directory must be named kibana
, and your plugin directory must be located within the sibling kibana-extra
folder, for example:
. ├── kibana ├── kibana-extra/foo-plugin └── kibana-extra/bar-plugin
References in the code
edit-
Plugin class: What options does the
kibana.Plugin
class accept? - UI Exports: What type of exports are available?
Elastic UI Framework
editIf you’re developing a plugin that has a user interface, take a look at our Elastic UI Framework. It documents the CSS and React components we use to build Kibana’s user interface.
You’re welcome to use these components, but be aware that they are rapidly evolving and we might introduce breaking changes that will disrupt your plugin’s UI.