From 92158424329b5b5a4dbef128f29168f4ee8e63f8 Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Thu, 19 Nov 2020 09:44:17 -0600 Subject: [PATCH] [DOCS] Consolidates plugins (#83712) --- docs/plugins/known-plugins.asciidoc | 74 ------------------------ docs/user/plugins.asciidoc | 89 ++++++++++++++++++++++++++--- 2 files changed, 80 insertions(+), 83 deletions(-) delete mode 100644 docs/plugins/known-plugins.asciidoc diff --git a/docs/plugins/known-plugins.asciidoc b/docs/plugins/known-plugins.asciidoc deleted file mode 100644 index 7b24de42d8e1c..0000000000000 --- a/docs/plugins/known-plugins.asciidoc +++ /dev/null @@ -1,74 +0,0 @@ -[[known-plugins]] -== Known Plugins - -[IMPORTANT] -.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 itself. Plugin developers will have to release a new version of their plugin for each new Kibana release as a result. -============================================== - -This list of plugins is not guaranteed to work on your version of Kibana. Instead, these are plugins that were known to work at some point with Kibana *5.x*. The Kibana installer will reject any plugins that haven't been published for your specific version of Kibana. These plugins are not evaluated or maintained by Elastic, so care should be taken before installing them into your environment. - -[float] -=== Apps -* https://github.com/sivasamyk/logtrail[LogTrail] - View, analyze, search and tail log events in realtime with a developer/sysadmin friendly interface -* https://github.com/wtakase/kibana-own-home[Own Home] (wtakase) - enables multi-tenancy -* https://github.com/asileon/kibana_shard_allocation[Shard Allocation] (asileon) - visualize elasticsearch shard allocation -* https://github.com/wazuh/wazuh-kibana-app[Wazuh] - Wazuh provides host-based security visibility using lightweight multi-platform agents. -* https://github.com/TrumanDu/indices_view[Indices View] - View indices related information. -* https://github.com/johtani/analyze-api-ui-plugin[Analyze UI] (johtani) - UI for elasticsearch _analyze API -* https://github.com/TrumanDu/cleaner[Cleaner] (TrumanDu)- Setting index ttl. -* https://github.com/bitsensor/elastalert-kibana-plugin[ElastAlert Kibana Plugin] (BitSensor) - UI to create, test and edit ElastAlert rules -* https://github.com/query-ai/queryai-kibana-plugin[AI Analyst] (Query.AI) - App providing: NLP queries, automation, ML visualizations and insights - -[float] -=== Timelion Extensions -* https://github.com/fermiumlabs/mathlion[mathlion] (fermiumlabs) - enables equation parsing and advanced math under Timelion - -[float] -=== Visualizations -* https://github.com/virusu/3D_kibana_charts_vis[3D Charts] (virusu) -* https://github.com/JuanCarniglia/area3d_vis[3D Graph] (JuanCarniglia) -* https://github.com/TrumanDu/bmap[Bmap](TrumanDu) - integrated echarts for map visualization -* https://github.com/mstoyano/kbn_c3js_vis[C3JS Visualizations] (mstoyano) -* https://github.com/aaronoah/kibana_calendar_vis[Calendar Visualization] (aaronoah) -* https://github.com/elo7/cohort[Cohort analysis] (elo7) -* https://github.com/DeanF/health_metric_vis[Colored Metric Visualization] (deanf) -* https://github.com/JuanCarniglia/dendrogram_vis[Dendrogram] (JuanCarniglia) -* https://github.com/dlumbrer/kbn_dotplot[Dotplot] (dlumbrer) -* https://github.com/AnnaGerber/kibana_dropdown[Dropdown] (AnnaGerber) -* https://github.com/fbaligand/kibana-enhanced-table[Enhanced Table] (fbaligand) -* https://github.com/nreese/enhanced_tilemap[Enhanced Tilemap] (nreese) -* https://github.com/ommsolutions/kibana_ext_metrics_vis[Extended Metric] (ommsolutions) -* https://github.com/flexmonster/pivot-kibana[Flexmonster Pivot Table & Charts] - a customizable pivot table component for advanced data analysis and reporting. -* https://github.com/outbrain/ob-kb-funnel[Funnel Visualization] (roybass) -* https://github.com/sbeyn/kibana-plugin-gauge-sg[Gauge] (sbeyn) -* https://github.com/clamarque/Kibana_health_metric_vis[Health Metric] (clamarque) -* https://github.com/tshoeb/Insight[Insight] (tshoeb) - Multidimensional data exploration -* https://github.com/sbeyn/kibana-plugin-line-sg[Line] (sbeyn) -* https://github.com/walterra/kibana-milestones-vis[Milestones] (walterra) -* https://github.com/varundbest/navigation[Navigation] (varundbest) -* https://github.com/dlumbrer/kbn_network[Network Plugin] (dlumbrer) -* https://github.com/amannocci/kibana-plugin-metric-percent[Percent] (amannocci) -* https://github.com/dlumbrer/kbn_polar[Polar] (dlumbrer) -* https://github.com/dlumbrer/kbn_radar[Radar] (dlumbrer) -* https://github.com/dlumbrer/kbn_searchtables[Search-Tables] (dlumbrer) -* https://github.com/Smeds/status_light_visualization[Status Light] (smeds) -* https://github.com/prelert/kibana-swimlane-vis[Swimlanes] (prelert) -* https://github.com/sbeyn/kibana-plugin-traffic-sg[Traffic] (sbeyn) -* https://github.com/PhaedrusTheGreek/transform_vis[Transform Visualization] (PhaedrusTheGreek) -* https://github.com/nyurik/kibana-vega-vis[Vega-based visualizations] (nyurik) - Support for user-defined graphs, external data sources, maps, images, and user-defined interactivity. -* https://github.com/Camichan/kbn_aframe[VR Graph Visualizations] (Camichan) - -[float] -=== Other -* https://github.com/nreese/kibana-time-plugin[Time filter as a dashboard panel] Widget to view and edit the time range from within dashboards. - -* https://github.com/Webiks/kibana-API.git[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. - -* https://github.com/sw-jung/kibana_markdown_doc_view[Markdown Doc View] (sw-jung) - A plugin for custom doc view using markdown+handlebars template. -* https://github.com/datasweet-fr/kibana-datasweet-formula[Datasweet Formula] (datasweet) - enables calculated metric on any standard Kibana visualization. -* https://github.com/pjhampton/kibana-prometheus-exporter[Prometheus Exporter] - exports the Kibana metrics in the prometheus format - -NOTE: If you want your plugin to be added to this page, open a {kib-repo}tree/{branch}/docs/plugins/known-plugins.asciidoc[pull request]. diff --git a/docs/user/plugins.asciidoc b/docs/user/plugins.asciidoc index a96fe811dc84f..fa9e7d0c513b5 100644 --- a/docs/user/plugins.asciidoc +++ b/docs/user/plugins.asciidoc @@ -1,20 +1,90 @@ +[chapter] [[kibana-plugins]] -= Kibana plugins += {kib} plugins -[partintro] --- -Add-on functionality for {kib} is implemented with plug-in modules. You use the `bin/kibana-plugin` -command to manage these modules. +Implement add-on functionality for {kib} with plug-in modules. [IMPORTANT] .Plugin compatibility ============================================== -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} itself. Plugin developers will have to release a new version of their plugin for each new {kib} release as a result. +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. ============================================== --- +[float] +[[known-plugins]] +== Known 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}. +We are unable to evaluate or maintain the known plugins, so care should be taken before installation. + +[float] +=== Apps +* https://github.com/sivasamyk/logtrail[LogTrail] - View, analyze, search and tail log events in realtime with a developer/sysadmin friendly interface +* https://github.com/wtakase/kibana-own-home[Own Home] (wtakase) - enables multi-tenancy +* https://github.com/asileon/kibana_shard_allocation[Shard Allocation] (asileon) - visualize elasticsearch shard allocation +* https://github.com/wazuh/wazuh-kibana-app[Wazuh] - Wazuh provides host-based security visibility using lightweight multi-platform agents. +* https://github.com/TrumanDu/indices_view[Indices View] - View indices related information. +* https://github.com/johtani/analyze-api-ui-plugin[Analyze UI] (johtani) - UI for elasticsearch _analyze API +* https://github.com/TrumanDu/cleaner[Cleaner] (TrumanDu)- Setting index ttl. +* https://github.com/bitsensor/elastalert-kibana-plugin[ElastAlert Kibana Plugin] (BitSensor) - UI to create, test and edit ElastAlert rules +* https://github.com/query-ai/queryai-kibana-plugin[AI Analyst] (Query.AI) - App providing: NLP queries, automation, ML visualizations and insights + +[float] +=== Timelion Extensions +* https://github.com/fermiumlabs/mathlion[mathlion] (fermiumlabs) - enables equation parsing and advanced math under Timelion + +[float] +=== Visualizations +* https://github.com/virusu/3D_kibana_charts_vis[3D Charts] (virusu) +* https://github.com/JuanCarniglia/area3d_vis[3D Graph] (JuanCarniglia) +* https://github.com/TrumanDu/bmap[Bmap](TrumanDu) - integrated echarts for map visualization +* https://github.com/mstoyano/kbn_c3js_vis[C3JS Visualizations] (mstoyano) +* https://github.com/aaronoah/kibana_calendar_vis[Calendar Visualization] (aaronoah) +* https://github.com/elo7/cohort[Cohort analysis] (elo7) +* https://github.com/DeanF/health_metric_vis[Colored Metric Visualization] (deanf) +* https://github.com/JuanCarniglia/dendrogram_vis[Dendrogram] (JuanCarniglia) +* https://github.com/dlumbrer/kbn_dotplot[Dotplot] (dlumbrer) +* https://github.com/AnnaGerber/kibana_dropdown[Dropdown] (AnnaGerber) +* https://github.com/fbaligand/kibana-enhanced-table[Enhanced Table] (fbaligand) +* https://github.com/nreese/enhanced_tilemap[Enhanced Tilemap] (nreese) +* https://github.com/ommsolutions/kibana_ext_metrics_vis[Extended Metric] (ommsolutions) +* https://github.com/flexmonster/pivot-kibana[Flexmonster Pivot Table & Charts] - a customizable pivot table component for advanced data analysis and reporting. +* https://github.com/outbrain/ob-kb-funnel[Funnel Visualization] (roybass) +* https://github.com/sbeyn/kibana-plugin-gauge-sg[Gauge] (sbeyn) +* https://github.com/clamarque/Kibana_health_metric_vis[Health Metric] (clamarque) +* https://github.com/tshoeb/Insight[Insight] (tshoeb) - Multidimensional data exploration +* https://github.com/sbeyn/kibana-plugin-line-sg[Line] (sbeyn) +* https://github.com/walterra/kibana-milestones-vis[Milestones] (walterra) +* https://github.com/varundbest/navigation[Navigation] (varundbest) +* https://github.com/dlumbrer/kbn_network[Network Plugin] (dlumbrer) +* https://github.com/amannocci/kibana-plugin-metric-percent[Percent] (amannocci) +* https://github.com/dlumbrer/kbn_polar[Polar] (dlumbrer) +* https://github.com/dlumbrer/kbn_radar[Radar] (dlumbrer) +* https://github.com/dlumbrer/kbn_searchtables[Search-Tables] (dlumbrer) +* https://github.com/Smeds/status_light_visualization[Status Light] (smeds) +* https://github.com/prelert/kibana-swimlane-vis[Swimlanes] (prelert) +* https://github.com/sbeyn/kibana-plugin-traffic-sg[Traffic] (sbeyn) +* https://github.com/PhaedrusTheGreek/transform_vis[Transform Visualization] (PhaedrusTheGreek) +* https://github.com/nyurik/kibana-vega-vis[Vega-based visualizations] (nyurik) - Support for user-defined graphs, external data sources, maps, images, and user-defined interactivity. +* https://github.com/Camichan/kbn_aframe[VR Graph Visualizations] (Camichan) + +[float] +=== Other +* https://github.com/nreese/kibana-time-plugin[Time filter as a dashboard panel] Widget to view and edit the time range from within dashboards. + +* https://github.com/Webiks/kibana-API.git[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. + +* https://github.com/sw-jung/kibana_markdown_doc_view[Markdown Doc View] (sw-jung) - A plugin for custom doc view using markdown+handlebars template. +* https://github.com/datasweet-fr/kibana-datasweet-formula[Datasweet Formula] (datasweet) - enables calculated metric on any standard Kibana visualization. +* https://github.com/pjhampton/kibana-prometheus-exporter[Prometheus Exporter] - exports the Kibana metrics in the prometheus format + +NOTE: To add your plugin to this page, open a {kib-repo}tree/{branch}/docs/plugins/known-plugins.asciidoc[pull request]. + +[float] [[install-plugin]] == Install plugins @@ -60,6 +130,7 @@ You can specify the environment variable directly when installing plugins: [source,shell] $ http_proxy="http://proxy.local:4242" bin/kibana-plugin install +[float] [[update-remove-plugin]] == Update and remove plugins @@ -74,6 +145,7 @@ You can also remove a plugin manually by deleting the plugin's subdirectory unde NOTE: Removing a plugin will result in an "optimize" run which will delay the next start of {kib}. +[float] [[disable-plugin]] == Disable plugins @@ -88,6 +160,7 @@ NOTE: Disabling or enabling a plugin will result in an "optimize" run which will <1> You can find a plugin's plugin ID as the value of the `name` property in the plugin's `package.json` file. +[float] [[configure-plugin-manager]] == Configure the plugin manager @@ -125,5 +198,3 @@ you must specify the path to that configuration file each time you use the `bin/ 64:: Unknown command or incorrect option parameter 74:: I/O error 70:: Other error - -include::{kib-repo-dir}/plugins/known-plugins.asciidoc[]