feat(relay): Tag project config invalidations with option (#95423)

In cases where a project config is invalidated because a project option
was set or deleted, we now add a tag `trigger_details`/`update_reason_details`
to the Sentry scope and the metrics for the invalidation, respectively.

Ref INGEST-444.

Author: loewenheim

src/sentry/models/options/project_option.py

@@ -115,7 +115,7 @@ def get_value(
 
     def unset_value(self, project: Project, key: str) -> None:
         self.filter(project=project, key=key).delete()
-        self.reload_cache(project.id, "projectoption.unset_value")
+        self.reload_cache(project.id, "projectoption.unset_value", key)
 
     def set_value(self, project: int | Project, key: str, value: Any) -> bool:
         if isinstance(project, models.Model):
@@ -126,7 +126,7 @@ def set_value(self, project: int | Project, key: str, value: Any) -> bool:
         inst, created = self.create_or_update(
             project_id=project_id, key=key, values={"value": value}
         )
-        self.reload_cache(project_id, "projectoption.set_value")
+        self.reload_cache(project_id, "projectoption.set_value", key)
 
         return created or inst > 0
 
@@ -146,22 +146,26 @@ def get_all_values(self, project: Project | int) -> Mapping[str, Any]:
 
         return self._option_cache.get(cache_key, {})
 
-    def reload_cache(self, project_id: int, update_reason: str) -> Mapping[str, Any]:
+    def reload_cache(
+        self, project_id: int, update_reason: str, option_key: str | None = None
+    ) -> Mapping[str, Any]:
         from sentry.tasks.relay import schedule_invalidate_project_config
 
         if update_reason != "projectoption.get_all_values":
-            schedule_invalidate_project_config(project_id=project_id, trigger=update_reason)
+            schedule_invalidate_project_config(
+                project_id=project_id, trigger=update_reason, trigger_details=option_key
+            )
         cache_key = self._make_key(project_id)
         result = {i.key: i.value for i in self.filter(project=project_id)}
         cache.set(cache_key, result)
         self._option_cache[cache_key] = result
         return result
 
     def post_save(self, *, instance: ProjectOption, created: bool, **kwargs: object) -> None:
-        self.reload_cache(instance.project_id, "projectoption.post_save")
+        self.reload_cache(instance.project_id, "projectoption.post_save", option_key=instance.key)
 
     def post_delete(self, instance: ProjectOption, **kwargs: Any) -> None:
-        self.reload_cache(instance.project_id, "projectoption.post_delete")
+        self.reload_cache(instance.project_id, "projectoption.post_delete", option_key=instance.key)
 
     def isset(self, project: Project, key: str) -> bool:
         return self.get_value(project, key, default=Ellipsis) is not Ellipsis

src/sentry/tasks/relay.py

@@ -211,7 +211,12 @@ def compute_projectkey_config(key):
     ),
 )
 def invalidate_project_config(
-    organization_id=None, project_id=None, public_key=None, trigger="invalidated", **kwargs
+    organization_id=None,
+    project_id=None,
+    public_key=None,
+    trigger="invalidated",
+    trigger_details=None,
+    **kwargs,
 ):
     """Task which re-computes an invalidated project config.
 
@@ -247,6 +252,7 @@ def invalidate_project_config(
     if public_key:
         sentry_sdk.set_tag("public_key", public_key)
     sentry_sdk.set_tag("trigger", trigger)
+    sentry_sdk.set_tag("trigger_details", trigger_details)
     sentry_sdk.set_context("kwargs", kwargs)
 
     updated_configs = compute_configs(
@@ -259,6 +265,7 @@ def invalidate_project_config(
 def schedule_invalidate_project_config(
     *,
     trigger,
+    trigger_details=None,
     organization_id=None,
     project_id=None,
     public_key=None,
@@ -291,6 +298,8 @@ def schedule_invalidate_project_config(
     the project config task is executed immediately.
 
     :param trigger: The reason for the invalidation.  This is used to tag metrics.
+    :param trigger_details: Additional information about what triggered the invalidation.
+        This is used to tag metrics.
     :param organization_id: Invalidates all project keys for all projects in an organization.
     :param project_id: Invalidates all project keys for a project.
     :param public_key: Invalidate a single public key.
@@ -317,6 +326,7 @@ def schedule_invalidate_project_config(
         transaction.on_commit(
             lambda: _schedule_invalidate_project_config(
                 trigger=trigger,
+                trigger_details=trigger_details,
                 organization_id=organization_id,
                 project_id=project_id,
                 public_key=public_key,
@@ -329,6 +339,7 @@ def schedule_invalidate_project_config(
 def _schedule_invalidate_project_config(
     *,
     trigger,
+    trigger_details=None,
     organization_id=None,
     project_id=None,
     public_key=None,
@@ -377,7 +388,11 @@ def _schedule_invalidate_project_config(
 
     metrics.incr(
         "relay.projectconfig_cache.scheduled",
-        tags={"update_reason": trigger, "task": "invalidation"},
+        tags={
+            "update_reason": trigger,
+            "update_reason_details": trigger_details,
+            "task": "invalidation",
+        },
     )
 
     invalidate_project_config.apply_async(
@@ -387,6 +402,7 @@ def _schedule_invalidate_project_config(
             "organization_id": organization_id,
             "public_key": public_key,
             "trigger": trigger,
+            "trigger_details": trigger_details,
         },
     )
 

tests/sentry/tasks/test_relay.py

@@ -388,21 +388,27 @@ def apply_async(args=None, kwargs=None, countdown=None):
         invalidation_debounce_cache.mark_task_done(
             public_key=None, project_id=None, organization_id=default_organization.id
         )
-        schedule_invalidate_project_config(organization_id=default_organization.id, trigger="test")
-        schedule_invalidate_project_config(organization_id=default_organization.id, trigger="test")
+        schedule_invalidate_project_config(
+            organization_id=default_organization.id, trigger="test", trigger_details="more test"
+        )
+        schedule_invalidate_project_config(
+            organization_id=default_organization.id, trigger="test", trigger_details="more test"
+        )
 
         assert tasks == [
             {
                 "project_id": default_project.id,
                 "organization_id": None,
                 "public_key": None,
                 "trigger": "test",
+                "trigger_details": None,
             },
             {
                 "project_id": None,
                 "organization_id": default_organization.id,
                 "public_key": None,
                 "trigger": "test",
+                "trigger_details": "more test",
             },
         ]
 
@@ -473,6 +479,7 @@ def test_project_config_invalidations_after_commit(
         assert schedule_inner.call_count == 1
         assert schedule_inner.call_args == call(
             trigger="test",
+            trigger_details=None,
             organization_id=None,
             project_id=default_project.id,
             public_key=None,