Skip to main content

A Django app that exposes a bunch of PostgreSQL database metrics.

Project description

django-postgres-metrics

GitHub Workflow Status (branch) Codecov branch PyPI

A Django application that exposes a bunch of PostgreSQL database metrics.

Background

At PyCon Canada 2017 Craig Kerstiens gave a talk "Postgres at any scale". In his talk Craig pointed out a bunch of metrics one should look at to understand why a PostgreSQL database could be "slow" or not perform as expected.

This project adds a Django Admin view exposing these metrics to Django users with the is_superusers flag turned on.

Installation

Start by installing django-postgres-metrics from PyPI:

(env)$ python -m pip install django-postgres-metrics

You will also need to make sure to have psycopg2 installed which is already a requirement by Django for PostgreSQL support anyway.

Then you need to add postgres_metrics to your INSTALLED_APPS list. Due to the way django-postgres-metrics works, you need to include it _before* the admin app:

INSTALLED_APPS = [
    'postgres_metrics.apps.PostgresMetrics',
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

You also need to make sure that the request context processor is included in the TEMPLATES setting. It is included by default for projects that were started on Django 1.8 or later:

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'OPTIONS': {
            'context_processors': [
                ...,
                'django.template.context_processors.request',
                ...,
            ],
        },
    },
]

Lastly, you need to add a URL path to your global urls.py before the admin URL patterns.

For Django 2.0 and up:

from django.urls import include, path

urlpatterns = [
    path('admin/postgres-metrics/', include('postgres_metrics.urls')),
    path('admin/', admin.site.urls),
]

This is what a metric could look like: Metric example

Security

If you found or if you think you found a security issue please get in touch via info+django-postgres-metrics *AT* markusholtermann *DOT* eu.

I'm working about this in my free time. I don't have time to monitor the email 24/7. But you should normally receive a response within a week. If I haven't got back to you within 2 weeks, please reach out again.

Contributing

The uses pre-commit for linting and formatting of source code:

(env)$ python -m pip install '.[dev,test]'
(env)$ pre-commit install -t pre-commit -t pre-push --install-hooks

To run the unit tests:

(env)$ django-admin.py test -v 2 --settings=tests.settings

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

django-postgres-metrics-0.8.0.tar.gz (110.3 kB view details)

Uploaded Source

Built Distribution

django_postgres_metrics-0.8.0-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file django-postgres-metrics-0.8.0.tar.gz.

File metadata

  • Download URL: django-postgres-metrics-0.8.0.tar.gz
  • Upload date:
  • Size: 110.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.9.1

File hashes

Hashes for django-postgres-metrics-0.8.0.tar.gz
Algorithm Hash digest
SHA256 5de99b1fac11e3a3d71a4f4fccd953376fb8b2746d257a3ae8c395a2290fa403
MD5 d4064cb8e468e216bf87064eb2ed4d8a
BLAKE2b-256 f8652948cf6d6298f5ec20318003d155b4c0b203d6f8106a0a8f63e428b965d7

See more details on using hashes here.

Provenance

File details

Details for the file django_postgres_metrics-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: django_postgres_metrics-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.9.1

File hashes

Hashes for django_postgres_metrics-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 18f87521655f3177c315f9cfd1756dbab2007e979d140e492ebfafb9be8eb058
MD5 88dc2c9000112e4be8cb7ec016eea636
BLAKE2b-256 949d44b2f302a354df4e286a21587ed7f739b32e125912645d1c7baa66431fe7

See more details on using hashes here.

Provenance

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