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.
- 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).
Please see our documentation.
-
Download Elasticsearch for the version that matches the Kibana version specified in package.json.
-
Download and install the appropriate Open Distro for Elasticsearch Alerting plugin.
-
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.
-
Change your node version to the version specified in
.node-versioninside the Kibana root directory. -
Create a
kibana-extradirectory as a sibling directory to the Kibana source code directory. -
Check out this package from version control into the
kibana-extradirectory. -
Run
yarn kbn bootstrapinsidekibana-extra/opendistro-elasticsearch-alerting-kibana.
Ultimately, your directory structure should look like this:
.
├── kibana
├── kibana-extra
│ └── opendistro-elasticsearch-alerting-kibanaTo build the plugin's distributable zip simply run yarn build.
Example output: ./build/opendistro-alerting-0.7.0.0.zip
-
yarn startStarts Kibana and includes this plugin. Kibana will be available on
localhost:5601. -
NODE_PATH=../../kibana/node_modules yarn test:jestRuns the plugin tests.
- 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.
This code is licensed under the Apache 2.0 License.
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.