takodakko / hermes

A customizable alert manager for Elasticsearch

---

Alerts

View and delete existing alert configurations that are continually monitored at your desired frequency. Create alerts by specifying the new alert name, the index pattern to monitor, the frequency at which the Elasticsearch cluster will be searched, the rule to search for in the cluster, and the customized email that will be sent when the Elasticsearch query responds with a hit. Hermes uses Mustache.js which allows you to include any field from the top hit in the body of your alert email.

Example Email

View Logs

View individual logs using a simple filter.

Visualize Logs

Visualize the count of logs that were created every hour over the past two weeks.

Index Patterns

Create and delete index patterns so that you can query multiple indices from your Elasticsearch cluster at once.

Getting started

Deploying Hermes

Hermes requires your Elasticsearch cluster to already be set up, running, and accessible on port 9200.

Running Hermes the first time:

1. Fork and clone the main branch of this repository
2. Make sure you are in the outer-most directory of the repository in your command line
3. Configure the email account that will send alert messages per the instructions in Configuring SMTP With Gmail
4. Run npm install
5. Run npm run build
6. Run npm start
7. Open your web browser to http://localhost:3068

---

Configuring SMTP With Gmail

1. Create a new Gmail account.
2. Open settings and disable Two-Factor Authentication and allow access in Gmail for less secure apps. Configuring these settings will allow Hermes to send emails on your behalf.
3. Open the email_smtp.js file located in the top directory of your cloned repository.
4. Enter your new password into Password and your new email address into the Username and From properties of the object passed into Email.send()
5. Save your changes.

---

Contributors

Eric Olaya
LinkedIn | Github

Jared Lewis
LinkedIn | Github

Sheldon Johnson
LinkedIn | Github