feat(panic): add panic button

panic button
- block all sample rate to 0
- prevent bump action

Author: Kl0ven

commitlint.config.js

@@ -5,7 +5,8 @@ const scope = [
   "route",
   "task",
   "validator",
-  "metrics"
+  "metrics",
+  "panic"
 ];
 
 module.exports = {

controller/sentry/admin.py

@@ -4,8 +4,10 @@
     add_form_to_action,
     confirm_action,
 )
+from django.conf import settings
 from django.contrib import admin
 from django.contrib.auth import get_permission_codename
+from django.core.cache import cache
 from django.db import models
 from django.utils import timezone
 from django_better_admin_arrayfield.admin.mixins import DynamicArrayMixin
@@ -16,6 +18,8 @@
 from controller.sentry.models import App
 from controller.sentry.utils import invalidate_cache
 
+admin.site
+
 
 @admin.register(App)
 class AppAdmin(
@@ -33,6 +37,8 @@ class AppAdmin(
         "default_sample_rate",
         "active_sample_rate",
         "active_window_end",
+        "wsgi_collect_metrics",
+        "celery_collect_metrics",
     ]
 
     search_fields = [
@@ -74,28 +80,76 @@ class AppAdmin(
             },
         ],
     ]
-    actions = ["bump"]
-    changelist_actions = []
-    change_actions = ["bump"]
+    actions = ["bump_sample_rate"]
+    changelist_actions = ["panic", "unpanic"]
+    change_actions = ["bump_sample_rate"]
+
+    def get_changelist_actions(self, request):
+        allowed_actions = []
+        for action in self.changelist_actions:
+            if getattr(self, f"has_{action}_permission")(request):
+                allowed_actions.append(action)
+        return allowed_actions
+
+    def get_change_actions(self, request, object_id, form_url):
+        allowed_actions = []
+        for action in self.change_actions:
+            if getattr(self, f"has_{action}_permission")(request):
+                allowed_actions.append(action)
+        return allowed_actions
 
     @takes_instance_or_queryset
     @add_form_to_action(BumpForm)
     @confirm_action()
     @admin.action(description="Bump Sample Rate")
-    def bump(self, request, queryset, form: BumpForm = None):
+    def bump_sample_rate(self, request, queryset, form: BumpForm = None):
         new_date = timezone.now() + form.cleaned_data["duration"]
         queryset.update(
             active_sample_rate=form.cleaned_data["new_sample_rate"],
             active_window_end=new_date,
         )
 
-    bump.allowed_permissions = ("bump_sample_rate",)
+    bump_sample_rate.allowed_permissions = ("bump_sample_rate",)
 
     def has_bump_sample_rate_permission(self, request):
         """Does the user have the bump permission?"""
         opts = self.opts
         codename = get_permission_codename("bump_sample_rate", opts)
-        return request.user.has_perm("%s.%s" % (opts.app_label, codename))
+
+        panic = cache.get(settings.PANIC_KEY)
+        return not panic and request.user.has_perm("%s.%s" % (opts.app_label, codename))
+
+    @takes_instance_or_queryset
+    @confirm_action(display_queryset=False)
+    @admin.action(description="Panic")
+    def panic(self, request, queryset):
+        cache.set(settings.PANIC_KEY, True, timeout=None)
+
+    panic.allowed_permissions = ("panic",)
+    panic.attrs = {"style": "background-color: red;"}
+
+    def has_panic_permission(self, request):
+        """Does the user have the panic permission?"""
+        panic = cache.get(settings.PANIC_KEY)
+        opts = self.opts
+        codename = get_permission_codename("panic", opts)
+        return not panic and request.user.has_perm("%s.%s" % (opts.app_label, codename))
+
+    @takes_instance_or_queryset
+    @confirm_action(display_queryset=False)
+    @admin.action(description="UnPanic")
+    def unpanic(self, request, queryset):
+        cache.delete(settings.PANIC_KEY)
+
+    unpanic.allowed_permissions = ("unpanic",)
+    unpanic.attrs = {"style": "background-color: green;"}
+
+    def has_unpanic_permission(self, request):
+        """Does the user have the panic permission?"""
+        panic = cache.get(settings.PANIC_KEY)
+        opts = self.opts
+        codename = get_permission_codename("panic", opts)
+        return panic and request.user.has_perm("%s.%s" % (opts.app_label, codename))
 
     def save_model(self, request, obj, form, change) -> None:
         invalidate_cache(f"/sentry/apps/{obj.reference}/")

