Welcome to django-sysinfo’s documentation!¶

Contents:

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
Development
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/

Installation methods¶

Note: It is recommended that you always use the latest release of django-sysinfo with the latest release of Django. If you are using an older version of Django, then please check out the Compatible Django Versions page for more information.

For information on configuring django-sysinfo, see the getting started guide.

pip¶

You can install django-sysinfo into your system, or virtual environment, by running the following command in a terminal:

$ pip install django-sysinfo

easy_install¶

The popular easy_install utility can be used to install the latest django-sysinfo release from the Python Package Index. Simply run the following command in a terminal:

$ sudo easy_install django-sysinfo

Git¶

Using Git to install django-sysinfo provides an easy way of upgrading your installation at a later date. Simply clone the public git repository and symlink the src/sysinfo directory into your PYTHONPATH:

$ git clone git://github.com/etianen/django-sysinfo.git
$ cd django-sysinfo.git
$ git checkout release-1.9.3
$ ln -s src/sysinfo /your/pythonpath/location/sysinfo

Configuration¶

Configure¶

It possible to include/exclude each session, custom callable and add checks available thru the check url

SYSINFO =  {"os": False,
            "modules": False,
            "python": False,
            "host": False,
            "extra": {},
            "checks": {},
            "project": {
                "mail": False,
                "installed_apps": False,
                "databases": False,
                "MEDIA_ROOT": False,
                "STATIC_ROOT": False,
                "CACHES": False}
            }

Sections¶

Host¶

"host": {
  "hostname": "host1",
  "fqdn": "host1.org",
  "cpus": 4,
  "network": {
    "en0": [
      "192.168.1.100/255.255.255.0"
    ],
    "lo0": [
      "127.0.0.1/255.0.0.0",
      "192.168.66.66/None"
    ]
  },
  "memory": {
    "percent": "74.5 bytes",
    "used": "5.0 GB",
    "available": "2.0 GB",
    "free": "64.0 MB",
    "total": "8.0 GB"
  }
}

OS¶

"os": {
  "uname": [
    "Darwin",
    "host1.local",
    "16.4.0",
    "Darwin Kernel Version 16.4.0: Thu Dec 22 22:53:21 PST 2016; root:xnu-3789.41.3~3/RELEASE_X86_64",
    "x86_64"
  ],
  "name": "posix"
},

Python¶

"python": {
  "executable": "/data/VENV/si/bin/python",
  "version": "2.7.13",
  "platform": "darwin",
  "info": "2.7.13 (default, Mar 10 2017, 12:55:49) \n[GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]",
  "maxunicode": [
    65535,
    "WARN"
  ]
},

Modules¶

"modules": {"alabaster": "0.7.7",
             "apipkg": "1.4",
             "django": "1.9.1",
             "pytest": "2.8.5",
             "xlwt-future": "0.8.0"},

Project¶

"project": {
  "current_dir": "/data/PROJECTS/django-sysinfo",
  "tempdir": "/var/folders/vy/jjqmc4bj38z2rj90qzhwsczw0000gn/T",
},

installed_apps¶

"installed_apps": [
  [
    "django_sysinfo",
    "0.4a20160403211457"
  ]
]

MEDIA_ROOT¶

"MEDIA_ROOT": {
  "path": "/data/PROJECTS/django-sysinfo/tests/demo/demoproject/media",
  "disk": {
    "used": "288.0 GB",
    "free": "176.0 GB",
    "total": "464.0 GB"
  }
},

STATIC_ROOT¶

"STATIC_ROOT": {
  "path": "/data/PROJECTS/django-sysinfo/tests/demo/demoproject/static",
  "disk": {
    "used": "288.0 GB",
    "free": "176.0 GB",
    "total": "464.0 GB"
  }
},

CACHES¶

"CACHES": {
  "default": {
    "LOCATION": "unique-snowflake",
    "BACKEND": "django.core.cache.backends.dummy.DummyCache"
  }
},

Databases¶

"databases": {"default": {"engine": "django.db.backends.postgresql_psycopg2",
                             "host": "127.0.0.1:",
                             "name": "sysinfo",
                             "server": "PostgreSQL 9.4.3 on x86_64-apple-darwin14.3.0, compiled by Apple LLVM version 6.1.0 (clang-602.0.53) (based on LLVM 3.6.0svn), 64-bit",
                             "timezone": "UTC",
                             "version": "9.4.3"},
                "sqlite": {"engine": "django.db.backends.sqlite3",
                            "host": ":",
                            "name": ":memory:",
                            "server": "3.8.10.2",
                            "timezone": "UTC",
                            "version": "3.8.10.2"}},

