kkok (taken from Japanese word 警告 - keikoku -, in English alert) is a service to process alerts nicely. It gathers alerts from miscellaneous sources, applies filters to edit or route them, then sends the processed alerts via email, SMS (Twilio), Slack, etc.
kkok sends alerts through these steps:
- Generate alerts from sources.
- Collect and pool alerts for some duration.
- Edit/route collected alerts by filters.
- Send alerts along with the given routes.
Please read Architecture.md for more details.
- HTTP REST API.
maildir: generate alerts from mails in a Maildir directory.
freq: calculate and add frequency information to alerts.
discard: discard alerts based on the given conditions.
group: merge alerts into groups by field values.
route: add or replace routes to alert receivers.
exec: invoke an external command to edit alerts.
Use Go 1.7 or better.
Run the command below exactly as shown, including the ellipsis.
They are significant - see
go help packages.
go get -u github.com/cybozu-go/kkok/...
Authors & Contributors
- Yamamoto, Hirotaka @ymmt2005