ElastAlert2 Server

A server that runs ElastAlert2 and exposes REST API's for manipulating rules and alerts.

It works great in combination with fork ElastAlert Kibana plugin.

You can also maintain everything directly from swagger 😍 just add /swagger-ui/ to the URL.

Check Docker Hub for current images.

GitHub release Docker pulls

Historical background

Official repository is not maintained anymore. Last commit was a long time ago. From that moment some things have changed a bit.

New version of ElastAlert was released and depends on python3. Some dependencies also went further.

I use and like this project so I have decided to develop it by my own.

Main goal of this fork is to support the latest version of ElastAlert - DONE!

Edit: 2021-09-09 ElastAlert is also not maintained anymore. ElastAlert2 has been born and now it is usied underhood.

In free time maybe something more ;)

Plans

:heavy_check_mark: Support the latest version of ElastAlert - DONE! Check this release: 4.0.0 for more details.

:heavy_check_mark: Support the latest version of ElastAlert2 - DONE! Check this release: 5.0.0-next.0 for more details.

:heavy_check_mark: Migrate to TypeScript

:heavy_check_mark: Add swagger

Prepare a good getting started guide

Installation

The most convenient way to run the ElastAlert2 server is by using our Docker container image. The default configuration uses localhost:9200 as ElasticSearch host, if this is not the case in your setup please edit es_host and es_port in both the elastalert.yaml and config.json configuration files.

To run the Docker image you will want to mount the volumes for configuration and rule files to keep them after container updates. In order to do that conveniently, please do: git clone https://github.com/karql/elastalert2-server.git; cd elastalert2-server

docker run -d -p 3030:3030 -p 3333:3333 \
    -v `pwd`/config/elastalert.yaml:/opt/elastalert/config.yaml \
    -v `pwd`/config/elastalert-test.yaml:/opt/elastalert/config-test.yaml \
    -v `pwd`/config/config.json:/opt/elastalert-server/config/config.json \
    -v `pwd`/rules:/opt/elastalert/rules \
    -v `pwd`/rule_templates:/opt/elastalert/rule_templates \
    --net="host" \
    --name elastalert2-server karql/elastalert2-server:latest

Building Docker image

Clone the repository

git clone https://github.com/karql/elastalert2-server.git && cd elastalert2-server

Build the image

docker build -t karql/elastalert2-server .

Options

Using a custom ElastAlert2 version (a release from github) e.g. master or etc

docker build --build-arg ELASTALERT_VERSION=master -t elastalert2-server .

Using a custom mirror

docker build --build-arg ELASTALERT_URL=http://example.mirror.com/master.zip -t elastalert2-server .

Configuration

The configuration is located in the config/config.json file. For local testing purposes you can then use a config/config.dev.json file which overrides config/config.json.

You can use the following config options:

{
  "appName": "elastalert-server", // The name used by the logging framework.
  "port": 3030, // The port to bind to
  "wsport": 3333, // The port to bind to for websockets
  "elastalertPath": "/opt/elastalert",  // The path to the root ElastAlert2 folder. It's the folder that contains the `setup.py` script.
  "start": "2014-01-01T00:00:00", // Optional date to start querying from
  "end": "2016-01-01T00:00:00", // Optional date to stop querying at
  "verbose": true, // Optional, will increase the logging verboseness, which allows you to see information about the state of queries.
  "es_debug": true, // Optional, will enable logging for all queries made to Elasticsearch
  "debug": false, // Will run ElastAlert2 in debug mode. This will increase the logging verboseness, change all alerts to DebugAlerter, which prints alerts and suppresses their normal action, and skips writing search and alert metadata back to Elasticsearch.
  "prometheus_port": 9979, // Will expose ElastAlert 2 Prometheus metrics on the specified port 
  "rulesPath": { // The path to the rules folder containing all the rules. If the folder is empty a dummy file will be created to allow ElastAlert2 to start.
    "relative": true, // Whether to use a path relative to the `elastalert2 Path` folder.
    "path": "/rules" // The path to the rules folder. 
  },
  "templatesPath": { // The path to the rules folder containing all the rule templates. If the folder is empty a dummy file will be created to allow ElastAlert2 to start.
    "relative": true, // Whether to use a path relative to the `elastalert2 Path` folder.
    "path": "/rule_templates" // The path to the rule templates folder.
  },
  "dataPath": { // The path to a folder that the server can use to store data and temporary files.
    "relative": true, // Whether to use a path relative to the `elastalert Path` folder.
    "path": "/server_data" // The path to the data folder.
  },
  "es_host": "localhost", // For getting metadata and field mappings, connect to this ES server
  "es_port": 9200, // Port for above
  "es_username": "", // Option basic-auth username and password for Elasticsearch
  "es_password": "", // Option basic-auth username and password for Elasticsearch
  "es_ssl": true, // Enable/Disable SSL
  "ea_verify_certs": true, //  Verify TLS certificates. false for self-signed certificate
  "es_ca_certs": "/etc/ssl/elasticsearch/ca", // Path to ca for ElasticSearch (SSL must be enabled)
  "es_client_cert": "/etc/ssl/elasticsearch/cert", // Path to cert for ElasticSearch (SSL must be enabled)
  "es_client_key": "/etc/ssl/elasticsearch/key", // Path to key for ElasticSearch (SSL must be enabled)
  "writeback_index": "elastalert_status" // Writeback index to examine for /metadata endpoint
}

