{"id":13749067,"url":"https://github.com/sentinl/sentinl","last_synced_at":"2025-05-15T16:03:05.161Z","repository":{"id":46604478,"uuid":"58248941","full_name":"sentinl/sentinl","owner":"sentinl","description":"Kibana Alert \u0026 Report App for Elasticsearch","archived":false,"fork":false,"pushed_at":"2024-04-25T14:21:58.000Z","size":82977,"stargazers_count":1332,"open_issues_count":21,"forks_count":297,"subscribers_count":104,"default_branch":"master","last_synced_at":"2024-10-29T15:36:02.958Z","etag":null,"topics":["alarm","alert","alerting","anomaly","anomaly-detection","elastic","elasticsearch","elk","kaae","kibana","kibana-dashboard","kibi","pdf","plugin","reporting","scheduler","timeseries","visualization","watchdog","watcher"],"latest_commit_sha":null,"homepage":"https://qxip.net","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sentinl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["qxip"],"custom":["https://bunq.me/qxip"]}},"created_at":"2016-05-07T04:20:44.000Z","updated_at":"2024-10-12T09:51:59.000Z","dependencies_parsed_at":"2024-06-25T04:06:28.876Z","dependency_job_id":null,"html_url":"https://github.com/sentinl/sentinl","commit_stats":null,"previous_names":["sirensolutions/sentinl"],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentinl%2Fsentinl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentinl%2Fsentinl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentinl%2Fsentinl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentinl%2Fsentinl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sentinl","download_url":"https://codeload.github.com/sentinl/sentinl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254374398,"owners_count":22060609,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alarm","alert","alerting","anomaly","anomaly-detection","elastic","elasticsearch","elk","kaae","kibana","kibana-dashboard","kibi","pdf","plugin","reporting","scheduler","timeseries","visualization","watchdog","watcher"],"created_at":"2024-08-03T07:00:54.763Z","updated_at":"2025-05-15T16:03:05.131Z","avatar_url":"https://github.com/sentinl.png","language":"JavaScript","funding_links":["https://github.com/sponsors/qxip","https://bunq.me/qxip"],"categories":["JavaScript"],"sub_categories":[],"readme":"### SENTINL is looking for a Community!\n\nInterested in helping continue/maintain/extend/document/test the SENTINL open-source project?\u003cbr\u003e\nContact us or open an Issue, we'd love to have you onboard!\n\n---\n\n\u003cimg src=\"http://i.imgur.com/s4TKpbF.png\" width=\"300\"/\u003e\n\n### Siren Investigate \u0026 Kibana Alerting \u0026 Reporting App\n\n\u003e Watching your data, 24/7/365. \n\n---\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/77b040968c354d6597ff60a615195a1a)](https://www.codacy.com/app/qxip/SENTINL?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=sirensolutions/sentinl\u0026amp;utm_campaign=Badge_Grade)\n\u003cimg src=\"https://img.shields.io/badge/kibana-6+-green.svg\"/\u003e\n\u003cimg src=\"https://img.shields.io/badge/elasticsearch-6.*-green.svg\"/\u003e\n\n\n**SENTINL** extends *Siren Investigate* and *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\"](https://github.com/sirensolutions/sentinl/wiki/SENTINL-Introduction#what-is-a-watcher) which also has scheduled [\"Reporting\"](https://github.com/sirensolutions/sentinl/wiki/SENTINL-Report-Example) capabilities (PNG/PDFs snapshots).\n\n**SENTINL** is also designed to simplify the process of creating and managing alerts and reports in Siren Investigate/Kibana `6.x` via its native App Interface, or by using native watcher tools in Kibana `6.x+`.\n\n\u003c!--\u003cimg src=\"http://i.imgur.com/aDHvUxf.png\" width=\"400\" /\u003e --\u003e\n\n\u003cimg src=\"https://user-images.githubusercontent.com/5389745/36905512-d83083b0-1e33-11e8-9ff0-c8be94b493ef.png\" /\u003e\n\n\n---\n\n### Event History\nAlerts and Reports can easily be tracked and displayed in Kibana Charts, Widgets or Chart Annotations\n![sentinl_annotation](https://user-images.githubusercontent.com/1423657/36197513-3ed7dd1a-1174-11e8-92e0-65c630ae63b9.gif)\n\n### Visual Snapshots\nBoss wants to see charts and reports? Use Reports to create timed snapshots of Kibana dashboards _(or any other website)_ at a set date or condition, and deliver them as email attachments.\n\n### Help \u0026 Documentation\nDocumentation, Examples and Guides are available at [sentinl.readthedocs.io](http://sentinl.readthedocs.io)\n\n\n--------------\n\n## App Installation\n\n#### **ATTENTION** Siren users should use the native version bundled with their distribution!\n\n#### Snapshot Plugin Install\nUse this example and substitute 6.2.2 with your _actual_ Kibana version or manually pick a [release](https://github.com/sirensolutions/sentinl/releases)\n\u003cpre\u003e\n/opt/kibana/bin/kibana-plugin install https://github.com/sirensolutions/sentinl/releases/download/tag-6.2.2/sentinl-v6.2.2.zip\n\u003c/pre\u003e\n\n#### Gulp Plugin Install\n\u003cpre\u003e\ngit clone https://github.com/sirensolutions/sentinl\ncd sentinl \u0026\u0026 npm install \u0026\u0026 gulp package --version=6.2.2\n/opt/kibana/bin/kibana-plugin install file:///`pwd`/target/gulp/sentinl.zip\n\u003c/pre\u003e\n\n#### Dev Plugin Remove\n\u003cpre\u003e\n/opt/kibana/bin/kibana-plugin remove sentinl\n\u003c/pre\u003e\n\n\n### Project Status \n\n* Production Ready w/ thousands of deployments\n* Please help us by starring the Project\n* Contributors Needed! Please consider joining us!\n\n### Issues \u0026 Bugs\nPlease [report](https://github.com/sirensolutions/sentinl/issues) any ideas, bug reports and findings on the repository.\n \n\n\n \n## License\n\u003cpre\u003e\nThis software is licensed under the Apache License, version 2 (\"ALv2\"), quoted below.\nCopyright 2016, 2020 QXIP BV\nCopyright 2016, 2019 Siren\nCopyright 2015, Lorenzo Mangani (lorenzo.mangani@gmail.com), Rao Chenlin (rao.chenlin@gmail.com)\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not\nuse this file except in compliance with the License. You may obtain a copy of\nthe License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\nWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\nLicense for the specific language governing permissions and limitations under\nthe License.\n\u003c/pre\u003e\n\n\u003cimg src=\"https://img.shields.io/badge/made%20with-love-red.svg\"/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsentinl%2Fsentinl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsentinl%2Fsentinl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsentinl%2Fsentinl/lists"}