Skip to content

Commit

Permalink
Correct documentation installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jertel committed May 6, 2021
1 parent 74b5dfd commit ad0566d
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 15 deletions.
6 changes: 0 additions & 6 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,3 @@ repos:
sha: v0.3.5
hooks:
- id: reorder-python-imports
- repo: git://github.com/Yelp/detect-secrets
sha: 0.9.1
hooks:
- id: detect-secrets
args: ['--baseline', '.secrets.baseline']
exclude: .*tests/.*|.*yelp/testing/.*|\.pre-commit-config\.yaml
4 changes: 0 additions & 4 deletions docs/source/elastalert.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ ElastAlert 2 - Automated rule-based alerting for Elasticsearch

ElastAlert is a simple framework for alerting on anomalies, spikes, or other patterns of interest from data in Elasticsearch.

At Yelp, we use Elasticsearch, Logstash and Kibana for managing our ever increasing amount of data and logs.
Kibana is great for visualizing and querying data, but we quickly realized that it needed a companion tool for alerting
on inconsistencies in our data. Out of this need, ElastAlert was created.

If you have data being written into Elasticsearch in near real time and want to be alerted when that data matches certain patterns, ElastAlert is the tool for you.

Overview
Expand Down
10 changes: 5 additions & 5 deletions docs/source/running_elastalert.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Requirements

- Elasticsearch
- ISO8601 or Unix timestamped data
- Python 3.6
- Python 3.9
- pip, see requirements.txt
- Packages on Ubuntu 18.x: build-essential python3-pip python3.6 python3.6-dev libffi-dev libssl-dev
- Packages on Ubuntu 20.x: build-essential python3-pip python3.6 python3.6-dev libffi-dev libssl-dev
Expand All @@ -18,13 +18,13 @@ Requirements
Downloading and Configuring
---------------------------

You can either install the latest released version of ElastAlert using pip::
You can either install the latest released version of ElastAlert 2 using pip::

$ pip install elastalert
$ pip install elastalert2

or you can clone the ElastAlert repository for the most recent changes::
or you can clone the ElastAlert2 repository for the most recent changes::

$ git clone https://github.com/Yelp/elastalert.git
$ git clone https://github.com/jertel/elastalert2.git

Install the module::

Expand Down

0 comments on commit ad0566d

Please sign in to comment.