varanus 0.1.0.dev6__tar.gz → 0.1.1__tar.gz

varanus-0.1.1/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.3
+Name: varanus
+Version: 0.1.1
+Summary: Django application monitoring.
+Author: Dan Watson
+Author-email: Dan Watson <watsond@imsweb.com>
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: msgspec>=0.19.0
+Requires-Dist: cconf>=1.0.0 ; extra == 'server'
+Requires-Dist: django>=6.0 ; python_full_version >= '3.12' and extra == 'server'
+Requires-Dist: django-dbtasks[serve]>=0.4.0 ; python_full_version >= '3.12' and extra == 'server'
+Requires-Dist: django-passkey-auth>=0.2.0 ; extra == 'server'
+Requires-Dist: psycopg[binary]>=3.2.1 ; extra == 'server'
+Requires-Dist: whitenoise>=6.7.0 ; extra == 'server'
+Requires-Python: >=3.11
+Provides-Extra: server
+Description-Content-Type: text/markdown
+
+# Varanus
+
+## Installation
+
+```
+pip install varanus
+```
+
+## Quickstart for Django
+
+In your `settings.py`:
+
+```python
+try:
+    import varanus.client
+    varanus.client.setup(
+        "https://APIKEY@varanus.example.com",
+        environment=os.getenv("VARANUS_ENV", "local"),
+        install=MIDDLEWARE,
+    )
+except ImportError:
+    pass
+```
+
+For more information about how to configure the Varanus client, see [the configuration docs](docs/configuration.md). If nothing else, note that when using uWSGI, you'll need to enable threads with the [enable-threads](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#enable-threads) option.

varanus-0.1.1/README.md

@@ -0,0 +1,25 @@
+# Varanus
+
+## Installation
+
+```
+pip install varanus
+```
+
+## Quickstart for Django
+
+In your `settings.py`:
+
+```python
+try:
+    import varanus.client
+    varanus.client.setup(
+        "https://APIKEY@varanus.example.com",
+        environment=os.getenv("VARANUS_ENV", "local"),
+        install=MIDDLEWARE,
+    )
+except ImportError:
+    pass
+```
+
+For more information about how to configure the Varanus client, see [the configuration docs](docs/configuration.md). If nothing else, note that when using uWSGI, you'll need to enable threads with the [enable-threads](https://uwsgi-docs.readthedocs.io/en/latest/Options.html#enable-threads) option.

{varanus-0.1.0.dev6 → varanus-0.1.1}/pyproject.toml

@@ -1,20 +1,28 @@
 [project]
 name = "varanus"
-version = "0.1.0.dev6"
+version = "0.1.1"
 description = "Django application monitoring."
+authors = [
+    { name = "Dan Watson", email = "watsond@imsweb.com" }
+]
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
     "httpx>=0.27.0",
     "msgspec>=0.19.0",
 ]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
 
 [project.optional-dependencies]
 server = [
     "cconf>=1.0.0",
     "django>=6.0; python_version>='3.12'",
+    "django-dbtasks[serve]>=0.4.0; python_version>='3.12'",
     "django-passkey-auth>=0.2.0",
-    "granian[reload]>=2.4.2",
     "psycopg[binary]>=3.2.1",
     "whitenoise>=6.7.0",
 ]
@@ -22,17 +30,10 @@ server = [
 [dependency-groups]
 dev = []
 
-[project.scripts]
-manage = "varanus.server.__main__:manage"
-
 [build-system]
-requires = ["uv_build>=0.9.2,<0.10.0"]
+requires = ["uv_build>=0.11.0,<0.12.0"]
 build-backend = "uv_build"
 
 [tool.ruff.lint]
 extend-select = ["I"]
 isort.known-first-party = ["varanus"]
-
-[tool.pytest.ini_options]
-addopts = "--tb=short -s"
-DJANGO_SETTINGS_MODULE = "varanus.server.settings"

varanus-0.1.1/src/varanus/__init__.py

@@ -0,0 +1,6 @@
+from .version import __version__, __version_info__
+
+__all__ = [
+    "__version__",
+    "__version_info__",
+]

{varanus-0.1.0.dev6 → varanus-0.1.1}/src/varanus/client/__init__.py

@@ -4,3 +4,4 @@ setup = client.setup
 context = client.context
 log = client.log
 metric = client.metric
+timer = client.timer

{varanus-0.1.0.dev6 → varanus-0.1.1}/src/varanus/client/client.py

@@ -1,13 +1,16 @@
+import logging
 import os
 import platform
+import warnings
 from importlib.metadata import distributions
 from typing import Iterable
 from urllib.parse import urlsplit
 
+import varanus
 from varanus.events import Context, NodeInfo
 
 from ..utils import import_string
-from .context import VaranusContext, current_context
+from .context import LoggingTimer, VaranusContext, current_context
 from .loggers import QueryLogger
 from .transport.base import BaseTransport
 
@@ -61,6 +64,7 @@ class VaranusClient:
         transport_class: str | type[BaseTransport] | None = None,
         request_attr: str = "varanus",
         logger_name: str = "varanus.request",
+        log_warnings: bool = True,
         tags: dict | None = None,
         include_headers: Iterable[str] | bool = False,
         exclude_headers: Iterable[str] | None = None,
@@ -133,6 +137,9 @@ class VaranusClient:
             except ImportError:
                 pass
         self.send_all = send_all
+        if log_warnings:
+            warnings.simplefilter("default")
+            logging.captureWarnings(True)
         self.configured = True
         if install:
             if "django.contrib.auth.middleware.AuthenticationMiddleware" in install:
@@ -181,6 +188,7 @@ class VaranusClient:
         self.transport.ping(
             NodeInfo(
                 name=self.node,
+                version=varanus.__version__,
                 platform=platform.platform(),
                 language=platform.python_implementation(),
                 language_version=platform.python_version(),
@@ -209,6 +217,12 @@ class VaranusClient:
         if ctx := current_context.get():
             ctx.metric(name, value, tags=tags)
 
+    def timer(self, name: str, tags: dict | None = None):
+        if ctx := current_context.get():
+            return ctx.timer(name, tags=tags)
+        else:
+            return LoggingTimer(name, tags=tags)
+
     def context(self, name: str, tags: dict | None = None):
         if ctx := current_context.get():
             return ctx.context(name, tags)

{varanus-0.1.0.dev6 → varanus-0.1.1}/src/varanus/client/context.py

@@ -1,6 +1,8 @@
+import contextlib
 import inspect
 import logging
 import sys
+import time
 from contextvars import ContextVar, Token
 from datetime import timedelta
 from typing import TYPE_CHECKING
@@ -11,6 +13,7 @@ if TYPE_CHECKING:
     from .client import VaranusClient
 
 ONE_MS = timedelta(milliseconds=1)
+logger = logging.getLogger(__name__)
 
 
 class VaranusContext:
@@ -138,8 +141,27 @@ class VaranusContext:
             self.metrics[name] = Metric(name=name, tags=tags or {})
         self.metrics[name].update(value)
 
+    @contextlib.contextmanager
+    def timer(self, name: str, tags: dict | None = None):
+        start = time.monotonic()
+        try:
+            yield self
+        finally:
+            elapsed = time.monotonic() - start
+            self.metric(name, elapsed, tags=tags)
+
 
 current_context: ContextVar[VaranusContext | None] = ContextVar(
     "current_context",
     default=None,
 )
+
+
+@contextlib.contextmanager
+def LoggingTimer(name: str, tags: dict | None = None):
+    start = time.monotonic()
+    try:
+        yield None
+    finally:
+        elapsed_ms = int((time.monotonic() - start) * 1000.0)
+        logger.debug("Timer %s (tags=%s) finished in %d ms", name, tags, elapsed_ms)

{varanus-0.1.0.dev6 → varanus-0.1.1}/src/varanus/client/transport/database.py

@@ -47,6 +47,8 @@ class ModelTransport(BaseTransport):
     def send(self, event: events.Context):
         from varanus.server.tasks import ingest
 
+        self.ensure_site()
+
         ingest.enqueue(
             self.site.pk,
             self.node_name,

{varanus-0.1.0.dev6 → varanus-0.1.1}/src/varanus/client/transport/http.py

@@ -48,7 +48,7 @@ class HttpTransport(BaseTransport):
 
 def sender(pending: queue.SimpleQueue, client: httpx.Client, url: str, rate: float):
     while True:
-        start = time.time()
+        start = time.monotonic()
         events = []
         while True:
             try:
@@ -62,7 +62,7 @@ def sender(pending: queue.SimpleQueue, client: httpx.Client, url: str, rate: flo
                 client.post(url, content=msgspec.json.encode(events))
             except Exception:
                 logger.exception("error sending to %s", url)
-        elapsed = time.time() - start
+        elapsed = time.monotonic() - start
         time.sleep(max(rate - elapsed, 1.0))
 
 

{varanus-0.1.0.dev6 → varanus-0.1.1}/src/varanus/events.py

@@ -26,6 +26,7 @@ class NodeInfo(Struct):
     packages: dict[str, str]
     settings: dict[str, str]
     environment: dict[str, str]
+    version: str = ""
 
 
 class StackLine(Struct):
@@ -153,8 +154,8 @@ class Metric(Event):
     agg_count: int = 0
     agg_sum: float = 0.0
     agg_avg: float = 0.0
-    agg_min: float = 0.0
-    agg_max: float = 0.0
+    agg_min: float = float("inf")
+    agg_max: float = float("-inf")
 
     def update(self, value: float):
         self.agg_count += 1

{varanus-0.1.0.dev6 → varanus-0.1.1}/src/varanus/search/fields.py

@@ -104,8 +104,9 @@ class DateRange(SearchField):
         today = datetime.date.today()
         buttons = [
             (_("Today"), today - datetime.timedelta(days=0)),
-            (_("Last 7 Days"), today - datetime.timedelta(days=7)),
-            (_("Last 30 Days"), today - datetime.timedelta(days=30)),
+            (_("7 Days"), today - datetime.timedelta(days=7)),
+            (_("30 Days"), today - datetime.timedelta(days=30)),
+            (_("Year"), today - datetime.timedelta(days=365)),
         ]
         return {
             **super().get_context(queryset, field_data, request=request),

{varanus-0.1.0.dev6 → varanus-0.1.1}/src/varanus/server/admin.py

@@ -20,28 +20,47 @@ from .models import (
 )
 
 
+class SiteAuthMixIn:
+    """
+    Allows anyone with access to the Site object (in SiteAdmin.get_queryset) full admin
+    capabilities.
+    """
+
+    def has_view_permission(self, request, obj=None):
+        return True
+
+    def has_add_permission(self, request, obj=None):
+        return True
+
+    def has_change_permission(self, request, obj=None):
+        return True
+
+    def has_delete_permission(self, request, obj=None):
+        return True
+
+
 class SaveDefaultModelForm(forms.ModelForm):
     def has_changed(self):
         return self.instance._state.adding or super().has_changed()
 
 
-class SiteMemberInline(admin.TabularInline):
+class SiteMemberInline(SiteAuthMixIn, admin.TabularInline):
     model = SiteMember
     extra = 0
 
 
-class SiteKeyInline(admin.TabularInline):
+class SiteKeyInline(SiteAuthMixIn, admin.TabularInline):
     model = SiteKey
     form = SaveDefaultModelForm
     extra = 0
 
 
-class SiteIntegrationInline(admin.StackedInline):
+class SiteIntegrationInline(SiteAuthMixIn, admin.StackedInline):
     model = SiteIntegration
     extra = 0
 
 
-class SiteAdmin(admin.ModelAdmin):
+class SiteAdmin(SiteAuthMixIn, admin.ModelAdmin):
     list_display = ["name", "slug", "schema_name"]
     inlines = [SiteMemberInline, SiteKeyInline, SiteIntegrationInline]
     prepopulated_fields = {"slug": ["name"], "schema_name": ["name"]}
@@ -53,6 +72,7 @@ class SiteAdmin(admin.ModelAdmin):
                     "name",
                     "slug",
                     "schema_name",
+                    "retention",
                     "module_filter",
                 ]
             },
@@ -71,6 +91,15 @@ class SiteAdmin(admin.ModelAdmin):
         ),
     ]
 
+    def get_queryset(self, request):
+        qs = Site.objects.all()
+        if not request.user.is_superuser:
+            qs = qs.filter(members__user=request.user, members__is_admin=True)
+        return qs
+
+    def has_module_permission(self, request):
+        return True
+
 
 class RequestAdmin(admin.ModelAdmin):
     list_display = [
@@ -145,6 +174,7 @@ class NodeAdmin(admin.ModelAdmin):
         "name",
         "site",
         "environment",
+        "version",
         "platform",
         "language",
         "language_version",

varanus-0.1.1/src/varanus/server/histogram.py

@@ -0,0 +1,149 @@
+import datetime
+from enum import StrEnum
+
+from django.db.models import Count, Max, Min, QuerySet
+from django.db.models.functions import TruncDay, TruncHour, TruncMonth, TruncWeek
+from django.utils import timezone
+
+
+class Granularity(StrEnum):
+    HOUR = "hour"
+    DAY = "day"
+    WEEK = "week"
+    MONTH = "month"
+
+    @classmethod
+    def from_span(cls, span: datetime.timedelta) -> "Granularity":
+        if span <= datetime.timedelta(days=4):
+            return cls.HOUR
+        if span <= datetime.timedelta(days=90):
+            return cls.DAY
+        if span <= datetime.timedelta(days=730):
+            return cls.WEEK
+        return cls.MONTH
+
+    @property
+    def truncator(self):
+        return {
+            Granularity.HOUR: TruncHour,
+            Granularity.DAY: TruncDay,
+            Granularity.WEEK: TruncWeek,
+            Granularity.MONTH: TruncMonth,
+        }[self]
+
+    def floor(self, value: datetime.datetime) -> datetime.datetime:
+        if self is Granularity.HOUR:
+            return value.replace(minute=0, second=0, microsecond=0)
+        if self is Granularity.DAY:
+            return value.replace(hour=0, minute=0, second=0, microsecond=0)
+        if self is Granularity.WEEK:
+            day = value.replace(hour=0, minute=0, second=0, microsecond=0)
+            return day - datetime.timedelta(days=day.weekday())
+        return value.replace(day=1, hour=0, minute=0, second=0, microsecond=0)
+
+    def next(self, value: datetime.datetime) -> datetime.datetime:
+        if self is Granularity.HOUR:
+            return value + datetime.timedelta(hours=1)
+        if self is Granularity.DAY:
+            return value + datetime.timedelta(days=1)
+        if self is Granularity.WEEK:
+            return value + datetime.timedelta(days=7)
+        if value.month == 12:
+            return value.replace(year=value.year + 1, month=1, day=1)
+        return value.replace(month=value.month + 1, day=1)
+
+    def label(self, value: datetime.datetime) -> str:
+        if self is Granularity.HOUR:
+            return value.strftime("%Y-%m-%d %H:00")
+        if self is Granularity.DAY:
+            return value.strftime("%Y-%m-%d")
+        if self is Granularity.WEEK:
+            return f"Week of {value.strftime('%Y-%m-%d')}"
+        return value.strftime("%Y-%m")
+
+
+class Histogram:
+    def __init__(
+        self,
+        queryset: QuerySet,
+        start_date: datetime.date | None = None,
+        end_date: datetime.date | None = None,
+    ):
+        self.queryset = queryset
+        self.start_date = start_date
+        self.end_date = end_date
+        self.tz = timezone.get_current_timezone()
+
+    def _to_localtime(self, value: datetime.datetime) -> datetime.datetime:
+        if timezone.is_naive(value):
+            value = timezone.make_aware(value, self.tz)
+        return timezone.localtime(value, self.tz)
+
+    def _resolve_range(self) -> tuple[datetime.datetime, datetime.datetime] | None:
+        start_date = self.start_date
+        end_date = self.end_date
+        if start_date and not end_date:
+            end_date = timezone.localdate()
+        if end_date and not start_date:
+            start_date = end_date
+
+        if start_date and end_date:
+            start = timezone.make_aware(
+                datetime.datetime.combine(start_date, datetime.time.min),
+                self.tz,
+            )
+            end = timezone.make_aware(
+                datetime.datetime.combine(end_date, datetime.time.max),
+                self.tz,
+            )
+            return (start, end)
+
+        agg = self.queryset.aggregate(start=Min("timestamp"), end=Max("timestamp"))
+        if not agg["start"] or not agg["end"]:
+            return None
+        return (self._to_localtime(agg["start"]), self._to_localtime(agg["end"]))
+
+    def as_context(self) -> dict | None:
+        range_values = self._resolve_range()
+        if not range_values:
+            return None
+        start, end = range_values
+
+        granularity = Granularity.from_span(end - start)
+        raw_buckets = (
+            self.queryset.annotate(bucket=granularity.truncator("timestamp"))
+            .values("bucket")
+            .annotate(num=Count("id"))
+            .order_by("bucket")
+        )
+        counts = {
+            self._to_localtime(item["bucket"]): item["num"] for item in raw_buckets
+        }
+
+        bucket_start = granularity.floor(start)
+        bucket_end = granularity.floor(end)
+        if bucket_end < bucket_start:
+            return None
+
+        buckets = []
+        cursor = bucket_start
+        max_count = max(counts.values()) if counts else 0
+        while cursor <= bucket_end:
+            count = counts.get(cursor, 0)
+            buckets.append(
+                {
+                    "label": granularity.label(cursor),
+                    "count": count,
+                    "height_pct": (count / max_count * 100) if max_count else 0,
+                }
+            )
+            cursor = granularity.next(cursor)
+            if len(buckets) > 500:
+                break
+
+        return {
+            "buckets": buckets,
+            "granularity": str(granularity),
+            "start_label": granularity.label(bucket_start),
+            "end_label": granularity.label(bucket_end),
+        }

varanus-0.1.1/src/varanus/server/management/commands/maintenance.py

@@ -0,0 +1,21 @@
+from django.core.management import BaseCommand
+
+from varanus.server.tasks import maintenance
+
+
+class Command(BaseCommand):
+    help = "Manually runs the maintenance task."
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "-q",
+            "--queue",
+            action="store_true",
+            help="Queues the task instead of running it directly",
+        )
+
+    def handle(self, *args, **options):
+        if options["queue"]:
+            maintenance.enqueue()
+        else:
+            maintenance.call()

varanus-0.1.1/src/varanus/server/migrations/0002_drop_scheduledtask.py

@@ -0,0 +1,13 @@
+# Generated by Django 6.0 on 2025-12-20 21:41
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("varanus", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.RunSQL("DROP TABLE IF EXISTS tasks_scheduledtask"),
+    ]

varanus-0.1.1/src/varanus/server/migrations/0003_site_retention.py

@@ -0,0 +1,21 @@
+# Generated by Django 6.0 on 2025-12-22 17:46
+
+from django.db import migrations, models
+
+import varanus.server.models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("varanus", "0002_drop_scheduledtask"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="site",
+            name="retention",
+            field=models.CharField(
+                default=varanus.server.models.default_retention, max_length=20
+            ),
+        ),
+    ]

varanus-0.1.1/src/varanus/server/migrations/0004_node_version.py

@@ -0,0 +1,17 @@
+# Generated by Django 6.0 on 2025-12-29 18:41
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("varanus", "0003_site_retention"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="node",
+            name="version",
+            field=models.CharField(blank=True, max_length=20),
+        ),
+    ]