Merge branch 'develop' into 'master'

[BREAKING] Use different config file to test rules

See merge request bitsensor/back-end/elastalert!34

Author: martijnrondeel

.gitlab-ci.yml

@@ -44,17 +44,6 @@ test:
     - npm install --quiet
     - npm test
 
-deploy:npm:
-  image: node:latest
-  stage: deploy
-  script:
-    - npm install --quiet
-    - sh scripts/update-authors.sh
-    - echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}'>.npmrc
-    - npm publish --access public
-  only:
-    - tags
-
 deploy:docker:
   stage: deploy
   script:

Dockerfile

@@ -40,6 +40,7 @@ COPY . /opt/elastalert-server
 
 RUN npm install --production --quiet
 COPY config/elastalert.yaml /opt/elastalert/config.yaml
+COPY config/elastalert-test.yaml /opt/elastalert/config-test.yaml
 COPY config/config.json config/config.json
 COPY rule_templates/ /opt/elastalert/rule_templates
 COPY elastalert_modules/ /opt/elastalert/elastalert_modules

Makefile

@@ -1,4 +1,4 @@
-v ?= v0.1.31
+v ?= v0.1.38
 
 all: build
 

README.md

@@ -16,6 +16,7 @@ To run the Docker image you will want to mount the volumes for configuration and
 ```bash
 docker run -d -p 3030:3030 \
     -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 \
@@ -112,6 +113,8 @@ run_every:
 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:

config/elastalert-test.yaml

@@ -0,0 +1,51 @@
+# NOTE: This config is used when testing a rule
+
+# 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
+
+# This is the folder that contains the rule yaml files
+# Any .yaml file will be loaded as a rule
+rules_folder: rules
+
+# How often ElastAlert will query elasticsearch
+# The unit can be anything from weeks to seconds
+run_every:
+  seconds: 5
+
+# ElastAlert will buffer results from the most recent
+# period of time, in case some log sources are not in real time
+buffer_time:
+  minutes: 1
+
+# Optional URL prefix for elasticsearch
+#es_url_prefix: elasticsearch
+
+# Connect with TLS to elasticsearch
+#use_ssl: True
+
+# Verify TLS certificates
+#verify_certs: True
+
+# GET request with body is the default option for Elasticsearch.
+# If it fails for some reason, you can pass 'GET', 'POST' or 'source'.
+# See http://elasticsearch-py.readthedocs.io/en/master/connection.html?highlight=send_get_body_as#transport
+# for details
+#es_send_get_body_as: GET
+
+# Option basic-auth username and password for elasticsearch
+#es_username: someusername
+#es_password: somepassword
+
+# 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
+
+# If an alert fails for some reason, ElastAlert will retry
+# sending the alert until this time period has elapsed
+alert_time_limit:
+  days: 2

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitsensor/elastalert",
-  "version": "0.0.14",
+  "version": "1.0.0",
   "description": "A server that runs ElastAlert and exposes REST API's for manipulating rules and alerts.",
   "license": "MIT",
   "main": "index.js",

src/controllers/test/index.js

@@ -31,7 +31,7 @@ export default class TestController {
           let stdoutLines = [];
           let stderrLines = [];
 
-          processOptions.push('-m', 'elastalert.test_rule', '--config', 'config.yaml', tempFilePath, '--days', options.days);
+          processOptions.push('-m', 'elastalert.test_rule', '--config', 'config-test.yaml', tempFilePath, '--days', options.days);
 
           if (options.format === 'json') {
             processOptions.push('--formatted-output');