Skip to main content

defcon.

Project description

DefCon

.. image:: https://travis-ci.org/iksaif/defcon.svg?branch=master :target: https://travis-ci.org/iksaif/defcon :alt: Build Status

.. image:: https://coveralls.io/repos/github/iksaif/defcon/badge.svg :target: https://coveralls.io/github/iksaif/defcon?branch=master :alt: Coverage Status

.. image:: https://badge.fury.io/py/defcon-monitoring.svg :target: https://badge.fury.io/py/defcon-monitoring :alt: PyPI version

UI and API to show an aggregate status of your services. The idea of defcon is that it gathers the status of various components of your infrastructure and exposes them to both humans and machines. Humans (:couple:) will go to the UI to see if something is known to be wrong, and machines (:computer:) will consume the API. This could be used to automatically pause Jenkins job or Chef runs when the production looks unstable.

.. image:: doc/defcon.png :target: doc/defcon.png :alt: DefCon screenshot

This is currently under active development and not ready for production.

API

Simply go to /api/defcon/<COMPONENT_ID>/.

.. code-block:: json

GET /api/defcon/observability/ HTTP 200 OK Allow: GET, OPTIONS Content-Type: application/json Vary: Accept

{ "url": "http://defcon/api/components/observability/", "plugins": [ { "url": "http://defcon/api/plugin_instance/4/", "statuses": [], "name": "alertmanager-page", "config": "{'receiver': 'observability-page', 'defcon': 2, 'api': 'https://alertmanager/api/v1/'}", "plugin": "http://defcon/api/plugin/alertmanager/" }, { "url": "http://defcon/api/plugin_instance/5/", "name": "alertmanager-ticket", "description": "", "config": "{'receiver': 'observability-ticket', 'defcon': 4, 'api': 'https://alertmanager/api/v1/'}", "plugin": "http://defcon/api/plugin/alertmanager/" } ], "statuses": [], "defcon": 5, "name": "Observability", "description": "", "link": "https://confluence/display/OBS", "contact": "observability@iksaif.net" }

There are also more things available on /api/.

Plugins

See defcon/plugins/README.md <defcon/plugins/README.md>_

Quickstart

.. code-block::

virtualenv venv -p python3 source venv/bin/activate cp examples/local_settings.py defcon/ pip install -r requirements.txt ./manage.py migrate ./manage.py migrate --run-syncdb ./manage.py createsuperuser ./manage.py loadplugins ./manage.py loadcomponents ./manage.py runplugins ./manage.py runserver

Project details


Download files

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

Source Distribution

defcon-monitoring-0.2.0.tar.gz (24.0 kB view details)

Uploaded Source

File details

Details for the file defcon-monitoring-0.2.0.tar.gz.

File metadata

  • Download URL: defcon-monitoring-0.2.0.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.3

File hashes

Hashes for defcon-monitoring-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0f8fa48b666c0dbceec1775f90d9e875f37fc94b020540019a7c3792d50cc9c8
MD5 8480e66c693a9ce071a3250c25fa159a
BLAKE2b-256 58cb8eb3ab3bd42d6e12aae432876a5f3a14b4dd5924a8aa5ecaf4a36f9b7f14

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page