Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Up - A next generation status monitor

Project Description

Sometimes you just need to know, is it up? The goal of this project is to create an easy to use, but highly customizable status monitor.

Setup

First start by installing the environment.

$ mkdir example-status

$ cd example-status

$ virtualenv . -p python3 --no-site-packages

$ bin/pip install up

Now you need to create the upfile.py. It goes in the same folder as everything else. From here you can setup what you want to monitor.

from up import status, source, sink

class ExampleStatus(status.StatusMonitor):

    source = source.HTTPStatusSource('Example Status', 'https://example.com/')
    sink = sink.StdOutStatusSink()

You can now run it like this.

$ bin/up
Example Status: UP

Monitoring Multiple URL’s

Up uses a “tinker-toy” pattern allowing you to combine sources to build whatever kind of monitor you need. A StatusTreeSource will let you combine multiple sources into one.

from up import status, source, sink

class ExampleStatus(status.StatusMonitor):

    # You can also try a ThreadedTreeSource which runs the monitors
    # in parallel.
    source = source.StatusTreeSource('Example Status', [
        source.HTTPStatusSource('PROD', 'https://example.com/'),
        source.HTTPStatusSource('QA', 'https://qa.example.com/')
    ])
    sink = sink.StdOutStatusSink()

Up will query each of the sources and give you a simplified status.

$ bin/up
Example Status: HALF UP

For more information use -v.

$ bin/up -v
Example Status: HALF UP (50%)
    PROD: UP
    QA: DOWN

Checking the status of GitHub

Up comes with a source that reads from GitHub’s status API.

from up import status, source, sink

class ExampleStatus(status.StatusMonitor):

    source = source.GitHubStatusSource('GitHub Status')
    sink = sink.StdOutStatusSink()
$ bin/up -v
GitHub Status: UP

Developers Setup

$ virtualenv . -p python3 --no-site-packages

$ bin/python setup.py develop

Changelog

  • Next Nothing Yet.
  • 0.2.1 - Fix templates and static resources missing from egg
  • 0.2.0 - Detect ConnectionError and set status to DOWN; Expose Web Interface; Experimental SNMP monitoring (will most likely change)
  • 0.1.0 - Initial release
Release History

Release History

This version
History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
up-0.2.1.tar.gz (14.5 kB) Copy SHA256 Checksum SHA256 Source Jun 17, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting