Skip to content

Karql/elastalert-kibana-plugin

Repository files navigation

ElastAlert Kibana Plugin

This plugin provides a way to create, test and edit ElastAlert rules within Kibana.

GitHub release Github Releases GitHub stars


Demo

Demo

Historical background

Fork of bitsensor/elastalert-kibana-plugin Copyright © 2019, BitSensor B.V.

Official repository is not maintained anymore.

Aim of this fork is to support new versions of Kibana (after migration to Kibana New Platform starts from 7.10).

There is still some work to be done, but this version should work ;)

For older Kibana versions check: nsano-rururu/elastalert-kibana-plugin

Requirements

  • ElastAlert2 Server - A server that runs ElastAlert2 and exposes REST API's for manipulating rules and alerts.
  • Kibana 7.10.0 or higher

Installation

Check the releases page to download the latest version of this plugin that is compatible with your Kibana version. Please be aware that you will need a running ElastAlert server to make use of this plugin.

⚠️ If there is no released compatible version with your Kibana then you can build plugin be your own. In contribution guide there is detailed instruction how to do it.

Plugin installation is as simple as executing a command like:

bin/kibana-plugin install file:////path/to/plugin/elastalertKibanaPlugin-x.y.z.zip

Official instruction

Psst! If you need some examples you can find it in dev/ folder or contribution guide

Configuration

By default the plugin will connect to http://localhost:3030. If your ElastAlert server is running on a different host or port add/change the following options in your config/kibana.yml file:

elastalertKibanaPlugin.serverSsl: false
elastalertKibanaPlugin.serverHost: localhost
elastalertKibanaPlugin.serverPort: 3030
elastalertKibanaPlugin.serverPath: ""
elastalertKibanaPlugin.serverCustomRequestHeaders:
  X-Custom-header1: "value"
  X-Custom-header2: "value"

⚠️ from version 1.4.0 config section name has been changed: elastalert-kibana-plugin -> elastalertKibanaPlugin

Contribution

Please report any issues or suggestions you have on the issues page. If you want to create a pull request please check our contribution guide.