Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/django-postgres-metrics/django-postgres-metrics
A Django application that exposes a bunch of PostgreSQL database metrics.
https://github.com/django-postgres-metrics/django-postgres-metrics
django metrics performance postgresql
Last synced: 2 months ago
JSON representation
A Django application that exposes a bunch of PostgreSQL database metrics.
- Host: GitHub
- URL: https://github.com/django-postgres-metrics/django-postgres-metrics
- Owner: django-postgres-metrics
- License: bsd-3-clause
- Created: 2017-11-19T18:50:42.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T22:07:16.000Z (5 months ago)
- Last Synced: 2024-10-06T03:18:42.978Z (3 months ago)
- Topics: django, metrics, performance, postgresql
- Language: Python
- Homepage: http://django-postgres-metrics.readthedocs.io/
- Size: 368 KB
- Stars: 143
- Watchers: 5
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-django-performance - django-postgres-metrics - A Django application that exposes a bunch of PostgreSQL database metrics. (Monitoring / Tools)
README
# django-postgres-metrics
[](https://github.com/django-postgres-metrics/django-postgres-metrics/actions/workflows/test-deploy.yml?query=event%3Apush+branch%3Amain)
[](https://app.codecov.io/gh/django-postgres-metrics/django-postgres-metrics/branch/main)
[](https://django-postgres-metrics.readthedocs.io/)
[](https://pypi.org/project/django-postgres-metrics/)
[](https://github.com/django-postgres-metrics/django-postgres-metrics/blob/main/setup.py)
[](https://github.com/django-postgres-metrics/django-postgres-metrics/blob/main/setup.py)
A Django application that exposes a bunch of PostgreSQL database metrics.
## Background
At [PyCon Canada 2017](https://2017.pycon.ca/) [Craig Kerstiens](http://www.craigkerstiens.com/)
gave a talk "[Postgres at any scale](https://2017.pycon.ca/schedule/56/)". 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:
```console
(env)$ python -m pip install django-postgres-metrics
```
You will also need to make sure to have `psycopg2` or `psycopg` 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:
```python
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:
```python
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.
```python
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:
## 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 project [black](https://pypi.org/project/black/) and
[isort](https://pypi.org/project/isort/) for formatting its code.
[flake8](https://pypi.org/project/flake8/) is used for linting. All these are
combined into [pre-commit](https://pre-commit.com/) to run before each commit
and push. To set it up:
```console
(env)$ python -m pip install '.[dev,test]'
(env)$ pre-commit install -t pre-commit -t pre-push --install-hooks
```
To run the unit tests:
```console
(env)$ django-admin test -v 2 --settings=tests.settings
```