github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/docs/reference/kibana-plugins.md
Colleen McGinnis 1814c60017
[docs] Migrate docs from AsciiDoc to Markdown (#212558) 
Migrate docs from AsciiDoc to Markdown. The preview can be built after
#212557 is merged.

@florent-leborgne please tag reviewers, add the appropriate label(s),
and take this out of draft when you're ready.

Note: More files are deleted than added here because the content from
some files was moved to
[elastic/docs-content](https://github.com/elastic/docs-content).

**What has moved to
[elastic/docs-content](https://github.com/elastic/docs-content)?**

Public-facing narrative and conceptual docs have moved. Most can now be
found under the following directories in the new docs:
- explore-analyze: Discover, Dashboards, Visualizations, Reporting,
Alerting, dev tools...
- deploy-manage: Stack management (Spaces, user management, remote
clusters...)
- troubleshooting: .... troubleshooting pages

**What is staying in the Kibana repo?**

- Reference content (= anything that is or could be auto-generated):
Settings, syntax references
- Release notes
- Developer guide

---------

Co-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>
2025-03-04 14:56:07 +01:00

9 KiB
Raw Blame History

mapped_pages
https://www.elastic.co/guide/en/kibana/current/kibana-plugins.html

Kibana plugins [kibana-plugins]

Implement add-on functionality for {{kib}} with plug-in modules.

::::{admonition} Plugin compatibility :class: important

The {{kib}} plugin interfaces are in a state of constant development. We cannot provide backwards compatibility for plugins due to the high rate of change. {{kib}} enforces that the installed plugins match the version of {{kib}}. Plugin developers must release a new version of their plugin for each new {{kib}} release.

::::

Known plugins [known-kibana-plugins]

The known plugins were tested for {{kib}} 5.x, so we are unable to guarantee compatibility with your version of {{kib}}. The {{kib}} installer rejects any plugins that haven’t been published for your specific version of {{kib}}.

::::{important} 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 [_apps]

  • 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 [_timelion_extensions]

  • mathlion (fermiumlabs) - enables equation parsing and advanced math under Timelion

Visualizations [_visualizations]

Other [_other]

  • 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.

::::{note} To add your plugin to this page, open a pull request. ::::

Install plugins [install-plugin]

Use 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 [install-plugin-url]

You 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-9.0.0-beta1.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 [install-plugin-proxy-support]

{{kib}} 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 [update-remove-plugin]

To 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.

::::{note} Removing a plugin will result in an "optimize" run which will delay the next start of {{kib}}. ::::

Configure the plugin manager [configure-plugin-manager]

By 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:

bin/kibana-plugin install --timeout 30s sample-plugin

bin/kibana-plugin install --timeout 1m sample-plugin

Plugins and custom {{kib}} configurations [plugin-custom-configuration]

Use the -c or --config options with the install and remove commands to specify the path to the configuration file used to start {{kib}}. By default, {{kib}} uses the configuration file config/kibana.yml. When you change your installed plugins, the bin/kibana-plugin command restarts the {{kib}} 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 [plugin-manager-exit-codes]

0
Success
64
Unknown command or incorrect option parameter
74
I/O error
70
Other error