Browse Source

ref(crons): Clarify what OK and ERROR MonitorStatus are (#66883)

Some more documentation is always good
Evan Purkhiser 1 year ago
parent
commit
8c4ea26329
1 changed files with 9 additions and 0 deletions
  1. 9 0
      src/sentry/monitors/models.py

+ 9 - 0
src/sentry/monitors/models.py

@@ -92,7 +92,16 @@ class MonitorStatus:
     DELETION_IN_PROGRESS = 3
 
     OK = 4
+    """
+    The monitor environment has received check-ins and is OK.
+    """
+
     ERROR = 5
+    """
+    The monitor environment is currently in an active incident state. This is a
+    denormalization of thee fact that a MonitorIncident exists for the
+    environment without a resolving check-in.
+    """
 
     @classmethod
     def as_choices(cls) -> Sequence[tuple[int, str]]: