You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user/plugins.asciidoc
+80-9Lines changed: 80 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,90 @@
1
+
[chapter]
1
2
[[kibana-plugins]]
2
-
= Kibana plugins
3
+
= {kib} plugins
3
4
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.
8
6
9
7
[IMPORTANT]
10
8
.Plugin compatibility
11
9
==============================================
12
10
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.
14
13
15
14
==============================================
16
-
--
17
15
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
* https://github.com/flexmonster/pivot-kibana[Flexmonster Pivot Table & Charts] - a customizable pivot table component for advanced data analysis and reporting.
* 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/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]
18
88
[[install-plugin]]
19
89
== Install plugins
20
90
@@ -60,6 +130,7 @@ You can specify the environment variable directly when installing plugins:
60
130
[source,shell]
61
131
$ http_proxy="http://proxy.local:4242" bin/kibana-plugin install <package name or URL>
62
132
133
+
[float]
63
134
[[update-remove-plugin]]
64
135
== Update and remove plugins
65
136
@@ -74,6 +145,7 @@ You can also remove a plugin manually by deleting the plugin's subdirectory unde
74
145
75
146
NOTE: Removing a plugin will result in an "optimize" run which will delay the next start of {kib}.
76
147
148
+
[float]
77
149
[[disable-plugin]]
78
150
== Disable plugins
79
151
@@ -88,6 +160,7 @@ NOTE: Disabling or enabling a plugin will result in an "optimize" run which will
88
160
89
161
<1> You can find a plugin's plugin ID as the value of the `name` property in the plugin's `package.json` file.
90
162
163
+
[float]
91
164
[[configure-plugin-manager]]
92
165
== Configure the plugin manager
93
166
@@ -125,5 +198,3 @@ you must specify the path to that configuration file each time you use the `bin/
125
198
64:: Unknown command or incorrect option parameter
0 commit comments