- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.17
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- AI Assistant settings
- Alerting and action settings
- APM settings
- Banners settings
- Cases 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
- Dashboards
- 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
- Search
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- Cases
- Connectors
- Amazon Bedrock
- Cases
- CrowdStrike
- D3 Security
- Google Gemini
- IBM Resilient
- Index
- Jira
- Microsoft Teams
- Observability AI Assistant
- OpenAI
- Opsgenie
- PagerDuty
- SentinelOne
- Server log
- ServiceNow ITSM
- ServiceNow SecOps
- ServiceNow ITOM
- Swimlane
- Slack
- TheHive
- Tines
- Torq
- Webhook
- Webhook - Case Management
- xMatters
- Preconfigured connectors
- License Management
- Maintenance windows
- Manage data views
- Numeral Formatting
- Rollup Jobs
- Manage saved objects
- Security
- Spaces
- Advanced Settings
- Tags
- Upgrade Assistant
- Watcher
- 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
- 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
- Synthetics APIs
- Uptime APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Upgrade notes
- Kibana 8.17.1
- Kibana 8.17.0
- Kibana 8.16.3
- Kibana 8.16.2
- Kibana 8.16.1
- Kibana 8.16.0
- Kibana 8.15.5
- Kibana 8.15.4
- Kibana 8.15.3
- Kibana 8.15.2
- Kibana 8.15.1
- Kibana 8.15.0
- Kibana 8.14.3
- Kibana 8.14.2
- Kibana 8.14.1
- Kibana 8.14.0
- Kibana 8.13.4
- Kibana 8.13.3
- Kibana 8.13.2
- Kibana 8.13.1
- Kibana 8.13.0
- Kibana 8.12.2
- Kibana 8.12.1
- Kibana 8.12.0
- Kibana 8.11.4
- Kibana 8.11.3
- Kibana 8.11.2
- Kibana 8.11.1
- Kibana 8.11.0
- Kibana 8.10.4
- Kibana 8.10.3
- Kibana 8.10.2
- Kibana 8.10.1
- Kibana 8.10.0
- Kibana 8.9.2
- Kibana 8.9.1
- Kibana 8.9.0
- Kibana 8.8.2
- Kibana 8.8.1
- Kibana 8.8.0
- Kibana 8.7.1
- Kibana 8.7.0
- Kibana 8.6.1
- Kibana 8.6.0
- Kibana 8.5.2
- Kibana 8.5.1
- Kibana 8.5.0
- Kibana 8.4.3
- Kibana 8.4.2
- Kibana 8.4.1
- Kibana 8.4.0
- Kibana 8.3.3
- Kibana 8.3.2
- Kibana 8.3.1
- Kibana 8.3.0
- Kibana 8.2.3
- Kibana 8.2.2
- Kibana 8.2.1
- Kibana 8.2.0
- Kibana 8.1.3
- Kibana 8.1.2
- Kibana 8.1.1
- Kibana 8.1.0
- Kibana 8.0.0
- Kibana 8.0.0-rc2
- Kibana 8.0.0-rc1
- Kibana 8.0.0-beta1
- Kibana 8.0.0-alpha2
- Kibana 8.0.0-alpha1
- Developer guide
Kibana plugins
editKibana plugins
editImplement add-on functionality for Kibana with plug-in modules.
Plugin compatibility
The Kibana plugin interfaces are in a state of constant development. We cannot provide backwards compatibility for plugins due to the high rate of change. Kibana enforces that the installed plugins match the version of Kibana. Plugin developers must release a new version of their plugin for each new Kibana release.
Known plugins
editThe known plugins were tested for Kibana 5.x, so we are unable to guarantee compatibility with your version of Kibana. The Kibana installer rejects any plugins that haven’t been published for your specific version of Kibana.
Known plugins are developed and maintained outside of Elastic. They are not supported by Elastic. If you encounter an issue with a community plugin, contact the plugin’s owner.
Apps
edit- LogTrail - View, analyze, search and tail log events in realtime with a developer/sysadmin friendly interface
- Own Home (wtakase) - enables multi-tenancy
- Shard Allocation (asileon) - visualize elasticsearch shard allocation
- Wazuh - Wazuh provides host-based security visibility using lightweight multi-platform agents.
- Indices View - View indices related information.
- Analyze UI (johtani) - UI for elasticsearch _analyze API
- Cleaner (TrumanDu)- Setting index ttl.
- ElastAlert Kibana Plugin (BitSensor) - UI to create, test and edit ElastAlert rules
- AI Analyst (Query.AI) - App providing: NLP queries, automation, ML visualizations and insights
Timelion Extensions
edit- mathlion (fermiumlabs) - enables equation parsing and advanced math under Timelion
Visualizations
edit- 3D Charts (virusu)
- 3D Graph (JuanCarniglia)
- Bmap(TrumanDu) - integrated echarts for map visualization
- C3JS Visualizations (mstoyano)
- Calendar Visualization (aaronoah)
- Cohort analysis (elo7)
- Colored Metric Visualization (deanf)
- Dendrogram (JuanCarniglia)
- Dotplot (dlumbrer)
- Dropdown (AnnaGerber)
- Enhanced Table (fbaligand)
- Enhanced Tilemap (nreese)
- Extended Metric (ommsolutions)
- Flexmonster Pivot Table & Charts - a customizable pivot table component for advanced data analysis and reporting.
- Funnel Visualization (roybass)
- Gauge (sbeyn)
- Health Metric (clamarque)
- Insight (tshoeb) - Multidimensional data exploration
- Line (sbeyn)
- Milestones (walterra)
- Navigation (varundbest)
- Network Plugin (dlumbrer)
- Percent (amannocci)
- Polar (dlumbrer)
- Radar (dlumbrer)
- Search-Tables (dlumbrer)
- Status Light (smeds)
- Swimlanes (prelert)
- Traffic (sbeyn)
- Transform Visualization (PhaedrusTheGreek)
- Vega-based visualizations (nyurik) - Support for user-defined graphs, external data sources, maps, images, and user-defined interactivity.
- VR Graph Visualizations (Camichan)
- Sankey-Visualization (uniberg)
Other
edit- Time filter as a dashboard panel Widget to view and edit the time range from within dashboards.
- Kibana-API (webiks) Exposes an API with Kibana functionality. Use it to create, edit and embed visualizations, and also to search inside an embedded dashboard.
- Markdown Doc View (sw-jung) - A plugin for custom doc view using markdown+handlebars template.
- Datasweet Formula (datasweet) - enables calculated metric on any standard Kibana visualization.
To add your plugin to this page, open a pull request.
Install plugins
editUse the following command to install a plugin:
bin/kibana-plugin install <package name or URL>
When you specify a plugin name without a URL, the plugin tool attempts to download an official Elastic plugin, such as:
$ bin/kibana-plugin install x-pack
Install plugins from an arbitrary URL
editYou can download official Elastic plugins simply by specifying their name. You can alternatively specify a URL or file path to a specific plugin, as in the following examples:
$ bin/kibana-plugin install https://artifacts.elastic.co/downloads/packs/x-pack/x-pack-8.17.0.zip
or
$ bin/kibana-plugin install file:///local/path/to/custom_plugin.zip
You can specify URLs that use the HTTP, HTTPS, or file
protocols.
Proxy support for plugin installation
editKibana supports plugin installation via a proxy. It uses the http_proxy
and https_proxy
environment variables to detect a proxy for HTTP and HTTPS URLs.
It also respects the no_proxy
environment variable to exclude specific URLs from proxying.
You can specify the environment variable directly when installing plugins:
$ http_proxy="http://proxy.local:4242" bin/kibana-plugin install <package name or URL>
Update and remove plugins
editTo update a plugin, remove the current version and reinstall the plugin.
To remove a plugin, use the remove
command, as in the following example:
$ bin/kibana-plugin remove x-pack
You can also remove a plugin manually by deleting the plugin’s subdirectory under the plugins/
directory.
Removing a plugin will result in an "optimize" run which will delay the next start of Kibana.
Configure the plugin manager
editBy default, the plugin manager provides you with feedback on the status of the activity you’ve asked the plugin manager
to perform. You can control the level of feedback for the install
and remove
commands with the --quiet
and
--silent
options. Use the --quiet
option to suppress all non-error output. Use the --silent
option to suppress all
output.
By default, plugin manager installation requests do not time out. Use the --timeout
option, followed by a time, to
change this behavior, as in the following examples:
Waits for 30 seconds before failing.
bin/kibana-plugin install --timeout 30s sample-plugin
Waits for 1 minute before failing.
bin/kibana-plugin install --timeout 1m sample-plugin
Plugins and custom Kibana configurations
editUse the -c
or --config
options with the install
and remove
commands to specify the path to the configuration file
used to start Kibana. By default, Kibana uses the configuration file config/kibana.yml
. When you change your installed
plugins, the bin/kibana-plugin
command restarts the Kibana server. When you are using a customized configuration file,
you must specify the path to that configuration file each time you use the bin/kibana-plugin
command.
Plugin manager exit codes
edit
0 |
Success |
64 |
Unknown command or incorrect option parameter |
74 |
I/O error |
70 |
Other error |
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now