Skip to content

Latest commit

 

History

History
100 lines (66 loc) · 4.08 KB

README.md

File metadata and controls

100 lines (66 loc) · 4.08 KB

Kibi & Kibana Alerting & Reporting App

Watching your data, 24/7/365.


Codacy Badge

SENTINL extends Kibi/Kibana 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" which also has scheduled "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.


Kibi/Kibana Plugin: SENTINL Spy

The SENTINL integrated Kibi/Kibana plug-in extends the default Spy functionality to shape new prototype Watchers based on Visualize queries, and providing them to SENTINL for fine editing and deployment.


Kibi/Kibana Alerts Display

SENTINL alerts can easily be displayed back in Kibana dashboards using saved search 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 action


App Installation

Snapshot Plugin Install

/opt/kibana/bin/kibana plugin --install sentinl -u https://github.com/sirensolutions/sentinl/releases/download/snapshot/sentinl-latest.tar.gz

Manual Plugin Install

git clone https://github.com/sirensolutions/sentinl
cd sentinl && npm install --production && npm run archive
/opt/kibana/bin/kibana plugin --install sentinl -u file://`pwd`/sentinl-latest.tar.gz

Gulp Plugin Install

git clone https://github.com/sirensolutions/sentinl
cd sentinl && npm install && gulp package
/opt/kibana/bin/kibana plugin --install sentinl -u file://`pwd`/target/gulp/sentinl.zip

Dev Plugin Remove

/opt/kibana/bin/kibana plugin -r sentinl

Configuration & Usage

Consult our wiki to learn how to configure and use SENTINL and program awesome Watchers

Project Status

  • Working Status, more testers needed!
    • Please report any ideas, bug reports and findings
  • Contributors Needed! If you know angular and elasticsearch, consider joining us!

License

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

Copyright 2016, 2017 Siren Solutions
Copyright 2016, Lorenzo Mangani ([email protected])
Copyright 2015, Rao Chenlin ([email protected])

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.