User Guide
Also available as:
PDF

Launching the Alerts User Interface

The Alerts user interface is bundled with HCP but you need to copy the metron-alerts tar file to the desired host before you can launch the UI.

Prerequisite:

  • In order to view alerts in the Metron Alerts UI you must first generate alerts from the Metron topologies.

  1. Download a copy of the HCP code from https://github.com/apache/metron.

    git clone https://github.com/apache/metron.git
  2. Perform a fresh build of Metron to retrieve the Alerts tar file:

    cd <ROOT FOLDER of CODE>
    mvn clean package -DskipTests
  3. Copy metron/metron-interface/metron-alerts/target/metron-alerts-METRON_VERSION-archive.tar.gz to the Metron host.

  4. Untar the archive in the $METRON_HOME directory. The directory structure will look like:

     ```
        bin
           start_alerts_ui.sh
        web
           alerts-ui
             package.json
             server.js
             web assets (html, css, js, ...)
        ```
  5. Start the application with the following script:

    ./bin/start_alerts_ui.sh
            Usage: server.js -p [port] -r [restUrl]
            Options:
              -p  Port to run metron alerts ui [required]
              -r, --resturl  Url where elastic search rest api is available  [required]
  6. Launch the Alerts UI using a web browser:

    http://<metron_server>:3000/alerts-list
[Note]Note

There is no login module for the Alerts UI.