Skip to content

Commit

Permalink
1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsusek committed Sep 27, 2019
1 parent a601eb3 commit 0a310fc
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 11 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
- Interactively build alerts for your Elasticsearch data using a query builder
- Preview results in an interactive chart
- Test your alerts against historical data
- Send notifications to Slack, Email, Telegram or an HTTP POST endpoint
- Send notifications to Slack, Email, Telegram, Jira or an HTTP POST endpoint
- Supports the Any, Blacklist, Whitelist, Change, Frequency, Flatline, Spike, Cardinality, New Term, and Metric Aggregation rule types
- View logs of when your alerts check, fire and fail

<br>
<br>

👉 Praeco is completely free, in return I only ask that you fill out [this simple survey](https://forms.gle/nAbu1RN2KHnyXX7L8) about how you use it.
👉 Praeco is completely free, in return I only ask that you fill out [this simple survey](https://forms.gle/nAbu1RN2KHnyXX7L8) about how you use it.

##
##

![](https://user-images.githubusercontent.com/611996/47752071-7c4a9080-dc61-11e8-8ccf-2196f13429b2.png)

Expand All @@ -30,7 +30,7 @@ docker-compose up

ℹ️ Don't use 127.0.0.1 for PRAECO_ELASTICSEARCH. See first item under the Troubleshooting section.

ℹ️ To set up Slack, Email or Telegram notifications, edit `rules/BaseRule.config`.
ℹ️ To set up Slack, Email, Jira or Telegram notifications, edit `rules/BaseRule.config`.

Praeco should now be available on http://127.0.0.1:8080

Expand Down Expand Up @@ -143,25 +143,29 @@ You will see this error when launching if praeco cannot find elasticsearch at th

Make sure the channel/username you are trying to post to exists.

#### How to setup Jira?

Please see https://elastalert.readthedocs.io/en/latest/ruletypes.html#jira for how to configure your `BaseRule.config` file.

## Architecture details

![](https://user-images.githubusercontent.com/611996/52892144-90a19300-3155-11e9-8050-cb4a440411a4.png)

Praeco is a vue.js app (hosted in an nginx docker container) that communicates with the [elastalert api](https://github.com/bitsensor/elastalert) (running in another docker container) to view/edit rules.
Praeco is a vue.js app (hosted in an nginx docker container) that communicates with the [elastalert api](https://github.com/bitsensor/elastalert) (running in another docker container) to view/edit rules.
The elastalert api interacts with the included [elastalert](https://github.com/Yelp/elastalert) python daemon directly for various tasks including testing and silencing rules, and indirectly by modifying or creating
rule files in the rules/ directory.

When you run praeco using the quickstart instructions, it runs these two docker containers, per the docker-compose.yml file.
When you run praeco using the quickstart instructions, it runs these two docker containers, per the docker-compose.yml file.

Praeco uses a fork of the elastalert _api server_, which is why the docker image source is `servercentral/elastalert`.

NOTE: Only the _api server_ is a fork, the elastalert daemon itself is built from the `master` branch whenever a new version of the `servercentral/elastalert` docker image is created.

Please see the development section below if you're interested in running these services separately.
Please see the development section below if you're interested in running these services separately.

## Developing

First, you need a local copy of the elastalert api server running, which itself needs elastalert. Start by cloning the neccessary repos
First, you need a local copy of the elastalert api server running, which itself needs elastalert. Start by cloning the neccessary repos

```
cd
Expand Down Expand Up @@ -217,7 +221,7 @@ npm run serve

You should now see the UI running at [http://localhost:8080](http://localhost:8080).

If you have any difficulties please open a github issue with your problem.
If you have any difficulties please open a github issue with your problem.

<br><br>

Expand Down
4 changes: 4 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@

Some version upgrades require further configuration. Version specific upgrade instructions are below.

## -> 1.0

- New options for JIRA added. Please see https://elastalert.readthedocs.io/en/latest/ruletypes.html#jira for how to configure your `BaseRule.config`.


## v0.3.9 -> v0.4.0

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "praeco",
"version": "0.4.5",
"version": "1.0",
"private": true,
"scripts": {
"serve": "vue-cli-service serve",
Expand Down
2 changes: 1 addition & 1 deletion src/components/config/alert/ConfigAlert.vue
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
<el-input id="jiraProject" v-model="jiraProject" :disabled="viewOnly" />
<label>Jira project</label>
</praeco-form-item>
<praeco-form-item label="Issue Type" prop="jiraIssueType" required>
<praeco-form-item label="Issue type" prop="jiraIssueType" required>
<el-input id="jiraIssueType" v-model="jiraIssueType" :disabled="viewOnly" />
<label>Jira issue type (Bug, Integration Bug, etc...)</label>
</praeco-form-item>
Expand Down

0 comments on commit 0a310fc

Please sign in to comment.