Mail¶

"mail" : {"backend": "django.core.mail.backends.locmem.EmailBackend",
          "host", "localhost:25",
          "tls", "false",
          "ssl": "false",
          "status": "OK"}

EXTRA¶

New entries can be added using the extra entry in the configuration.

in your settings

SYSINFO = {"extra": { "my-entry", "path.to.myfunc"}

in your path.to package

def myfunc(request):
    return "this is my complex function"

result

"extra" : {"my-entry": "this is my complex function"}

Sample output¶

JSON¶

{
  "host": {
    "hostname": "host1",
    "fqdn": "host1.org",
    "cpus": 4,
    "network": {
      "en0": [
        "192.168.1.100/255.255.255.0"
      ],
      "lo0": [
        "127.0.0.1/255.0.0.0",
        "192.168.66.66/None"
      ]
    },
    "memory": {
      "percent": "74.5 bytes",
      "used": "5.0 GB",
      "available": "2.0 GB",
      "free": "64.0 MB",
      "total": "8.0 GB"
    }
  },
  "os": {
    "uname": [
      "Darwin",
      "host1.local",
      "16.4.0",
      "Darwin Kernel Version 16.4.0: Thu Dec 22 22:53:21 PST 2016; root:xnu-3789.41.3~3/RELEASE_X86_64",
      "x86_64"
    ],
    "name": "posix"
  },
  "python": {
    "executable": "/data/VENV/si/bin/python",
    "version": "2.7.13",
    "platform": "darwin",
    "info": "2.7.13 (default, Mar 10 2017, 12:55:49) \n[GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]",
    "maxunicode": [
      65535,
      "WARN"
    ],
    "modules": {
      "alabaster": "0.7.7",
      "apipkg": "1.4",
      "django": "1.9.1",
      "pytest": "2.8.5",
      "xlwt-future": "0.8.0"
    }
  },
  "project": {
    "current_dir": "/data/PROJECTS/django-sysinfo",
    "tempdir": "/var/folders/vy/jjqmc4bj38z2rj90qzhwsczw0000gn/T",
    "MEDIA_ROOT": {
      "path": "/data/PROJECTS/django-sysinfo/tests/demo/demoproject/media",
      "disk": {
        "used": "288.0 GB",
        "free": "176.0 GB",
        "total": "464.0 GB"
      }
    },
    "STATIC_ROOT": {
      "path": "/data/PROJECTS/django-sysinfo/tests/demo/demoproject/static",
      "disk": {
        "used": "288.0 GB",
        "free": "176.0 GB",
        "total": "464.0 GB"
      }
    },
    "CACHES": {
      "default": {
        "LOCATION": "unique-snowflake",
        "BACKEND": "django.core.cache.backends.dummy.DummyCache"
      }
    },
    "installed_apps": [
      [
        "django_sysinfo", "0.4a20160403211457"
      ]
    ]
  },
  "databases": {
    "default": {
      "engine": "django.db.backends.postgresql_psycopg2",
      "host": "127.0.0.1:",
      "name": "sysinfo",
      "version": "9.6.1",
      "encoding": "UTF8",
      "collate": "en_US.UTF-8",
      "ctype": "en_US.UTF-8",
      "isolation_level": null,
      "timezone": "UTC",
      "info": "PostgreSQL 9.6.1 on x86_64-apple-darwin15.6.0, compiled by Apple LLVM version 8.0.0 (clang-800.0.42.1), 64-bit"
    },
    "sqlite": {
      "engine": "django.db.backends.sqlite3",
      "host": ":",
      "name": ":memory:",
      "version": "3.14.0"
    }
  }
}

HTML¶

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/saxix/django-sysinfo/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

django-sysinfo could always use more documentation, whether as part of the official django-sysinfo docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/saxix/django-sysinfo/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up django-sysinfo for local development.

Fork the django-sysinfo repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/django-sysinfo.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv django-sysinfo
$ cd django-sysinfo/
$ make develop
```

Create a branch for local development:

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

$ make qa
$ py.test tests
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.7, and 3.5, and for PyPy. Check https://travis-ci.org/saxix/django-sysinfo/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ py.test tests/<test_filename>::<test_name>>

Credits¶

Development Lead¶

Stefano Apostolico <s.apostolico@gmail.com>

Contributors¶

None yet. Why not be the first?

History¶

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.