Skip to content

Commit 02cda96

Browse files
authored
[DOCS] Consolidates plugins (#83712)
1 parent 78d7bfd commit 02cda96

File tree

2 files changed

+80
-83
lines changed

2 files changed

+80
-83
lines changed

docs/plugins/known-plugins.asciidoc

Lines changed: 0 additions & 74 deletions
This file was deleted.

docs/user/plugins.asciidoc

Lines changed: 80 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,90 @@
1+
[chapter]
12
[[kibana-plugins]]
2-
= Kibana plugins
3+
= {kib} plugins
34

4-
[partintro]
5-
--
6-
Add-on functionality for {kib} is implemented with plug-in modules. You use the `bin/kibana-plugin`
7-
command to manage these modules.
5+
Implement add-on functionality for {kib} with plug-in modules.
86

97
[IMPORTANT]
108
.Plugin compatibility
119
==============================================
1210
13-
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.
11+
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}.
12+
Plugin developers must release a new version of their plugin for each new {kib} release.
1413
1514
==============================================
16-
--
1715

16+
[float]
17+
[[known-plugins]]
18+
== Known plugins
19+
20+
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}.
21+
We are unable to evaluate or maintain the known plugins, so care should be taken before installation.
22+
23+
[float]
24+
=== Apps
25+
* https://github.com/sivasamyk/logtrail[LogTrail] - View, analyze, search and tail log events in realtime with a developer/sysadmin friendly interface
26+
* https://github.com/wtakase/kibana-own-home[Own Home] (wtakase) - enables multi-tenancy
27+
* https://github.com/asileon/kibana_shard_allocation[Shard Allocation] (asileon) - visualize elasticsearch shard allocation
28+
* https://github.com/wazuh/wazuh-kibana-app[Wazuh] - Wazuh provides host-based security visibility using lightweight multi-platform agents.
29+
* https://github.com/TrumanDu/indices_view[Indices View] - View indices related information.
30+
* https://github.com/johtani/analyze-api-ui-plugin[Analyze UI] (johtani) - UI for elasticsearch _analyze API
31+
* https://github.com/TrumanDu/cleaner[Cleaner] (TrumanDu)- Setting index ttl.
32+
* https://github.com/bitsensor/elastalert-kibana-plugin[ElastAlert Kibana Plugin] (BitSensor) - UI to create, test and edit ElastAlert rules
33+
* https://github.com/query-ai/queryai-kibana-plugin[AI Analyst] (Query.AI) - App providing: NLP queries, automation, ML visualizations and insights
34+
35+
[float]
36+
=== Timelion Extensions
37+
* https://github.com/fermiumlabs/mathlion[mathlion] (fermiumlabs) - enables equation parsing and advanced math under Timelion
38+
39+
[float]
40+
=== Visualizations
41+
* https://github.com/virusu/3D_kibana_charts_vis[3D Charts] (virusu)
42+
* https://github.com/JuanCarniglia/area3d_vis[3D Graph] (JuanCarniglia)
43+
* https://github.com/TrumanDu/bmap[Bmap](TrumanDu) - integrated echarts for map visualization
44+
* https://github.com/mstoyano/kbn_c3js_vis[C3JS Visualizations] (mstoyano)
45+
* https://github.com/aaronoah/kibana_calendar_vis[Calendar Visualization] (aaronoah)
46+
* https://github.com/elo7/cohort[Cohort analysis] (elo7)
47+
* https://github.com/DeanF/health_metric_vis[Colored Metric Visualization] (deanf)
48+
* https://github.com/JuanCarniglia/dendrogram_vis[Dendrogram] (JuanCarniglia)
49+
* https://github.com/dlumbrer/kbn_dotplot[Dotplot] (dlumbrer)
50+
* https://github.com/AnnaGerber/kibana_dropdown[Dropdown] (AnnaGerber)
51+
* https://github.com/fbaligand/kibana-enhanced-table[Enhanced Table] (fbaligand)
52+
* https://github.com/nreese/enhanced_tilemap[Enhanced Tilemap] (nreese)
53+
* https://github.com/ommsolutions/kibana_ext_metrics_vis[Extended Metric] (ommsolutions)
54+
* https://github.com/flexmonster/pivot-kibana[Flexmonster Pivot Table & Charts] - a customizable pivot table component for advanced data analysis and reporting.
55+
* https://github.com/outbrain/ob-kb-funnel[Funnel Visualization] (roybass)
56+
* https://github.com/sbeyn/kibana-plugin-gauge-sg[Gauge] (sbeyn)
57+
* https://github.com/clamarque/Kibana_health_metric_vis[Health Metric] (clamarque)
58+
* https://github.com/tshoeb/Insight[Insight] (tshoeb) - Multidimensional data exploration
59+
* https://github.com/sbeyn/kibana-plugin-line-sg[Line] (sbeyn)
60+
* https://github.com/walterra/kibana-milestones-vis[Milestones] (walterra)
61+
* https://github.com/varundbest/navigation[Navigation] (varundbest)
62+
* https://github.com/dlumbrer/kbn_network[Network Plugin] (dlumbrer)
63+
* https://github.com/amannocci/kibana-plugin-metric-percent[Percent] (amannocci)
64+
* https://github.com/dlumbrer/kbn_polar[Polar] (dlumbrer)
65+
* https://github.com/dlumbrer/kbn_radar[Radar] (dlumbrer)
66+
* https://github.com/dlumbrer/kbn_searchtables[Search-Tables] (dlumbrer)
67+
* https://github.com/Smeds/status_light_visualization[Status Light] (smeds)
68+
* https://github.com/prelert/kibana-swimlane-vis[Swimlanes] (prelert)
69+
* https://github.com/sbeyn/kibana-plugin-traffic-sg[Traffic] (sbeyn)
70+
* https://github.com/PhaedrusTheGreek/transform_vis[Transform Visualization] (PhaedrusTheGreek)
71+
* 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.
72+
* https://github.com/Camichan/kbn_aframe[VR Graph Visualizations] (Camichan)
73+
74+
[float]
75+
=== Other
76+
* https://github.com/nreese/kibana-time-plugin[Time filter as a dashboard panel] Widget to view and edit the time range from within dashboards.
77+
78+
* https://github.com/Webiks/kibana-API.git[Kibana-API] (webiks) Exposes an API with Kibana functionality.
79+
Use it to create, edit and embed visualizations, and also to search inside an embedded dashboard.
80+
81+
* https://github.com/sw-jung/kibana_markdown_doc_view[Markdown Doc View] (sw-jung) - A plugin for custom doc view using markdown+handlebars template.
82+
* https://github.com/datasweet-fr/kibana-datasweet-formula[Datasweet Formula] (datasweet) - enables calculated metric on any standard Kibana visualization.
83+
* https://github.com/pjhampton/kibana-prometheus-exporter[Prometheus Exporter] - exports the Kibana metrics in the prometheus format
84+
85+
NOTE: To add your plugin to this page, open a {kib-repo}tree/{branch}/docs/plugins/known-plugins.asciidoc[pull request].
86+
87+
[float]
1888
[[install-plugin]]
1989
== Install plugins
2090

@@ -60,6 +130,7 @@ You can specify the environment variable directly when installing plugins:
60130
[source,shell]
61131
$ http_proxy="http://proxy.local:4242" bin/kibana-plugin install <package name or URL>
62132

133+
[float]
63134
[[update-remove-plugin]]
64135
== Update and remove plugins
65136

@@ -74,6 +145,7 @@ You can also remove a plugin manually by deleting the plugin's subdirectory unde
74145

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

148+
[float]
77149
[[disable-plugin]]
78150
== Disable plugins
79151

@@ -88,6 +160,7 @@ NOTE: Disabling or enabling a plugin will result in an "optimize" run which will
88160

89161
<1> You can find a plugin's plugin ID as the value of the `name` property in the plugin's `package.json` file.
90162

163+
[float]
91164
[[configure-plugin-manager]]
92165
== Configure the plugin manager
93166

@@ -125,5 +198,3 @@ you must specify the path to that configuration file each time you use the `bin/
125198
64:: Unknown command or incorrect option parameter
126199
74:: I/O error
127200
70:: Other error
128-
129-
include::{kib-repo-dir}/plugins/known-plugins.asciidoc[]

0 commit comments

Comments
 (0)