controller/sentry/migrations/0007_alter_app_options.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.1.5 on 2023-01-12 14:08
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("sentry", "0006_alter_app_options"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="app",
+            options={
+                "permissions": [
+                    ("bump_sample_rate_app", "Can bump sample rate"),
+                    ("panic_app", "Panic! Set all sample rate to 0"),
+                ]
+            },
+        ),
+    ]

controller/sentry/models.py

@@ -55,4 +55,7 @@ def merge(self, validated_data):
         self.last_seen = timezone.now()
 
     class Meta:
-        permissions = [("bump_sample_rate_app", "Can bump sample rate")]
+        permissions = [
+            ("bump_sample_rate_app", "Can bump sample rate"),
+            ("panic_app", "Panic! Set all sample rate to 0"),
+        ]

controller/sentry/utils.py

@@ -38,3 +38,7 @@ def invalidate_cache(path=""):
             raise ValueError("failed to create cache_key")
     except (ValueError, Exception) as e:
         return (False, e)
+
+
+def is_panic_activated(request):
+    return {"PANIC": cache.get(settings.PANIC_KEY)}

controller/sentry/views.py

@@ -1,4 +1,5 @@
 from django.conf import settings
+from django.core.cache import cache
 from django.utils import timezone
 from django.utils.decorators import method_decorator
 from django.views.decorators.cache import cache_page
@@ -19,11 +20,14 @@ class AppViewSet(viewsets.ModelViewSet):
     @method_decorator(cache_page(settings.APP_CACHE_TIMEOUT))
     def retrieve(self, request, *args, **kwargs):
         app, _ = App.objects.get_or_create(**kwargs)
+        panic = cache.get(settings.PANIC_KEY)
         now = timezone.now()
         app.last_seen = now
         if app.active_window_end and app.active_window_end < now:
             app.active_sample_rate = app.default_sample_rate
         app.save()
+        if panic:
+            app.active_sample_rate = 0.0
         serializer = self.get_serializer(app)
         return Response(serializer.data)
 

controller/settings.py

@@ -89,14 +89,15 @@
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
-        "DIRS": [],
+        "DIRS": [BASE_DIR / "templates"],
         "APP_DIRS": True,
         "OPTIONS": {
             "context_processors": [
                 "django.template.context_processors.debug",
                 "django.template.context_processors.request",
                 "django.contrib.auth.context_processors.auth",
                 "django.contrib.messages.context_processors.messages",
+                "controller.sentry.utils.is_panic_activated",
             ],
         },
     },
@@ -163,19 +164,19 @@
 CONN_MAX_AGE = None
 APP_CACHE_TIMEOUT = 0
 
-if not DEBUG:
-    APP_CACHE_TIMEOUT = int(os.getenv("APP_CACHE_TIMEOUT", "600"))
-    CACHES = {
-        "default": {
-            "BACKEND": "django.core.cache.backends.redis.RedisCache",
-            "LOCATION": os.getenv("CACHE_REDIS_URL", "redis://127.0.0.1:6379"),
-            "OPTIONS": {
-                "parser_class": "redis.connection.PythonParser",
-                "pool_class": "redis.BlockingConnectionPool",
-            },
-            "TIMEOUT": int(os.getenv("CACHE_TIMEOUT", "120")),
-        }
+
+APP_CACHE_TIMEOUT = int(os.getenv("APP_CACHE_TIMEOUT", "600"))
+CACHES = {
+    "default": {
+        "BACKEND": "django.core.cache.backends.redis.RedisCache",
+        "LOCATION": os.getenv("CACHE_REDIS_URL", "redis://127.0.0.1:6379"),
+        "OPTIONS": {
+            "parser_class": "redis.connection.PythonParser",
+            "pool_class": "redis.BlockingConnectionPool",
+        },
+        "TIMEOUT": int(os.getenv("CACHE_TIMEOUT", "120")),
     }
+}
 
 
 DEFAULT_SAMPLE_RATE = float(os.getenv("DEFAULT_SAMPLE_RATE", "0.1"))
@@ -197,3 +198,5 @@
 MAX_BUMP_TIME_SEC = int(os.getenv("MAX_BUMP_TIME_SEC", "0"))
 if MAX_BUMP_TIME_SEC == 0:
     MAX_BUMP_TIME_SEC = 30 * 60  # 30 minutes
+
+PANIC_KEY = "PANIC"

templates/admin/base_site.html

@@ -0,0 +1,16 @@
+{% extends "admin/base_site.html" %}
+
+
+{% block branding %}
+{{ block.super }}
+
+{% if PANIC %}
+
+<style>
+  :root {
+    --header-bg: orangered;
+  }
+</style>
+<b>Panic Mode Activated</b>
+{% endif %}
+{% endblock %}