ElastAlert2 also expects a elastalert.yaml with at least the following options.

# The elasticsearch hostname for metadata writeback
# Note that every rule can have its own elasticsearch host
es_host: localhost

# The elasticsearch port
es_port: 9200

# The index on es_host which is used for metadata storage
# This can be a unmapped index, but it is recommended that you run
# elastalert-create-index to set a mapping
writeback_index: elastalert_status

# This is the folder that contains the rule yaml files
# Any .yaml file will be loaded as a rule
rules_folder: rules

# How often ElastAlert2 will query elasticsearch
# The unit can be anything from weeks to seconds
run_every:
  seconds: 5

# ElastAlert2 will buffer results from the most recent
# period of time, in case some log sources are not in real time
buffer_time:
  minutes: 1

There is also a elastalert-test.yaml file which is only used when you use the API to test a rule. This allows you to write to a different writeback_index for example when testing rules.

API

This server exposes the following REST API's:

GET /

Exposes the current version running
GET /status

Returns either 'SETUP', 'READY', 'ERROR', 'STARTING', 'CLOSING', 'FIRST_RUN' or 'IDLE' depending on the current ElastAlert2 process status.
GET /status/control/:action

Where :action can be either 'start' or 'stop', which will respectively start or stop the current ElastAlert2 process.
GET /rules

Returns a list of directories and rules that exist in the rulesPath (from the config) and are being run by the ElastAlert2 process.
GET /rules/:id

Where :id is the id of the rule returned by GET /rules, which will return the file contents of that rule.
POST /rules/:id

Where :id is the id of the rule returned by GET /rules, which will allow you to edit the rule. The body send should be:
```
  {
    // Required - The full yaml rule config.
    "yaml": "..."
  }
```
DELETE /rules/:id

Where :id is the id of the rule returned by GET /rules, which will delete the given rule.
GET /templates

Returns a list of directories and templates that exist in the templatesPath (from the config) and are being run by the ElastAlert2 process.
GET /templates/:id

Where :id is the id of the template returned by GET /templates, which will return the file contents of that template.
POST /templates/:id

Where :id is the id of the template returned by GET /templates, which will allow you to edit the template. The body send should be:
```
  {
    // Required - The full yaml template config.
    "yaml": "..."
  }
```
DELETE /templates/:id

Where :id is the id of the template returned by GET /templates, which will delete the given template.

POST /test

This allows you to test a rule. The body send should be:

  {
    // Required - The full yaml rule config.
    "rule": "...",

    // Optional - The options to use for testing the rule.
    "options": {

      // Can be either "all", "schemaOnly" or "countOnly". "all" will give the full console output. 
      // "schemaOnly" will only validate the yaml config. "countOnly" will only find the number of matching documents and list available fields.
      "testType": "all",

      // Can be any number larger than 0 and this tells ElastAlert2 over a period of how many days the test should be run
      "days": "1"

      // Whether to send real alerts
      "alert": false,

      // Return results in structured JSON
      "format": "json",

      // Limit returned results to this amount
      "maxResults": 1000
    }
  }

WEBSOCKET /test

This allows you to test a rule and receive progress over a websocket. Send a message as JSON object (stringified) with two keys: rule (yaml string) and options (JSON object). You will receive progress messages over the socket as the test runs.
GET /metadata/:type

Returns metadata from elasticsearch related to elasalert's state. :type should be one of: elastalert_status, elastalert, elastalert_error, or silence. See docs about the elastalert2 metadata index.
GET /mapping/:index

Returns field mapping from elasticsearch for a given index.
POST /search/:index

Performs elasticsearch query on behalf of the API. JSON body to this endpoint will become body of an ES search.

Contribution

Please report any issues or suggestions you have on the issues page.

Karql / elastalert2-server

readme