django-postgres-metrics

一个暴露大量PostgreSQL数据库指标的Django应用。

背景

在2017年PyCon加拿大会议上，Craig Kerstiens发表了题为"Postgres at any scale"的演讲。在他的演讲中，Craig指出了一些应该关注的指标，以了解为什么PostgreSQL数据库可能会“慢”或未按预期表现。

此项目通过开启is_superusers标志，向Django用户添加了一个Django Admin视图，以公开这些指标。

安装

首先从PyPI安装django-postgres-metrics

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

您还需要确保安装了psycopg2或psycopg，因为Django已经将其作为对PostgreSQL支持的必需要求。

然后，您需要将postgres_metrics添加到您的INSTALLED_APPS列表中。由于django-postgres-metrics的工作方式，您需要在admin应用之前包含它。

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

您还需要确保在 TEMPLATES 设置中包含 request 上下文处理器。对于在 Django 1.8 或更高版本中开始的项目，它默认已包含。

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

最后，您需要在全局 urls.py 中添加一个 URL 路径，在 admin URL 模式之前。

from django.urls import include, path

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

这是一个度量指标可能的样子：

安全性

如果您发现或认为发现了安全漏洞，请通过 info+django-postgres-metrics *at* markusholtermann *dot* eu 联系我们。

我在业余时间处理这个问题。我没有时间24小时监控电子邮件。但您通常应该在一周内收到回复。如果两周内我没有回复您，请再次联系。

贡献

该项目使用 black 和 isort 对其代码进行格式化。使用 flake8 进行代码审查。所有这些都被整合到 pre-commit 中，在每次提交和推送之前运行。要设置它

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

运行单元测试

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