README.md

Summary

Maintainability
Test Coverage
![411](/docs/imgs/logo.png?raw=true)


What is 411?
============

[![Join the chat at https://gitter.im/411/Lobby](https://badges.gitter.im/411/Lobby.svg)](https://gitter.im/411/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/etsy/411.svg?branch=master)](https://travis-ci.org/etsy/411)
[![Code Climate](https://codeclimate.com/github/etsy/411/badges/gpa.svg)](https://codeclimate.com/github/etsy/411)
[![Test Coverage](https://codeclimate.com/github/etsy/411/badges/coverage.svg)](https://codeclimate.com/github/etsy/411/coverage)

Search scheduling
-----------------

Configure Searches to periodically run against a variety of data sources. You can define a custom pipeline of Filters to manipulate any generated Alerts and forward them to multiple Targets.


Alert management
----------------

Review and manage Alerts through the web interface. You can apply Renderers to alerts to enrich them with additional metadata.


Use cases
=========

- You want to detect when certain log lines show up in ES.
- You want to detect when a Graphite metric changes.
- You want to detect when a server stops responding
- You want to manage alerts through a simple workflow.

And much more!


Setup
=====

- [Setup instructions](/docs/Setup.md)
- [Docker instructions](/docs/Docker.md)


Help
====

See the [Table of Contents](/docs/README.md) for a list of documentation pages.

If you've any questions, feel free to ask on Gitter. You can also contact us on Twitter at [@sixhundredns](https://twitter.com/sixhundredns) and [@kennysan](https://twitter.com/Kennysan).


Links
=====

- [CaC post](https://codeascraft.com/2016/09/15/introducing-411-a-new-open-source-framework-for-handling-alerting/)
- [Defcon presentation](https://www.youtube.com/watch?v=LQyqhrDl7f8)
- [Slides](https://speakerdeck.com/kennysan/building-effective-security-alerting)
- [Demo](https://demo.fouroneone.io) (User: user, Pass: user)


Contribute
==========

Check out the contribution [guidelines](/CONTRIBUTING.md).


License
=======

411 is released under the [MIT License](/LICENSE).