<commit_before><img src="http://i.imgur.com/s4TKpbF.png" width="400"/>

# Kibi & Kibana Alerting & Reporting App

> Watching your data, 24/7/365. 

---
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/77b040968c354d6597ff60a615195a1a)](https://www.codacy.com/app/lorenzo-mangani/sentinl?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=sirensolutions/sentinl&amp;utm_campaign=Badge_Grade)
<img src="https://img.shields.io/badge/kibana-5+-green.svg"/>
<img src="https://img.shields.io/badge/elasticsearch-5.*-green.svg"/>


**SENTINL 5** extends *Kibi*/*Kibana 5* with **Alerting** and **Reporting** functionality to monitor, notify and report on data series changes using standard queries, programmable validators and a variety of configurable actions - Think of it as a free an independent ["Watcher"](https://www.elastic.co/guide/en/watcher/current/introduction.html) which also has scheduled ["Reporting"](https://www.elastic.co/products/reporting) capabilities (PNG/PDFs snapshots).

**SENTINL** is also designed to simplify the process of creating and managing alerts and reports in Kibi/Kibana via its App and Spy integration, directly in the Kibi/Kibana UI.

<!--<img src="http://i.imgur.com/aDHvUxf.png" width="400" /> -->

<img src="http://i.imgur.com/PsNsAiy.png" />


---

### Kibi/Kibana Alerts Display
SENTINL alerts can easily be displayed back in Kibana dashboards using [saved search](https://github.com/sirensolutions/sentinl/wiki/KAAE-Alerts-in-Dashboard) visualizations

### Kibi/Kibana Report Snapshots
Boss wants to see charts and reports? SENTINL can grab timed snapshots of Kibana dashboards _(or any other website)_ and deliver them via email using the [report](https://github.com/sirensolutions/sentinl/wiki/KAAE-Report-Example) action


--------------

## App Installation

**Substitute 5.4.2 with your version.**

#### Snapshot Plugin Install
<pre>
/opt/kibana/bin/kibana-plugin install https://github.com/sirensolutions/sentinl/releases/download/tag-5/sentinl-v5.4.2.zip
</pre>

#### Gulp Plugin Install
<pre>
git clone https://github.com/sirensolutions/sentinl
cd sentinl && npm install && gulp package --version=5.4.2
/opt/kibana/bin/kibana-plugin install file://`pwd`/target/gulp/sentinl.zip
</pre>

#### Dev Plugin Remove
<pre>
/opt/kibana/bin/kibana-plugin remove sentinl
</pre>

## Configuration & Usage
Consult our [wiki](https://github.com/sirensolutions/sentinl/wiki) to learn how to configure and use **SENTINL** and program awesome Watchers


## Project Status 

* Working Status, more testers needed!
  * Please [report](https://github.com/sirensolutions/sentinl/issues) any ideas, bug reports and findings
* Contributors Needed! If you know angular and elasticsearch, consider joining us!
 


 
## License
<pre>
This software is licensed under the Apache License, version 2 ("ALv2"), quoted below.

Copyright 2016, 2017 Siren Solutions
Copyright 2016, 2017 QXIP BV, <NAME> (<EMAIL>)
Copyright 2015, <NAME> (<EMAIL>)
<commit_msg>Update installation instructions for v5.5.x<commit_after><img src="http://i.imgur.com/s4TKpbF.png" width="400"/>

# Kibi & Kibana Alerting & Reporting App

> Watching your data, 24/7/365. 

---
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/77b040968c354d6597ff60a615195a1a)](https://www.codacy.com/app/lorenzo-mangani/sentinl?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=sirensolutions/sentinl&amp;utm_campaign=Badge_Grade)
<img src="https://img.shields.io/badge/kibana-5+-green.svg"/>
<img src="https://img.shields.io/badge/elasticsearch-5.*-green.svg"/>


**SENTINL 5** extends *Kibi*/*Kibana 5* with **Alerting** and **Reporting** functionality to monitor, notify and report on data series changes using standard queries, programmable validators and a variety of configurable actions - Think of it as a free an independent ["Watcher"](https://www.elastic.co/guide/en/watcher/current/introduction.html) which also has scheduled ["Reporting"](https://www.elastic.co/products/reporting) capabilities (PNG/PDFs snapshots).

**SENTINL** is also designed to simplify the process of creating and managing alerts and reports in Kibi/Kibana via its App and Spy integration, directly in the Kibi/Kibana UI.

<!--<img src="http://i.imgur.com/aDHvUxf.png" width="400" /> -->

<img src="http://i.imgur.com/PsNsAiy.png" />


---

### Kibi/Kibana Alerts Display
SENTINL alerts can easily be displayed back in Kibana dashboards using [saved search](https://github.com/sirensolutions/sentinl/wiki/KAAE-Alerts-in-Dashboard) visualizations

### Kibi/Kibana Report Snapshots
Boss wants to see charts and reports? SENTINL can grab timed snapshots of Kibana dashboards _(or any other website)_ and deliver them via email using the [report](https://github.com/sirensolutions/sentinl/wiki/KAAE-Report-Example) action


--------------

## App Installation

**Substitute 5.5.1 with your 5.5.x version.**

#### Snapshot Plugin Install
<pre>
/opt/kibana/bin/kibana-plugin install https://github.com/sirensolutions/sentinl/releases/download/tag-5.5/sentinl-v5.5.1.zip
</pre>

#### Gulp Plugin Install
<pre>
git clone https://github.com/sirensolutions/sentinl
cd sentinl && npm install && gulp package --version=5.5.1
/opt/kibana/bin/kibana-plugin install file://`pwd`/target/gulp/sentinl.zip
</pre>

#### Dev Plugin Remove
<pre>
/opt/kibana/bin/kibana-plugin remove sentinl
</pre>

## Configuration & Usage
Consult our [wiki](https://github.com/sirensolutions/sentinl/wiki) to learn how to configure and use **SENTINL** and program awesome Watchers


## Project Status 

* Working Status, more testers needed!
  * Please [report](https://github.com/sirensolutions/sentinl/issues) any ideas, bug reports and findings
* Contributors Needed! If you know angular and elasticsearch, consider joining us!
 


 
## License
<pre>
This software is licensed under the Apache License, version 2 ("ALv2"), quoted below.

Copyright 2016, 2017 Siren Solutions
Copyright 2016, 2017 QXIP BV, <NAME> (<EMAIL>)
Copyright 2015, <NAME> (<EMAIL>)

{'fraction_non_alphanumeric': 0.1392762284196547, 'fraction_numerical': 0.025066401062416997, 'mean_word_length': 4.787704130643612, 'pattern_counts': {'":': 0, '<': 37, '<?xml version=': 0, '>': 39, 'https://': 24, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6972270', 'n_tokens_mistral': 2178, 'n_tokens_neox': 1970, 'n_words': 527}