Skip to content

progrhyme/poloxy

Repository files navigation

poloxy

Build Status

Server-side proxy software for delivering system alerts.

Documentation site is now available.

What is "poloxy"?

The image bellow illustrates the concept of "poloxy".

  1. API receives alerts from monitoring systems and enqueues them.
  2. Worker summarizes alerts.
  3. Worker delivers them to recipients.

It prevents bursting alerts flood to recipients' phones or any devices.

poloxy-concept

Components

  • API
    • Receives alerts from monitoring systems and enqueues them
  • Worker
    • Dequeues alerts, summarizes them and delivers them to recipients
  • Web Dashboard
    • Viewer for incoming alerts and delivered notifications
    • One can check original alerts on this dashboard
    • Integrated with API
  • CLI
    • Utility tool for manual tasks such as data purge

How to use "poloxy"

See documentation site for guide to get started and detailed usage of poloxy.

Requirements

  • Ruby ... v2.0.0 or later
  • An RDBMS supported by Sequel ORM
    • Tested by SQLite3 and developed with MySQL. Hopefully other RDBs will do.

Additional Resources of "poloxy"

Presentations

2016 Apr. 28th - "Introduction to poloxy" in Nishi-Nippori.rb

Authors

IKEDA Kiyoshi progrhyme@gmail.com

License

The MIT License (MIT)

Copyright (c) 2016-2017 IKEDA Kiyoshi