Skip to main content

Simple django app to expose system infos: libraries version, databae server infos...

Project description

==============
django-sysinfo
==============

.. image:: https://badge.fury.io/py/django-sysinfo.png
:target: https://badge.fury.io/py/django-sysinfo

.. image:: https://travis-ci.org/saxix/django-sysinfo.png?branch=master
:target: https://travis-ci.org/saxix/django-sysinfo

Simple django app to expose system infos like libraries version, database server.

Easy to extend to add custom checks.

Features
--------

- dump system informations
- check API to add custom checks
- simple echo
- retrieve library version


Quickstart
----------

Install django-sysinfo::

pip install django-sysinfo

put it in your `INSTALLED_APPS`::

INSTALLED_APPS=[...
'django_sysinfo'
]

add relevant entries in your url.conf::

urlpatterns = (
....
url(r'', include(django_sysinfo.urls)),
)

or customize them::

from django_sysinfo.views import http_basic_login, sysinfo

urlpatterns = (
url('sys/info/$', http_basic_login(sysinfo), name='sys-info'),
url('sys/version/(?P<name>.*)/$', version, name='sys-version')
)


Known issues and limitations
----------------------------

There are some limitations in the metrics returned by sysinfo, anyway this package is
not intended to be used as host/resources monitoring tool.

- Disk space returns device info, any soft limits are ignored
- Memory can be wrong in some virtual environments


Links
~~~~~

+--------------------+----------------+--------------+------------------------+
| Stable | |master-build| | |master-cov| | |
+--------------------+----------------+--------------+------------------------+
| Development | |dev-build| | |dev-cov| | |
+--------------------+----------------+--------------+------------------------+
| Project home page: |https://github.com/saxix/django-sysinfo |
+--------------------+---------------+----------------------------------------+
| Issue tracker: |https://github.com/saxix/django-sysinfo/issues?sort |
+--------------------+---------------+----------------------------------------+
| Download: |http://pypi.python.org/pypi/django-sysinfo/ |
+--------------------+---------------+----------------------------------------+
| Documentation: |https://django-sysinfo.readthedocs.org/en/latest/ |
+--------------------+---------------+--------------+-------------------------+

.. |master-build| image:: https://secure.travis-ci.org/saxix/django-sysinfo.png?branch=master
:target: http://travis-ci.org/saxix/django-sysinfo/

.. |master-cov| image:: https://codecov.io/github/saxix/django-sysinfo/coverage.svg?branch=master
:target: https://codecov.io/github/saxix/django-sysinfo?branch=master


.. |dev-build| image:: https://secure.travis-ci.org/saxix/django-sysinfo.png?branch=develop
:target: http://travis-ci.org/saxix/django-sysinfo/

.. |dev-cov| image:: https://codecov.io/github/saxix/django-sysinfo/coverage.svg?branch=develop
:target: https://codecov.io/github/saxix/django-sysinfo?branch=develop





=======
History
=======

1.4 (7 Jan 2019)
-----------------
* add filtering to admin page
* fixes sections


1.3.2 (05 Jul 2018)
-----------------
* removes pip dependency


1.3.1 (23 Feb 2018)
-----------------
* add `extra` section to html output
* minor changes to html output


1.3 (10 Feb 2018)
-----------------
* add HTML info page
* Dropped support for old Django (<1.9) versions and Python 2.6
* Django 2.0 support has been added.


1.2 16 Aug 2017
---------------
* fixex python 3.6 compatibility
* new config '_ttl' to set cache max_age attribute


1.1 14 Jul 2017
---------------
* Django 1.11 compatibility
* handle broken database connections
* add new mail server informations
* new 'checks' API
* BACKWARD INCONPATIBLE: new config format


1.0 (15 Mar 2017)
-----------------
* fixes error in json serialization
* BACKWARD INCOMPATIBLE: by default all the sections are disabled
* allow both string and callable in extra section
* added new configuration parameters
* new management command

0.3 (27 Mar 2016)
-----------------
* dropped support Django<1.6
* add `settings.SYSINFO_USERS` to manage access
* default Basic Authentication protected urls
* removed 'sys' prefix from default urlpatterns
* new 'echo' endpoint

0.2 (13 Feb 2016)
-----------------
* add some infos
* output sorted to improve readibility
* add ability to filter sections (?s=os,python)
* add CACHES infos
* removed command line utility


0.1.1 (20 Jan 2016)
-------------------
* improved coverage
* fixes typos in copyright


0.1.0 (15 Jan 2015)
-------------------
* First release on PyPI.

Project details


Download files

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

Files for django-sysinfo, version 1.4
Filename, size File type Python version Upload date Hashes
Filename, size django-sysinfo-1.4.tar.gz (26.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page