README.md

Open Distro for Elasticsearch Alerting Kibana

The Open Distro for Elasticsearch Alerting Kibana plugin lets you manage your Open Distro for Elasticsearch alerting plugin to monitor your data and send notifications when certain criteria are met---all from Kibana.

Highlights

• Create and schedule monitors, which run period queries against data in Elasticsearch.
• Evaluate query results against triggers to see if they meet certain criteria.
• If trigger criteria are met, generate alerts and perform actions (e.g. post a message in a Slack channel).

Documentation

Please see our documentation.

Setup

1. Download Elasticsearch for the version that matches the Kibana version specified in package.json.

2. Download and install the appropriate Open Distro for Elasticsearch Alerting plugin.

3. Download the Kibana source code for the version specified in package.json you want to set up.

   See the Kibana contributing guide for more instructions on setting up your development environment.

4. Change your node version to the version specified in .node-version inside the Kibana root directory.

5. cd into the plugins directory of the Kibana source code directory.

6. Check out this package from version control into the plugins directory.

7. Run yarn kbn bootstrap inside kibana/plugins/alerting-kibana-plugin.

Ultimately, your directory structure should look like this:

.
├── kibana
│   └── plugins
│       └── alerting-kibana-plugin

Build

To build the plugin's distributable zip simply run yarn build.

Example output: ./build/opendistroAlertingKibana-1.12.0.0.zip

Run

• yarn start

  • Starts Kibana and includes this plugin. Kibana will be available on localhost:5601.
  • Please run in the Kibana root directory
  • You must have Elasticsearch running with the Alerting plugin

Test

There are unit/stubbed integration tests and Cypress e2e/integration tests.

• yarn test:jest

  • Runs the plugin unit tests.

• yarn run cypress open

  • Opens the Cypress test runner.

• yarn run cypress run

  • Runs all Cypress tests headlessly in the Electron browser.

To run the Cypress tests, you must have both Elasticsearch and Kibana running with the Alerting plugin.

If you are running Cypress tests with Kibana development server, pass these 2 options to yarn start:

1. --no-base-path: opt out the BasePathProxy.
2. --no-watch: make sure your server is not restarted.

Contributing to Open Distro for Elasticsearch Alerting Kibana

• Refer to CONTRIBUTING.md.
• Since this is a Kibana plugin, it can be useful to review the Kibana contributing guide alongside the documentation around Kibana plugins and plugin development.

License

This code is licensed under the Apache 2.0 License.

Copyright

Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.