Status page application with browser and REST API interface.
Installation
Install the package
pip install django-statusboardAdd the following applications to your Django projects
INSTALLED_APPS += [
'django.contrib.humanize',
'django.contrib.staticfiles',
'rest_framework',
'statusboard',
]Update your urlconf:
# myproject/urls.py
urlpatterns += [
url(r'^statusboard/$', include('statusboard.urls')),
]Update your database
./manage migrateConfiguration
You can configure the app using the dict STATUSBOARD in settings.py:
from django.contrib.staticfiles.templatetags.staticfiles import static
# for Django >= 3.0: from django.templatetags.static import static
STATUSBOARD = {
"INCIDENT_DAYS_IN_INDEX": 7,
"OPEN_INCIDENT_IN_INDEX": True,
"AUTO_REFRESH_INDEX_SECONDS": 0,
"FAVICON_DEFAULT": static('statusboard/images/statusboard-icon-default.png'),
"FAVICON_INDEX_DICT": {
0: static('statusboard/images/statusboard-icon-operational.png'),
1: static('statusboard/images/statusboard-icon-performance.png'),
2: static('statusboard/images/statusboard-icon-partial.png'),
3: static('statusboard/images/statusboard-icon-major.png'),
},
}INCIDENT_DAYS_IN_INDEX: number of days to show in index (1 = today).
OPEN_INCIDENT_IN_INDEX: show not fixed incidents in index, whether or not the incident is older than INCIDENT_DAYS_IN_INDEX.
AUTO_REFRESH_INDEX_SECONDS: auto refresh home page every N seconds (0 = disabled).
FAVICON_DEFAULT: default favicon.
FAVICON_INDEX_DICT: favicon for index, based on the worst status (default: FAVICON_DEFAULT). The keys (0, 1, 2, 3) are the status values (see SERVICE_STATUSES in statusboard/models.py).
Customize pages
The following blocks are customizable in statusboard/base.html:
title: title of the page
branding: branding in fixed navbar
bootstrap_theme: bootstrap theme
header: header of the page
userlinks: links in the header
footer: footer div
style: CSS files
script: JavaScript files
Example: change branding and title
Django 1.8
Copy statusboard/templates/statusboard/base.html in one of your templates dir and edit the file.
Django >= 1.9
In Django >= 1.9, the templates can be extended recursively (see https://docs.djangoproject.com/en/1.9/releases/1.9/#templates).
Create a statusboard/base.html in one of your templates dir:
{% extends `statusboard/base.html %}
{% block title %}
ACME, Inc.
{% endblock %}
{% block branding %}
<a class="navbar-brand" href="{% url 'statusboard:index' %}">ACME status</a>
{% endblock %}
Notifications
django-statusboard doesn’t provide an out-of-the-box notification system, but it’s easy to implement using django signals.
Moreover, django-statusboard tracks the previous status of a service (Service._status).
from django.dispatch import receiver
from django.db.models.signals import post_save
from django.core.mail import mail_admins
from statusboard import Service
@receiver(post_save, sender=Service)
def notify_service_update(sender, instance, **kwargs):
# Send an email to admins if the service is getting worse, otherwise do nothing.
if instance.status > instance._status:
mail_admins("Alert", "Service {} is {}".format(instance.name, instance.get_status_display()))REST API
django-statusboard comes with a set of REST API to manage its models, based on Django REST Framework ModelViewSet.
Contact and copyright information
Copyright (C) 2019 Emanuele Di Giacomo emanuele@digiacomo.cc
django-statusboard is licensed under GPLv2+.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-statusboard-0.8.1.tar.gz.
File metadata
- Download URL: django-statusboard-0.8.1.tar.gz
- Upload date:
- Size: 209.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
33649926a4a549c4da7ee9c6af697e991ffe011f0ec71cb5657def8095708e34
|
|
| MD5 |
65fbdf8865efd4f3e466db1e12a9d4b6
|
|
| BLAKE2b-256 |
3507960c0e84cdcb85d50c9e1395452ff5048bfd620174aa9c36b16f944e3db5
|
