https://github.com/criteo/defcon

DefCon - Status page and API for production status
https://github.com/criteo/defcon

monitoring production status

Last synced: 4 days ago
JSON representation

DefCon - Status page and API for production status

• Host: GitHub
• URL: https://github.com/criteo/defcon
• Owner: criteo
• License: gpl-3.0
• Created: 2017-03-01T20:31:46.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-02-22T09:16:40.000Z (over 1 year ago)
• Last Synced: 2024-04-24T07:21:50.998Z (about 1 year ago)
• Topics: monitoring, production, status
• Language: Python
• Homepage:
• Size: 232 KB
• Stars: 15
• Watchers: 13
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DefCon

[![Build Status](https://travis-ci.org/criteo/defcon.svg?branch=master)](https://travis-ci.org/criteo/defcon)

[![Coverage Status](https://coveralls.io/repos/github/criteo/defcon/badge.svg)](https://coveralls.io/github/criteo/defcon?branch=master)

[![PyPI version](https://badge.fury.io/py/defcon-monitoring.svg)](https://badge.fury.io/py/defcon-monitoring)

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.

[![DefCon screenshot](doc/defcon.png)](doc/defcon.png)

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

## API

Simply go to `/api/defcon//`.

```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/'}",

            "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/'}",

            "plugin": "http://defcon/api/plugin/alertmanager/"

        }

    ],

    "statuses": [],

    "defcon": 5,

    "name": "Observability",

    "description": "",

    "link": "https://confluence/display/OBS",

    "contact": "[email protected]"

}

```

There are also more things available on `/api/`.

## Plugins

See [defcon/plugins/README.md](defcon/plugins/README.md)

## Quickstart

```shell

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

```