note-ify

Server Alerts... By Postal Mail! 📬 Send physical postcards summarizing your Prometheus alerts, because nothing says "your server was down last week" like finding out about it in your mailbox today!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

note-ify is a deliberately impractical and humorous service that sends physical postcards summarizing Prometheus server alerts via postal mail. Instead of instant notifications, it offers a nostalgic and slow approach to monitoring with the following ridiculously impractical features:

• Physical Postcards: Receive tangible postcards summarizing alerts from days or weeks ago, ideal for sysadmins who appreciate a retro vibe.
• Delightfully Slow Delivery: Experience delays of 3-5 business days (or more) to learn about past outages, adding a thrilling element of surprise.
• Weekly/Monthly Summaries: Choose between weekly or monthly postcard updates, which arrive long after issues are resolved or consequences faced.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Elixir

  # Instructions for installing Elixir can be found at https://elixir-lang.org/install.html

Installation

1. Clone the repo

   git clone https://github.com/zjpiazza/note-ify.git

2. Install dependencies

   mix deps.get

3. Configure your Alertmanager connection in config/config.exs

   config :note_ify, :alertmanager,
     url: "YOUR_ALERTMANAGER_URL"

4. Start the application

   mix run --no-halt

(back to top)

Usage

Use note-ify to receive physical postcards summarizing your server alerts. Here's how it works:

1. Connect to Alertmanager: Our Elixir app connects to your Prometheus Alertmanager and collects critical alerts.
2. Delayed Notification: Alerts are stored until your chosen summary day (weekly or monthly).
3. Physical Printing: Alerts are formatted onto a postcard, printed on paper, and prepared for mailing.
4. Snail Mail Delivery: Postcards are sent through the postal system, taking 3-7 days to reach you.

Join our small group of people who thought this was funny enough to try!

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Go live with beta

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the project_license. See LICENSE.txt for more information.

(back to top)