UI uses local storage to save all the data. A middleware needs to be designed and developed for persisting the data
Alert GUIDs must be double-quoted when being searched on to ensure correctness of results, e.g. guid:“id1”.
Users cannot search for the contents of the comment's in the Alerts-UI
Grouping/faceting requests and other aggregations do not return meta alerts. This is because it's not clear what the intended results should be when there are multiple matching items.
Sorting has a similar caveat, in that if we are matching on multiple alerts, there is no well defined sort.
Alerts that are contained in a a meta alert are generally excluded from search results, because a user has already grouped them in a meaningful way.
Package the application with Maven:
cd metron-interface/metron-alerts mvn clean package
Untar the archive in the $METRON_HOME directory. The directory structure will look like:
bin metron-alerts-ui web expressjs alerts-server.js alerts-ui web assets (html, css, js, ...)
Copy the $METRON_HOME/bin/metron-alerts-ui
script to /etc/init.d/metron-alerts-ui
Express is installed at $METRON_HOME/web/expressjs/
as part of the Management UI installation process. The Management UI should be installed first on the same host as the Alerts UI.
Deploy the RPM at /metron/metron-deployment/packaging/docker/rpm-docker/target/RPMS/noarch/metron-alerts-$METRON_VERSION-*.noarch.rpm
Install the RPM with:
rpm -ih metron-alerts-$METRON_VERSION-*.noarch.rpm
The Alerts UI is included in the Metron Ambari MPack. It can be accessed through the Quick Links in the Metron service.
The Alerts UI is configured in the $METRON_HOME/config/alerts_ui.yml
file. Create this file and set the values to match your environment:
port: port the alerts UI will run on rest: host: REST application host port: REST applciation port
source.type.field
The source type format used. Defaults to source:type
.
After configuration is complete, the Management UI can be managed as a service:
service metron-alerts-ui start
The application will be available at http://host:4201 assuming the port is set to 4201
. Logs can be found at /var/log/metron/metron-alerts-ui.log
.
cd metron/metron-interface/metron-alerts npm install
./scripts/start-dev.sh
NOTE: In the development mode ui by default connects to REST at http://node1:8082 for fetching data. If you wish to change it you can change the REST url at metron/metron-interface/metron-alerts/proxy.conf.json
An expressjs server is available for mocking the elastic search api.
Run e2e webserver :
cd metron/metron-interface/metron-alerts sh ./scripts/start-server-for-e2e.sh
run e2e test using the following command
cd metron/metron-interface/metron-alerts npm run e2e
E2E tests uses data from full-dev wherever applicable. The tests assume rest-api's are available @http://node1:8082
NOTE: e2e tests covers all the general workflows and we will extend them as we need