- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.7
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Add comment
- Create case
- Delete cases
- Delete comments
- Find case activity
- Find cases
- Find connectors
- Get alerts
- Get case activity
- Get case
- Get case status
- Get cases by alert
- Get comments
- Get configuration
- Get reporters
- Get tags
- Push case
- Set configuration
- Update cases
- Update comment
- Update configuration
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Osquery manager API
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Developer guide
Plugin tooling
editPlugin tooling
editAutomatic plugin generator
editWe recommend that you kick-start your plugin by generating it with the Kibana Plugin Generator. Run the following in the Kibana repo, and you will be asked a couple of questions, see some progress bars, and have a freshly generated plugin ready for you to play with in Kibana’s plugins
folder.
node scripts/generate_plugin
Plugin location
editThe Kibana directory must be named kibana
, and your plugin directory should be located in the root of kibana
in a plugins
directory, for example:
. └── kibana └── plugins ├── foo-plugin └── bar-plugin
Build plugin distributable
editKibana distributable is not shipped with @kbn/optimizer
anymore. You need to pre-build your plugin for use in production.
You can leverage @kbn/plugin-helpers to build a distributable archive for your plugin.
The package transpiles the plugin code, adds polyfills, and links necessary js modules in the runtime.
You don’t need to install the plugin-helpers
dependency. If you created the plugin using node scripts/generate_plugin
script, package.json
is already pre-configured.
To build your plugin run within your plugin folder:
yarn build
It will output a`zip` archive in kibana/plugins/my_plugin_name/build/
folder.
Install a plugin from archive
editRun Kibana with your plugin in dev mode
editIf your plugin isn’t server only and contains ui
in order for Kibana to pick the browser bundles you need to run yarn dev --watch
in the plugin root folder at a dedicated terminal.
Then, in a second terminal, run yarn start
at the Kibana root folder. Make sure Kibana found and bootstrapped your plugin by:
[INFO ][plugins-system.standard] Setting up […] plugins: […, myPluginName, …]
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now