Can't Help Falling in Love
Remembering Helps Me to Forget
Helplessly, Hopelessly
Love Helps Those
I Need a Little Help
For a while We Helped Each Other Out
Give Me a Helping Hand
I Can't Help You, I'm Falling Too
How Can I Help You Say Goodbye?
Time Hasn't Helped
Jukebox, Help Me Find My Baby
I Just Can't Help Myself
Help Me, Girl
I Can't Help it
Help Somebody
Help, Help
I Can't Help How I Feel
No Help From Me
I Can Help
Somebody Help Me
Please Help Me I'm Falling in Love With You
Help Yourself
Outside Help
Helping Hand
Help Me, Rhonda
Can't Help Feeling So Blue
We All Agreed to Help
Help Pour Out the Rain (Lacey's Song)
Sleep Won't Help Me
I Can't Help Myself (Sugarpie, Honeybunch)
Cry for Help
She's Helping Me Get Over You
Mama Help Me
Help Yourself to Me
Can't Help But Wonder
Heaven Help the Working Girl
Help Me Pick Up the Pieces
Crying Won't Help Now
I Couldn't Help Myself
So Help Me, Girl
Heaven Help the Fool
Help Wanted
Help Me Get Over You
Helpless
Help
Can't Help it
Can't Help Calling Your Name
If She Just Helps Me Get Over You
Helpless Heart
No Help Wanted
It Didn't Help Much
Help Me Make it Through the Night
Help Me Understand
I Just Can't Help Believing
Can't Help Thinking About Me
How Could I Help But Love You?
Heaven Help My Heart
I Can't Help Remembering You
Help Me Hold on
Helping Me Get Over You
I Can't Help it if I'm Still in Love with You
Girl Can't Help it, The
I Can't Help it, I'm Falling in Love
With a Little Help from My Friends
Heaven Help the Child
Help Me
Can't Help But Love You
Help is on the Way
I Got Some Help I Don't Need
Heaven Help Us All
Heaven Help Me
Helplessly Hoping
django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/templates/index.html 0000664 0000000 0000000 00000000023 15026774211 0031022 0 ustar 00root root 0000000 0000000 This is the index. django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/templates/lawn.html 0000664 0000000 0000000 00000000105 15026774211 0030655 0 ustar 00root root 0000000 0000000Aaah, {{ lawn.location }}, the best place on Earth, probably.
django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/templates/slow.html 0000664 0000000 0000000 00000004252 15026774211 0030707 0 ustar 00root root 0000000 0000000
_.---"'"""""'`--.._
_,.-' `-._
_,." -.
.-"" ___...---------.._ `.
`---'"" `-. `.
`. \
`. \
\ \
. \
| .
| |
_________ | |
_,.-'" `"'-.._ : |
_,-' `-._.' |
_.' `. '
_.-. _,+......__ `. .
.' `-"' `"-.,-""--._ \ /
/ ,' | __ \ \ /
` .. +" ) \ \ /
`.' \ ,-"`-.. | | \ /
/ " | .' \ '. _.' .'
|,.."--"""--..| " | `""`. |
," `-._ | | |
.' `-._+ | |
/ `. / |
| ` ' | / |
`-.....--.__ | | / |
`./ "| / `-.........--.- ' | ,' '
/| || `.' ,' .' |_,-+ /
/ ' '.`. _,' ,' `. | ' _,.. /
/ `. `"'"'""'" _,^--------"`. | `.'_ _/
/... _.`:.________,.' `._,.-..| "'
`.__.' `._ /
"' mh
Art by Maija Haavisto
django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/templates/sql.html 0000664 0000000 0000000 00000001244 15026774211 0030520 0 ustar 00root root 0000000 0000000
Execute some SQL here, for fun and profit!
Note that this is a very bad vulnerability: it gives anyone direct access to your whole database. This only exists to test that django_prometheus is working.
{% if query %}Your query was:
{{ query }}
Your results were:
{{ rows }}
{% endif %}
django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/test_caches.py 0000664 0000000 0000000 00000006623 15026774211 0027702 0 ustar 00root root 0000000 0000000 import pytest
from django.core.cache import caches
from redis import RedisError
from django_prometheus.testutils import assert_metric_equal, get_metric
_SUPPORTED_CACHES = [
"memcached.PyLibMCCache",
"memcached.PyMemcacheCache",
"filebased",
"locmem",
"native_redis",
"redis",
]
class TestCachesMetrics:
"""Test django_prometheus.caches metrics."""
@pytest.mark.parametrize("supported_cache", _SUPPORTED_CACHES)
def test_counters(self, supported_cache):
# Note: those tests require a memcached server running
tested_cache = caches[supported_cache]
backend = supported_cache.split(".")[0]
total_before = get_metric("django_cache_get_total", backend=backend) or 0
hit_before = get_metric("django_cache_get_hits_total", backend=backend) or 0
miss_before = get_metric("django_cache_get_misses_total", backend=backend) or 0
tested_cache.set("foo1", "bar")
tested_cache.get("foo1")
tested_cache.get("foo1")
tested_cache.get("foofoo")
result = tested_cache.get("foofoo", default="default")
assert result == "default"
assert_metric_equal(total_before + 4, "django_cache_get_total", backend=backend)
assert_metric_equal(hit_before + 2, "django_cache_get_hits_total", backend=backend)
assert_metric_equal(
miss_before + 2,
"django_cache_get_misses_total",
backend=backend,
)
def test_redis_cache_fail(self):
# Note: test use fake service config (like if server was stopped)
supported_cache = "redis"
total_before = get_metric("django_cache_get_total", backend=supported_cache) or 0
fail_before = get_metric("django_cache_get_fail_total", backend=supported_cache) or 0
hit_before = get_metric("django_cache_get_hits_total", backend=supported_cache) or 0
miss_before = get_metric("django_cache_get_misses_total", backend=supported_cache) or 0
tested_cache = caches["stopped_redis_ignore_exception"]
tested_cache.get("foo1")
assert_metric_equal(hit_before, "django_cache_get_hits_total", backend=supported_cache)
assert_metric_equal(miss_before, "django_cache_get_misses_total", backend=supported_cache)
assert_metric_equal(total_before + 1, "django_cache_get_total", backend=supported_cache)
assert_metric_equal(fail_before + 1, "django_cache_get_fail_total", backend=supported_cache)
tested_cache = caches["stopped_redis"]
with pytest.raises(RedisError):
tested_cache.get("foo1")
assert_metric_equal(hit_before, "django_cache_get_hits_total", backend=supported_cache)
assert_metric_equal(miss_before, "django_cache_get_misses_total", backend=supported_cache)
assert_metric_equal(total_before + 2, "django_cache_get_total", backend=supported_cache)
assert_metric_equal(fail_before + 2, "django_cache_get_fail_total", backend=supported_cache)
@pytest.mark.parametrize("supported_cache", _SUPPORTED_CACHES)
def test_cache_version_support(self, supported_cache):
# Note: those tests require a memcached server running
tested_cache = caches[supported_cache]
tested_cache.set("foo1", "bar v.1", version=1)
tested_cache.set("foo1", "bar v.2", version=2)
assert tested_cache.get("foo1", version=1) == "bar v.1"
assert tested_cache.get("foo1", version=2) == "bar v.2"
django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/test_db.py 0000664 0000000 0000000 00000015744 15026774211 0027045 0 ustar 00root root 0000000 0000000 import pytest
from django.conf import settings
from django.db import connections
from django_prometheus.testutils import (
assert_metric_compare,
assert_metric_diff,
assert_metric_equal,
get_metric,
save_registry,
)
# @pytest.fixture(autouse=True)
# def enable_db_access_for_all_tests(db):
# pass
@pytest.mark.django_db(databases=list(settings.DATABASES.keys()))
class BaseDBTest:
pass
@pytest.mark.skipif(connections["test_db_1"].vendor != "sqlite", reason="Skipped unless test_db_1 uses sqlite")
class TestDbMetrics(BaseDBTest):
"""Test django_prometheus.db metrics.
Note regarding the values of metrics: many tests interact with the
database, and the test runner itself does. As such, tests that
require that a metric has a specific value are at best very
fragile. Consider asserting that the value exceeds a certain
threshold, or check by how much it increased during the test.
"""
def test_config_has_expected_databases(self):
"""Not a real unit test: ensures that testapp.settings contains the
databases this test expects.
"""
assert "default" in connections.databases.keys()
assert "test_db_1" in connections.databases.keys()
assert "test_db_2" in connections.databases.keys()
def test_counters(self):
cursor_db1 = connections["test_db_1"].cursor()
cursor_db2 = connections["test_db_2"].cursor()
cursor_db1.execute("SELECT 1")
for _ in range(200):
cursor_db2.execute("SELECT 2")
cursor_db1.execute("SELECT 3")
try:
cursor_db1.execute("this is clearly not valid SQL")
except Exception:
pass
assert_metric_equal(
1,
"django_db_errors_total",
alias="test_db_1",
vendor="sqlite",
type="OperationalError",
)
assert get_metric("django_db_execute_total", alias="test_db_1", vendor="sqlite") > 0
assert get_metric("django_db_execute_total", alias="test_db_2", vendor="sqlite") >= 200
def test_histograms(self):
cursor_db1 = connections["test_db_1"].cursor()
cursor_db2 = connections["test_db_2"].cursor()
cursor_db1.execute("SELECT 1")
for _ in range(200):
cursor_db2.execute("SELECT 2")
assert (
get_metric(
"django_db_query_duration_seconds_count",
alias="test_db_1",
vendor="sqlite",
)
> 0
)
assert (
get_metric(
"django_db_query_duration_seconds_count",
alias="test_db_2",
vendor="sqlite",
)
>= 200
)
def test_execute_many(self):
registry = save_registry()
cursor_db1 = connections["test_db_1"].cursor()
cursor_db1.executemany(
"INSERT INTO testapp_lawn(location) VALUES (?)",
[("Paris",), ("New York",), ("Berlin",), ("San Francisco",)],
)
assert_metric_diff(
registry,
4,
"django_db_execute_many_total",
alias="test_db_1",
vendor="sqlite",
)
@pytest.mark.skipif("postgresql" not in connections, reason="Skipped unless postgresql database is enabled")
class TestPostgresDbMetrics(BaseDBTest):
"""Test django_prometheus.db metrics for postgres backend.
Note regarding the values of metrics: many tests interact with the
database, and the test runner itself does. As such, tests that
require that a metric has a specific value are at best very
fragile. Consider asserting that the value exceeds a certain
threshold, or check by how much it increased during the test.
"""
def test_counters(self):
registry = save_registry()
cursor = connections["postgresql"].cursor()
for _ in range(20):
cursor.execute("SELECT 1")
assert_metric_compare(
registry,
lambda a, b: a + 20 <= b < a + 25,
"django_db_execute_total",
alias="postgresql",
vendor="postgresql",
)
@pytest.mark.skipif("mysql" not in connections, reason="Skipped unless mysql database is enabled")
class TestMysDbMetrics(BaseDBTest):
"""Test django_prometheus.db metrics for mys backend.
Note regarding the values of metrics: many tests interact with the
database, and the test runner itself does. As such, tests that
require that a metric has a specific value are at best very
fragile. Consider asserting that the value exceeds a certain
threshold, or check by how much it increased during the test.
"""
def test_counters(self):
registry = save_registry()
cursor = connections["mysql"].cursor()
for _ in range(20):
cursor.execute("SELECT 1")
assert_metric_compare(
registry,
lambda a, b: a + 20 <= b < a + 25,
"django_db_execute_total",
alias="mysql",
vendor="mysql",
)
@pytest.mark.skipif("postgis" not in connections, reason="Skipped unless postgis database is enabled")
class TestPostgisDbMetrics(BaseDBTest):
"""Test django_prometheus.db metrics for postgis backend.
Note regarding the values of metrics: many tests interact with the
database, and the test runner itself does. As such, tests that
require that a metric has a specific value are at best very
fragile. Consider asserting that the value exceeds a certain
threshold, or check by how much it increased during the test.
"""
def test_counters(self):
r = save_registry()
cursor = connections["postgis"].cursor()
for _ in range(20):
cursor.execute("SELECT 1")
assert_metric_compare(
r,
lambda a, b: a + 20 <= b < a + 25,
"django_db_execute_total",
alias="postgis",
vendor="postgresql",
)
@pytest.mark.skipif("spatialite" not in connections, reason="Skipped unless spatialite database is enabled")
class TestSpatialiteDbMetrics(BaseDBTest):
"""Test django_prometheus.db metrics for spatialite backend.
Note regarding the values of metrics: many tests interact with the
database, and the test runner itself does. As such, tests that
require that a metric has a specific value are at best very
fragile. Consider asserting that the value exceeds a certain
threshold, or check by how much it increased during the test.
"""
def test_counters(self):
r = save_registry()
connection = connections["spatialite"]
# Make sure the extension is loaded and geospatial tables are created
connection.prepare_database()
cursor = connection.cursor()
for _ in range(20):
cursor.execute("SELECT 1")
assert_metric_compare(
r,
lambda a, b: a + 20 <= b < a + 25,
"django_db_execute_total",
alias="spatialite",
vendor="sqlite",
)
django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/test_middleware.py 0000664 0000000 0000000 00000011605 15026774211 0030565 0 ustar 00root root 0000000 0000000 import pytest
from django_prometheus.testutils import (
assert_metric_diff,
assert_metric_equal,
save_registry,
)
from testapp.views import ObjectionException
def M(metric_name):
"""Makes a full metric name from a short metric name.
This is just intended to help keep the lines shorter in test
cases.
"""
return f"django_http_{metric_name}"
def T(metric_name):
"""Makes a full metric name from a short metric name like M(metric_name)
This method adds a '_total' postfix for metrics.
"""
return f"{M(metric_name)}_total"
class TestMiddlewareMetrics:
"""Test django_prometheus.middleware.
Note that counters related to exceptions can't be tested as
Django's test Client only simulates requests and the exception
handling flow is very different in that simulation.
"""
@pytest.fixture(autouse=True)
def _setup(self, settings):
settings.PROMETHEUS_LATENCY_BUCKETS = (0.05, 1.0, 2.0, 4.0, 5.0, 10.0, float("inf"))
def test_request_counters(self, client):
registry = save_registry()
client.get("/")
client.get("/")
client.get("/help")
client.post("/", {"test": "data"})
assert_metric_diff(registry, 4, M("requests_before_middlewares_total"))
assert_metric_diff(registry, 4, M("responses_before_middlewares_total"))
assert_metric_diff(registry, 3, T("requests_total_by_method"), method="GET")
assert_metric_diff(registry, 1, T("requests_total_by_method"), method="POST")
assert_metric_diff(registry, 4, T("requests_total_by_transport"), transport="http")
assert_metric_diff(
registry,
2,
T("requests_total_by_view_transport_method"),
view="testapp.views.index",
transport="http",
method="GET",
)
assert_metric_diff(
registry,
1,
T("requests_total_by_view_transport_method"),
view="testapp.views.help",
transport="http",
method="GET",
)
assert_metric_diff(
registry,
1,
T("requests_total_by_view_transport_method"),
view="testapp.views.index",
transport="http",
method="POST",
)
# We have 3 requests with no post body, and one with a few
# bytes, but buckets are cumulative so that is 4 requests with
# <=128 bytes bodies.
assert_metric_diff(registry, 3, M("requests_body_total_bytes_bucket"), le="0.0")
assert_metric_diff(registry, 4, M("requests_body_total_bytes_bucket"), le="128.0")
assert_metric_equal(None, M("responses_total_by_templatename"), templatename="help.html")
assert_metric_diff(registry, 3, T("responses_total_by_templatename"), templatename="index.html")
assert_metric_diff(registry, 4, T("responses_total_by_status"), status="200")
assert_metric_diff(registry, 0, M("responses_body_total_bytes_bucket"), le="0.0")
assert_metric_diff(registry, 3, M("responses_body_total_bytes_bucket"), le="128.0")
assert_metric_diff(registry, 4, M("responses_body_total_bytes_bucket"), le="8192.0")
assert_metric_diff(registry, 4, T("responses_total_by_charset"), charset="utf-8")
assert_metric_diff(registry, 0, M("responses_streaming_total"))
def test_latency_histograms(self, client):
# Caution: this test is timing-based. This is not ideal. It
# runs slowly (each request to /slow takes at least .1 seconds
# to complete), to eliminate flakiness we adjust the buckets used
# in the test suite.
registry = save_registry()
# This always takes more than .1 second, so checking the lower
# buckets is fine.
client.get("/slow")
assert_metric_diff(
registry,
0,
M("requests_latency_seconds_by_view_method_bucket"),
le="0.05",
view="slow",
method="GET",
)
assert_metric_diff(
registry,
1,
M("requests_latency_seconds_by_view_method_bucket"),
le="5.0",
view="slow",
method="GET",
)
def test_exception_latency_histograms(self, client):
registry = save_registry()
try:
client.get("/objection")
except ObjectionException:
pass
assert_metric_diff(
registry,
2,
M("requests_latency_seconds_by_view_method_bucket"),
le="2.5",
view="testapp.views.objection",
method="GET",
)
def test_streaming_responses(self, client):
registry = save_registry()
client.get("/")
client.get("/file")
assert_metric_diff(registry, 1, M("responses_streaming_total"))
assert_metric_diff(registry, 1, M("responses_body_total_bytes_bucket"), le="+Inf")
django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/test_middleware_custom_labels.py 0000664 0000000 0000000 00000007364 15026774211 0033510 0 ustar 00root root 0000000 0000000 import pytest
from prometheus_client import REGISTRY
from prometheus_client.metrics import MetricWrapperBase
from django_prometheus.middleware import (
Metrics,
PrometheusAfterMiddleware,
PrometheusBeforeMiddleware,
)
from django_prometheus.testutils import assert_metric_diff, save_registry
from testapp.helpers import get_middleware
from testapp.test_middleware import M, T
EXTENDED_METRICS = [
M("requests_latency_seconds_by_view_method"),
M("responses_total_by_status_view_method"),
]
class CustomMetrics(Metrics):
def register_metric(self, metric_cls, name, documentation, labelnames=(), **kwargs):
if name in EXTENDED_METRICS:
labelnames.extend(("view_type", "user_agent_type"))
return super().register_metric(metric_cls, name, documentation, labelnames=labelnames, **kwargs)
class AppMetricsBeforeMiddleware(PrometheusBeforeMiddleware):
metrics_cls = CustomMetrics
class AppMetricsAfterMiddleware(PrometheusAfterMiddleware):
metrics_cls = CustomMetrics
def label_metric(self, metric, request, response=None, **labels):
new_labels = labels
if metric._name in EXTENDED_METRICS:
new_labels = {"view_type": "foo", "user_agent_type": "browser"}
new_labels.update(labels)
return super().label_metric(metric, request, response=response, **new_labels)
class TestMiddlewareMetricsWithCustomLabels:
@pytest.fixture(autouse=True)
def _setup(self, settings):
settings.MIDDLEWARE = get_middleware(
"testapp.test_middleware_custom_labels.AppMetricsBeforeMiddleware",
"testapp.test_middleware_custom_labels.AppMetricsAfterMiddleware",
)
# Allow CustomMetrics to be used
for metric in Metrics._instance.__dict__.values():
if isinstance(metric, MetricWrapperBase):
REGISTRY.unregister(metric)
Metrics._instance = None
def test_request_counters(self, client):
registry = save_registry()
client.get("/")
client.get("/")
client.get("/help")
client.post("/", {"test": "data"})
assert_metric_diff(registry, 4, M("requests_before_middlewares_total"))
assert_metric_diff(registry, 4, M("responses_before_middlewares_total"))
assert_metric_diff(registry, 3, T("requests_total_by_method"), method="GET")
assert_metric_diff(registry, 1, T("requests_total_by_method"), method="POST")
assert_metric_diff(registry, 4, T("requests_total_by_transport"), transport="http")
assert_metric_diff(
registry,
2,
T("requests_total_by_view_transport_method"),
view="testapp.views.index",
transport="http",
method="GET",
)
assert_metric_diff(
registry,
1,
T("requests_total_by_view_transport_method"),
view="testapp.views.help",
transport="http",
method="GET",
)
assert_metric_diff(
registry,
1,
T("requests_total_by_view_transport_method"),
view="testapp.views.index",
transport="http",
method="POST",
)
assert_metric_diff(
registry,
2.0,
T("responses_total_by_status_view_method"),
status="200",
view="testapp.views.index",
method="GET",
view_type="foo",
user_agent_type="browser",
)
assert_metric_diff(
registry,
1.0,
T("responses_total_by_status_view_method"),
status="200",
view="testapp.views.help",
method="GET",
view_type="foo",
user_agent_type="browser",
)
django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/test_migrations.py 0000664 0000000 0000000 00000002443 15026774211 0030624 0 ustar 00root root 0000000 0000000 from unittest.mock import MagicMock
import pytest
from django_prometheus.migrations import ExportMigrationsForDatabase
from django_prometheus.testutils import assert_metric_equal
def M(metric_name):
"""Make a full metric name from a short metric name.
This is just intended to help keep the lines shorter in test
cases.
"""
return f"django_migrations_{metric_name}"
@pytest.mark.django_db
class TestMigrations:
"""Test migration counters."""
def test_counters(self):
executor = MagicMock()
executor.migration_plan = MagicMock()
executor.migration_plan.return_value = set()
executor.loader.applied_migrations = {"a", "b", "c"}
ExportMigrationsForDatabase("fakedb1", executor)
assert executor.migration_plan.call_count == 1
executor.migration_plan = MagicMock()
executor.migration_plan.return_value = {"a"}
executor.loader.applied_migrations = {"b", "c"}
ExportMigrationsForDatabase("fakedb2", executor)
assert_metric_equal(3, M("applied_total"), connection="fakedb1")
assert_metric_equal(0, M("unapplied_total"), connection="fakedb1")
assert_metric_equal(2, M("applied_total"), connection="fakedb2")
assert_metric_equal(1, M("unapplied_total"), connection="fakedb2")
django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/test_models.py 0000664 0000000 0000000 00000003171 15026774211 0027732 0 ustar 00root root 0000000 0000000 import pytest
from django_prometheus.testutils import assert_metric_diff, save_registry
from testapp.models import Dog, Lawn
def M(metric_name):
"""Make a full metric name from a short metric name.
This is just intended to help keep the lines shorter in test
cases.
"""
return f"django_model_{metric_name}"
@pytest.mark.django_db
class TestModelMetrics:
"""Test django_prometheus.models."""
def test_counters(self):
registry = save_registry()
cool = Dog()
cool.name = "Cool"
cool.save()
assert_metric_diff(registry, 1, M("inserts_total"), model="dog")
elysees = Lawn()
elysees.location = "Champs Elysees, Paris"
elysees.save()
assert_metric_diff(registry, 1, M("inserts_total"), model="lawn")
assert_metric_diff(registry, 1, M("inserts_total"), model="dog")
galli = Dog()
galli.name = "Galli"
galli.save()
assert_metric_diff(registry, 2, M("inserts_total"), model="dog")
cool.breed = "Wolfhound"
assert_metric_diff(registry, 2, M("inserts_total"), model="dog")
cool.save()
assert_metric_diff(registry, 2, M("inserts_total"), model="dog")
assert_metric_diff(registry, 1, M("updates_total"), model="dog")
cool.age = 9
cool.save()
assert_metric_diff(registry, 2, M("updates_total"), model="dog")
cool.delete() # :(
assert_metric_diff(registry, 2, M("inserts_total"), model="dog")
assert_metric_diff(registry, 2, M("updates_total"), model="dog")
assert_metric_diff(registry, 1, M("deletes_total"), model="dog")
django-prometheus-2.4.1/django_prometheus/tests/end2end/testapp/urls.py 0000664 0000000 0000000 00000000704 15026774211 0026374 0 ustar 00root root 0000000 0000000 from django.contrib import admin
from django.urls import include, path
from testapp import views
urlpatterns = [
path("", views.index),
path("help", views.help),
path("slow", views.slow, name="slow"),
path("objection", views.objection),
path("sql", views.sql),
path("newlawn/EqꮙLq5USk\pƎ}ǒNFGƴ`
gƏn.#+,8qἑ H|7~dI.Ҿ%5>X @[OyǾ ^ EX6U@3WXgH2ѯ7 c> jQjX[
D$fUcJZ_iSClR̻ w[!j6t$u OsxWuL&y LA$qO=#<7= Խϛ¿#yiz 9_zi$tsme7{jGf@Z^ܣ {1 GKǍ$A[iǣǟz{o2Y Jk5z,LΚ{W( 0>L^e6G굚{-EkcMOi@ATHk e^4Xzio˔KZ۞yh` = >AnE֤ ^k g_{{m#Ɨ^IR`7ި P |46xx} rj2~-b "*lA_ ^ }qR!f3⣍ 15Ï 4_ei@ ,&g: IDAT"Dž$A[h3w a =~E =/ }P ̎ Z( _xoF~iw} S z,ɬ \fw>\WW}uuuu= ?źn_ak]
ror{ &h1Ү9<<ٛX r+@ks Vk+ =#v H8Z{s-ezyf؏;D^y鮺 xD{$}O=:Fڇ# 5 A PT[Z.UW V= m4 z]M=ٷgeEFz_D ?ϟ%55 wI ۍN CCu"7NjRcK5Z- `zj^J @ZRYS#vjU^cPl ֫f mIQs' {myς֩٤AᚑW o}P]Y h#>Tj-p0E%ȾW {]YTYS]B{IHd|$;nӮ1⋚ڠ|`01Zg}YE,(?`>#z?MTjo}/ ػjzx =#f/@NIumCI]KAx H3 Rquzʃdi0Uy۟?oP8 O +W * `i &-]=ыxʢ"Up
J x)
(K ^xģ ]A F ,F@[P B_P gͤ}
嵥* t9+ JE~B%'tvE5_ zIwvgJ闪J)K =qw}#Ǭ `#4(w 4wLRQ IS>uMOE<A4a
Tj-[{:
K]o1>2 O [GT
Ͻب/S_hzVT =~k" KM @X
ཹ㢯dMAi "f L|d"xs" ] (1|$4^oH'H"~NIw;{Ύ̎}Ok+;}dXh# $Ѿ̀ΌQfiڷL_|wǥ4ݶ p .?>n[w;ڹZ=io^-NZ.0IR'6
o#;Ez
NKyO >|?E[1)Ro[ K xEz?ڻZ{qǤ{a a e'(gknXv}{qn7m @MվNR{?Np|LaiYI|1ϴrI Ik%?aqhNsxJ\FyR8188N - @|1*e0,0 t r u
f+M 'SaiYI?1ϴrI I+-.1L+xpr*x 'xqqك{W (IQ$Yd)wO NkbsynEgǦb vKilYY '| <%}}}=; "38\Z`@gYrc[cKRX
IމRe?ROII]bL0R.)k+P9U|z<n.t-
Bq3=wt?7 3h%mYYJ3E<$_|a6S;)e}9صv}z䍧G:O
^y7s#T<,b00$^-A iuIg ԗv jϠ`0 ht0پ>9h: G Q "":cet(*˒|$ HO/JXꉰ+ )]b&G&1%35g--JiCؚ59]8coLgwIgk+ht2S뗗dN>
]ZlARV`~~> BzخR}AjԄ 7m[i bgO}>6obv5< ]=KR>A[#&I$L+;(<}Ž˾>MHK
Qki>QoD1KӾfM5o > |sw-@~|wǥ4ݶT|o%އN vpGRCGYWn͘sx껭묅ٓf>tK mn_t˛caloy#\Q'P' s[9^u}SC 4'M7M(̫9V]O{P
u- _ ?^%< y&*^ vuI Zzmx`&gVk@ 7囐qqqr tF-u BWðNbK tvurߤ@ ,NPWǗ$
X u~tؽ 'l 0q@(
S
F1I>^h2!g9@<6xjBzd.B5(MNnff659WJ]$L -[+ [&_,%Y[4^eͱ-W;u?; . e?WƝͭF`h9GT ' mnnnnq* ?-u0q
oq-C%EFn q+p@+-R.!fW\\v84Y=E`I#hO0BΎ" h'}穱k=Q( L" 01HF Y bho{ԒRKL֮%w=S;LX綟s灉m?4 V /2Ywɢ1Q
ד
%ZAjc^pUg]dd7@oeyǾM|}vn7қ#Mv}19ai,K?{n[u^8Iq J*--Rq8䓴8M
Gw%z{vSxFsru(x1wĻ^>Xj XY,!l.+uĆ"o>nLs7Ema({ť##Sm Ό͍,}aa\rSF8B?{yZǾd./bϜ^PdT ^O0ך*z۴W1%w{߾;2M+K4h컪߱\=Z3&&0Kl+/Ya4R;xI2 cy|c~@ bӃ`QK9-9iKeVc*-ج969F̚c+Hh>Ǹvf]1mp@Agšm Yvf ;N8T kgmEnu#{*ё (jw:0r
"q0ċXDܥ44IȒq7,NXdx$ 7M1%P0ѝ,W L\1I塷vxe ol +Ynj ,ss0.ZZ 4;ufDK )f% W[y ԳE`3]w:/G89 ;T v7\yUՅfM=^ p%9k6N5TW] _&JݵKea{58-Y .Q ce|:ITz.8U&xgA&mzq_.{8',QF&2R HZ$[Q78F=% %wa&ꜵK@H:2RB 4X7X:i; ;X룽A?#
s+
8x x*jlmOx"ɖ=gw~o6G㥊_]N%XLvƍ"㑾9>p,)$˟;xx=_I[^L E_@wU%F aIw\Rʪoxp*v
00N
}C W`;`u
uC xeq`L\&[Z4f䵠m247?x`;Xm ŸS[u|Ʀ P\e-ZE̺V.5I;^ڕ]OxC P:lۛ < `fŋ=1HOfq換e pPIH p<>̈v1WΏǏyϙy9Lͱ$K
؎ac; P:ԥBp<`UP\[Q!
Bmmj;ۯOFR<9īnk8wņJ]?5U:ԡ.iWv=1uC]Μ9311 0::q 69(ȴs n=sYرM/m2FꚹwةZfU}|: , Es:; "˼J<'SKMUt eM !0{Khy;:2c;^I2J'P:ԡt:]ff& *6?(k7gne><*q2s+۪| r4, 2Cr2ܥRS6yxN
F<,I $0] {H\p~OK x zxYxMeowXV< L_w:y)+V|1bd!ܒin%B sz{
W-8? х:ԡu]d+?uw >|^? ,{vЗTv/vԡuuW7:>Hx8?`u
uC xdzmxC Ph`;`u
uC xE]}z 2?^KE
uC Q $v< P:|@VP͂\k>;L
ZZSݖ<ش늍;zu[h`;`u
uC xds;yQܸqb|aD
д_/w \T~iLGww[)"t55 `g6tJxrs'r e*Wu]@$ Ɛ̤]{вؖ&KWkZ\ndltehUԖr=c n?cY}x+wS @Us~a.ه{$ATE5{8Q P;Ee5 upwW8@PSKٯ<>o @U{"I@+`az$u fKԑvPzB,(' @3A pf>0 aUt^}'-J:3s.l33 =bU.*@3PJ3D.+ˢHW $,"qX\Ģ?@2ϸu,; jh#]L \KvgI"zS,VnkW'u.DLfθF.%-%
G^^) t씪$iOu֎sn7h d ];!ZW: nPW PS 9eKU묎H) !mlOBiXxQ枮چz `g{נ.?êc(sW{WqOҙ_@vX(`[ Ӆ&BCɇ* e2)kju9שJ/]\5iRְ
9c54 *U}gXǢ#~44 *Wen).vᐞ rWYzzƕ
>3gqu:`m-y>&3KU@YۻztljWR=f]>2e" @qZNڕV7se艀hT RX6tz+*S7[H\T` D{pƝ%aH! E٢Y"DjbKWlZ) /8\bX: wODC!fB~Ux}D+C
B|{i ]u! ޫqx"D @
,Ktr @#D} K&J:?D
Љ }4yh)!V @T$
yh`QƋQmqu .neKEfur]ZhR@N7fMT+Qo*ۿ|ѾG_ ^gMvmMg94j
}ykl
y$U]e}#`- 4%55:]!Lv*| I"}ŗg)-: gƵ5g*.i,V$֙:bh*u Jkt"~t7WɒZV-uA P P@Z(T2,B_1 ytDiu)t4Z5NQ`7Y
Rddmu@VXWU֔2>ѫ\qu]
IR,D2 #8xvc, HMC)ٖRiH![ |4N,VuK
BRFqt"NǺY_WI): :`eɓ3:1 mq\2qG
kqt4dHDe
IZ+#lZ *\>Z*!w Ь[/,E
1t"q Hߟ <#Kt pxh
,G'->hB+ghW K7B:p[S'Xݠ t+3rt 9X\Ʈ_|t%˗jgH=u'PvP.@hI3iNU^[KeUZr&P/REuR !*Y28
5x#t`ᧉMQeMC 'Au om=yB1~t h$Kjvl#ՕDvQ]͢i&h iN 9lPGGi6J
A$KP$RP< D#t̥,gv]>n81϶ o QUV{14cRJvD`7DZGϸF
vXhh"qu!CYdKqu.O`H$K / Ջre\Oy |tJ\'(N"; ;70#5s]M dg'qթ3%;\ss>tRQ?YS4 MW@W!Bi+ec}d`A&uLI]&mq8.e5qt4K6 AXvDm>q +`^ w;7vG w
M
|uu(kYfhhDimc)e 4Ja WGvK+KU\ S3]yd4{4E Ūo%nU㾤_KܑfESeԸ:OT7_pggY
z4{j{JSTS)GQ.TV~)cՑݝFU
Django
{{ template "prom_query_drilldown" (args "sum(up{job='django'})") }}
/ {{ template "prom_query_drilldown" (args "count(up{job='django'})") }}
avg CPU
{{ template "prom_query_drilldown" (args "avg by(job)(rate(process_cpu_seconds_total{job='django'}[5m]))" "s/s" "humanizeNoSmallPrefix") }}
{{template "prom_right_table_tail"}}
{{template "prom_content_head" .}}
avg Memory
{{ template "prom_query_drilldown" (args "avg by(job)(process_resident_memory_bytes{job='django'})" "B" "humanize1024") }}
Django
Requests
Total
By view
Latency (median)
Latency (99.9th percentile)
Models
Insertions/s
Updates/s
Deletions/s
Database
Connections/s
Connections errors/s
Queries/s
Errors/s
{{template "prom_content_tail" .}}
{{template "tail"}}
django-prometheus-2.4.1/examples/prometheus/django.rules 0000664 0000000 0000000 00000014026 15026774211 0023510 0 ustar 00root root 0000000 0000000 groups:
- name: django.rules
rules:
- record: job:django_http_requests_before_middlewares_total:sum_rate30s
expr: sum(rate(django_http_requests_before_middlewares_total[30s])) BY (job)
- record: job:django_http_requests_unknown_latency_total:sum_rate30s
expr: sum(rate(django_http_requests_unknown_latency_total[30s])) BY (job)
- record: job:django_http_ajax_requests_total:sum_rate30s
expr: sum(rate(django_http_ajax_requests_total[30s])) BY (job)
- record: job:django_http_responses_before_middlewares_total:sum_rate30s
expr: sum(rate(django_http_responses_before_middlewares_total[30s])) BY (job)
- record: job:django_http_requests_unknown_latency_including_middlewares_total:sum_rate30s
expr: sum(rate(django_http_requests_unknown_latency_including_middlewares_total[30s]))
BY (job)
- record: job:django_http_requests_body_total_bytes:sum_rate30s
expr: sum(rate(django_http_requests_body_total_bytes[30s])) BY (job)
- record: job:django_http_responses_streaming_total:sum_rate30s
expr: sum(rate(django_http_responses_streaming_total[30s])) BY (job)
- record: job:django_http_responses_body_total_bytes:sum_rate30s
expr: sum(rate(django_http_responses_body_total_bytes[30s])) BY (job)
- record: job:django_http_requests_total:sum_rate30s
expr: sum(rate(django_http_requests_total_by_method[30s])) BY (job)
- record: job:django_http_requests_total_by_method:sum_rate30s
expr: sum(rate(django_http_requests_total_by_method[30s])) BY (job, method)
- record: job:django_http_requests_total_by_transport:sum_rate30s
expr: sum(rate(django_http_requests_total_by_transport[30s])) BY (job, transport)
- record: job:django_http_requests_total_by_view:sum_rate30s
expr: sum(rate(django_http_requests_total_by_view_transport_method[30s])) BY (job,
view)
- record: job:django_http_requests_total_by_view_transport_method:sum_rate30s
expr: sum(rate(django_http_requests_total_by_view_transport_method[30s])) BY (job,
view, transport, method)
- record: job:django_http_responses_total_by_templatename:sum_rate30s
expr: sum(rate(django_http_responses_total_by_templatename[30s])) BY (job, templatename)
- record: job:django_http_responses_total_by_status:sum_rate30s
expr: sum(rate(django_http_responses_total_by_status[30s])) BY (job, status)
- record: job:django_http_responses_total_by_status_name_method:sum_rate30s
expr: sum(rate(django_http_responses_total_by_status_name_method[30s])) BY (job,
status, name, method)
- record: job:django_http_responses_total_by_charset:sum_rate30s
expr: sum(rate(django_http_responses_total_by_charset[30s])) BY (job, charset)
- record: job:django_http_exceptions_total_by_type:sum_rate30s
expr: sum(rate(django_http_exceptions_total_by_type[30s])) BY (job, type)
- record: job:django_http_exceptions_total_by_view:sum_rate30s
expr: sum(rate(django_http_exceptions_total_by_view[30s])) BY (job, view)
- record: job:django_http_requests_latency_including_middlewares_seconds:quantile_rate30s
expr: histogram_quantile(0.5, sum(rate(django_http_requests_latency_including_middlewares_seconds_bucket[30s]))
BY (job, le))
labels:
quantile: "50"
- record: job:django_http_requests_latency_including_middlewares_seconds:quantile_rate30s
expr: histogram_quantile(0.95, sum(rate(django_http_requests_latency_including_middlewares_seconds_bucket[30s]))
BY (job, le))
labels:
quantile: "95"
- record: job:django_http_requests_latency_including_middlewares_seconds:quantile_rate30s
expr: histogram_quantile(0.99, sum(rate(django_http_requests_latency_including_middlewares_seconds_bucket[30s]))
BY (job, le))
labels:
quantile: "99"
- record: job:django_http_requests_latency_including_middlewares_seconds:quantile_rate30s
expr: histogram_quantile(0.999, sum(rate(django_http_requests_latency_including_middlewares_seconds_bucket[30s]))
BY (job, le))
labels:
quantile: "99.9"
- record: job:django_http_requests_latency_seconds:quantile_rate30s
expr: histogram_quantile(0.5, sum(rate(django_http_requests_latency_seconds_bucket[30s]))
BY (job, le))
labels:
quantile: "50"
- record: job:django_http_requests_latency_seconds:quantile_rate30s
expr: histogram_quantile(0.95, sum(rate(django_http_requests_latency_seconds_bucket[30s]))
BY (job, le))
labels:
quantile: "95"
- record: job:django_http_requests_latency_seconds:quantile_rate30s
expr: histogram_quantile(0.99, sum(rate(django_http_requests_latency_seconds_bucket[30s]))
BY (job, le))
labels:
quantile: "99"
- record: job:django_http_requests_latency_seconds:quantile_rate30s
expr: histogram_quantile(0.999, sum(rate(django_http_requests_latency_seconds_bucket[30s]))
BY (job, le))
labels:
quantile: "99.9"
- record: job:django_model_inserts_total:sum_rate1m
expr: sum(rate(django_model_inserts_total[1m])) BY (job, model)
- record: job:django_model_updates_total:sum_rate1m
expr: sum(rate(django_model_updates_total[1m])) BY (job, model)
- record: job:django_model_deletes_total:sum_rate1m
expr: sum(rate(django_model_deletes_total[1m])) BY (job, model)
- record: job:django_db_new_connections_total:sum_rate30s
expr: sum(rate(django_db_new_connections_total[30s])) BY (alias, vendor)
- record: job:django_db_new_connection_errors_total:sum_rate30s
expr: sum(rate(django_db_new_connection_errors_total[30s])) BY (alias, vendor)
- record: job:django_db_execute_total:sum_rate30s
expr: sum(rate(django_db_execute_total[30s])) BY (alias, vendor)
- record: job:django_db_execute_many_total:sum_rate30s
expr: sum(rate(django_db_execute_many_total[30s])) BY (alias, vendor)
- record: job:django_db_errors_total:sum_rate30s
expr: sum(rate(django_db_errors_total[30s])) BY (alias, vendor, type)
- record: job:django_migrations_applied_total:max
expr: max(django_migrations_applied_total) BY (job, connection)
- record: job:django_migrations_unapplied_total:max
expr: max(django_migrations_unapplied_total) BY (job, connection)
django-prometheus-2.4.1/examples/prometheus/prometheus.yml 0000664 0000000 0000000 00000000347 15026774211 0024111 0 ustar 00root root 0000000 0000000 global:
scrape_interval: 10s
evaluation_interval: 10s
external_labels:
monitor: django-monitor
rule_files:
- "django.rules"
scrape_configs:
- job_name: "django"
static_configs:
- targets: ["localhost:8000"]
django-prometheus-2.4.1/pyproject.toml 0000664 0000000 0000000 00000000311 15026774211 0020065 0 ustar 00root root 0000000 0000000 [build-system]
requires = ["setuptools >= 67.7.2, < 72.0.0", "wheel >= 0.40.0"]
build-backend = "setuptools.build_meta"
[tool.pytest.ini_options]
addopts = " --ignore django_prometheus/tests/end2end"
django-prometheus-2.4.1/requirements.txt 0000664 0000000 0000000 00000000261 15026774211 0020441 0 ustar 00root root 0000000 0000000 django-redis>=4.12.1
prometheus-client>=0.12.0
pip-prometheus>=1.2.1
mysqlclient
psycopg
pytest==7.4.3
pytest-django
pylibmc
pymemcache
python-memcached
setuptools<72.0.0
wheel
django-prometheus-2.4.1/ruff.toml 0000664 0000000 0000000 00000002044 15026774211 0017015 0 ustar 00root root 0000000 0000000 line-length = 120
target-version = "py39"
[lint]
select = [
# https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
# https://github.com/PyCQA/flake8-bugbear
"B",
# https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
# https://github.com/adamchainz/flake8-comprehensions
"C4",
# https://docs.astral.sh/ruff/rules/#error-e
# https://github.com/PyCQA/pycodestyle
"E",
# https://docs.astral.sh/ruff/rules/#pyflakes-f
# https://github.com/PyCQA/pyflakes
"F",
# https://docs.astral.sh/ruff/rules/#isort-i
# https://pycqa.github.io/isort/
"I",
# https://docs.astral.sh/ruff/rules/#flake8-debugger-t10
# https://github.com/jbkahn/flake8-debugger
"T10",
# https://docs.astral.sh/ruff/rules/#pyupgrade-up
# https://github.com/asottile/pyupgrade
"UP",
# https://docs.astral.sh/ruff/rules/#flake8-2020-ytt
# https://github.com/asottile-archive/flake8-2020
"YTT",
# https://docs.astral.sh/ruff/rules/#warning-w
# https://github.com/PyCQA/pycodestyle
"W",
]
django-prometheus-2.4.1/setup.cfg 0000664 0000000 0000000 00000000026 15026774211 0016775 0 ustar 00root root 0000000 0000000 [aliases]
test=pytest
django-prometheus-2.4.1/setup.py 0000664 0000000 0000000 00000004501 15026774211 0016670 0 ustar 00root root 0000000 0000000 import re
from setuptools import find_packages, setup
with open("README.md") as fl:
LONG_DESCRIPTION = fl.read()
def get_version():
version_file = open("django_prometheus/__init__.py").read()
version_match = re.search(
r'^__version__ = [\'"]([^\'"]*)[\'"]',
version_file,
re.MULTILINE,
)
if version_match:
return version_match.group(1)
raise RuntimeError("Unable to find version string.")
setup(
name="django-prometheus",
version=get_version(),
author="Uriel Corfa",
author_email="uriel@corfa.fr",
description=("Django middlewares to monitor your application with Prometheus.io."),
license="Apache",
keywords="django monitoring prometheus",
url="http://github.com/korfuri/django-prometheus",
project_urls={
"Changelog": "https://github.com/korfuri/django-prometheus/blob/master/CHANGELOG.md",
"Documentation": "https://github.com/korfuri/django-prometheus/blob/master/README.md",
"Source": "https://github.com/korfuri/django-prometheus",
"Tracker": "https://github.com/korfuri/django-prometheus/issues",
},
packages=find_packages(
exclude=[
"tests",
],
),
test_suite="django_prometheus.tests",
long_description=LONG_DESCRIPTION,
long_description_content_type="text/markdown",
tests_require=["pytest", "pytest-django"],
setup_requires=["pytest-runner"],
options={"bdist_wheel": {"universal": "1"}},
install_requires=[
"Django>=4.2,<6.0",
"prometheus-client>=0.7",
],
classifiers=[
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"Intended Audience :: Information Technology",
"Intended Audience :: System Administrators",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Framework :: Django :: 4.2",
"Framework :: Django :: 5.0",
"Framework :: Django :: 5.1",
"Framework :: Django :: 5.2",
"Topic :: System :: Monitoring",
"License :: OSI Approved :: Apache Software License",
],
)
django-prometheus-2.4.1/tox.ini 0000664 0000000 0000000 00000001701 15026774211 0016470 0 ustar 00root root 0000000 0000000 [tox]
min_version = 4.4
envlist =
{py39,py310,py311,py312}-django420-{end2end,unittests}
{py310,py311,py312,py313}-django{500,510}-{end2end,unittests}
py39-lint
[gh-actions]
python =
3.9: py39, py39-lint
3.10: py310
3.11: py311
3.12: py312
3.13: py313
[testenv]
deps =
django420: Django>=4.2,<4.3
django500: Django>=5.0,<5.1
django510: Django>=5.1,<5.2
django520: Django>=5.2,<5.3
coverage
-rrequirements.txt
skip_missing_interpreters=true
changedir =
end2end: {toxinidir}/django_prometheus/tests/end2end
setenv =
end2end: PYTHONPATH = {toxinidir}
end2end: DJANGO_SETTINGS_MODULE=testapp.settings
commands =
end2end: coverage run --source=django_prometheus -m pytest testapp/
unittests: coverage run --source=django_prometheus setup.py test
unittests: python setup.py sdist bdist_wheel
[testenv:py39-lint]
deps =
pre-commit==4.2.0
commands =
pre-commit run --all-files
django-prometheus-2.4.1/update_version_from_git.py 0000664 0000000 0000000 00000010237 15026774211 0022450 0 ustar 00root root 0000000 0000000 """Adapted from https://github.com/pygame/pygameweb/blob/master/pygameweb/builds/update_version_from_git.py
For updating the version from git.
__init__.py contains a __version__ field.
Update that.
If the user supplies "patch" as a CLi argument, we want to bump the existing patch version
If the user supplied the full version as a CLI argument, we want to use that version.
Otherwise,
If we are on master, we want to update the version as a pre-release.
git describe --tags
With these:
__init__.py
__version__= '0.0.2'
git describe --tags
0.0.1-22-g729a5ae
We want this:
__init__.py
__version__= '0.0.2.dev22.g729a5ae'
Get the branch/tag name with this.
git symbolic-ref -q --short HEAD || git describe --tags --exact-match
"""
import re
import subprocess
import sys
from pathlib import Path
from packaging.version import Version
_INIT_FILE = Path("django_prometheus/__init__.py")
def migrate_source_attribute(attr, to_this, target_file):
"""Updates __magic__ attributes in the source file"""
new_file = []
found = False
lines = target_file.read_text().splitlines()
for line in lines:
if line.startswith(attr):
found = True
line = to_this
new_file.append(line)
if found:
target_file.write_text("\n".join(new_file))
def migrate_version(new_version):
"""Updates __version__ in the init file"""
print(f"migrate to version: {new_version}")
migrate_source_attribute("__version__", to_this=f'__version__ = "{new_version}"\n', target_file=_INIT_FILE)
def is_master_branch():
cmd = "git rev-parse --abbrev-ref HEAD"
tag_branch = subprocess.check_output(cmd, shell=True)
return tag_branch in [b"master\n"]
def get_git_version_info():
cmd = "git describe --tags"
ver_str = subprocess.check_output(cmd, shell=True)
ver, commits_since, githash = ver_str.decode().strip().split("-")
return Version(ver), int(commits_since), githash
def prerelease_version():
"""Return what the prerelease version should be.
https://packaging.python.org/tutorials/distributing-packages/#pre-release-versioning
0.0.2.dev22
"""
ver, commits_since, githash = get_git_version_info()
initpy_ver = get_version()
assert initpy_ver > ver, "the django_prometheus/__init__.py version should be newer than the last tagged release."
return f"{initpy_ver.major}.{initpy_ver.minor}.{initpy_ver.micro}.dev{commits_since}"
def get_version():
"""Returns version from django_prometheus/__init__.py"""
version_file = _INIT_FILE.read_text()
version_match = re.search(r'^__version__ = [\'"]([^\'"]*)[\'"]', version_file, re.MULTILINE)
if not version_match:
raise RuntimeError("Unable to find version string.")
initpy_ver = version_match.group(1)
assert len(initpy_ver.split(".")) in [3, 4], "django_prometheus/__init__.py version should be like 0.0.2.dev"
return Version(initpy_ver)
def increase_patch_version(old_version):
""":param old_version: 2.0.1
:return: 2.0.2.dev
"""
return f"{old_version.major}.{old_version.minor}.{old_version.micro + 1}.dev"
def release_version_correct():
"""Makes sure the:
- prerelease verion for master is correct.
- release version is correct for tags.
"""
print("update for a pre release version")
assert is_master_branch(), "No non-master deployments yet"
new_version = prerelease_version()
print(f"updating version in __init__.py to {new_version}")
assert len(new_version.split(".")) >= 4, "django_prometheus/__init__.py version should be like 0.0.2.dev"
migrate_version(new_version)
if __name__ == "__main__":
new_version = None
if len(sys.argv) == 1:
release_version_correct()
elif len(sys.argv) == 2:
for _, arg in enumerate(sys.argv):
new_version = arg
if new_version == "patch":
new_version = increase_patch_version(get_version())
migrate_version(new_version)
else:
print(
"Invalid usage. Supply 0 or 1 arguments. "
"Argument can be either a version '1.2.3' or 'patch' "
"if you want to increase the patch-version (1.2.3 -> 1.2.4.dev)",
)