Hawkular Alerts is the alerts module for Hawkular. It is responsible to define conditions rules over data events and fire alerts that can be sent by several action plugins.
Hawkular is a modular systems monitoring suite, that consists of several sub-projects for storing of metrics, alerting on incoming events and more. Those projects are developed in their own GitHub repositories and integrated in this project.
The project is divided into several modules
hawkular-alerts-api |
This is the public Java API for alerts component. |
hawkular-alerts-engine |
This is the implementation of the alerts engine. |
hawkular-alerts-rest |
This is a public REST API for alerts component. |
hawkular-alerts-bus |
This component is responsible for the communication between the alerts engine and the bus. |
hawkular-alerts-bus-api |
This is the public API for message objects used in hawkular-alerts-bus. |
hawkular-alerts-actions-api |
Common API for action plugins. |
hawkular-alerts-actions-bus |
Component responsible of the communication of the plugins with the engine via bus. |
hawkular-alerts-actions-standalone |
Component responsible of the communication of the plugins with the engine directly using Java API |
hawkular-alerts-actions-plugins |
Alert actions plugins. |
Hawkular Alerts can be built with the following steps:
git clone https://github.com/hawkular/hawkular-alerts.git
cd hawkular-alerts
mvn clean installThere is a integration test suite that downloads a wildfly server and deploys hawkular-alerts with an embedded cassandra service. These integration tests can be executed using -Prest profile:
mvn clean install -PrestThere is a integration test suite that downloads a wildfly server and deploys hawkular-alerts with an embedded cassandra service. These integration tests can be executed using -Prest profile:
mvn clean install -PstandaloneThere is a performance test suite focus in the hawkular-alerts-engine project. These tests are not active by default, they can be run using -Pperf profile:
mvn clean install -PperfREST API documentation can be generated using -Pdocgen profile.
The doc is generated under hawkular-alerts-rest/target folder.
mvn clean install -PdocgenHawkular-Alerts is released under Apache License, Version 2.0 as described in the LICENSE document
Copyright 2015 Red Hat, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.