Merge pull request #248 from grafana/dev

Merge dev to main

Author: vstpme

CHANGELOG.md

@@ -1,11 +1,21 @@
 # Change Log
 
-## v1.0.5 (2022-07-12)
-
+## v1.0.7 (2022-07-18)
+- Backend & frontend bug fixes
+- Deployment improvements
+- Reshape webhook payload for outgoing webhooks
+- Add escalation chain usage info on escalation chains page
+- Improve alert group list load speeds and simplify caching system
+
+## v1.0.6 (2022-07-12)
 - Manual Incidents enabled for teams
 - Fix phone notifications for OSS
 - Public API improvements
 
+## v1.0.5 (2022-07-06)
+- Bump Django to 3.2.14
+- Fix PagerDuty iCal parsing
+
 ## 1.0.4 (2022-06-28)
 - Allow Telegram DMs without channel connection.
 

README.md

@@ -56,6 +56,20 @@ Grafana Url: http://grafana:3000
 6. Enjoy! Check our [OSS docs](https://grafana.com/docs/grafana-cloud/oncall/open-source/) if you want to set up Slack, Telegram, Twilio or SMS/calls through Grafana Cloud. 
 
 
+## Update version
+To update your Grafana OnCall hobby environment:
+
+```shell
+# Update Docker images
+docker-compose --env-file .env_hobby -f docker-compose.yml pull engine celery oncall_db_migration
+
+# Re-deploy
+docker-compose --env-file .env_hobby -f docker-compose.yml up -d --remove-orphans
+```
+
+After updating the engine, you'll also need to click the "Update" button on the [plugin version page](http://localhost:3000/plugins/grafana-oncall-app?page=version-history).
+See [Grafana docs](https://grafana.com/docs/grafana/latest/administration/plugin-management/#update-a-plugin) for more info on updating Grafana plugins.
+
 ## Join community
 
 <a href="https://github.com/grafana/oncall/discussions/categories/community-calls"><img width="200px" src="docs/img/community_call.png"></a>

docs/sources/integrations/configure-outgoing-webhooks.md

@@ -32,10 +32,8 @@ To automatically send alert data to a destination URL via outgoing webhook:
 
 The format you use to call the variables must match the structure of how the fields are nested in the alert payload. The **Data** field can use the following four variables to auto-populate the webhook payload with information about the first alert in the alert group:
 
-- `{{ alert_title }}`
-- `{{ alert_message }}`
-- `{{ alert_url }}`
 - `{{ alert_payload }}`
+- `{{ alert_group_id }}`
   <br>
 
 `alert_payload` is always the first level of any variable you want to call.

docs/sources/open-source.md

@@ -29,6 +29,11 @@ Check the [helm chart](https://github.com/grafana/oncall/tree/dev/helm/oncall) f
 
 We'll always be happy to provide assistance with production deployment in [our communities](https://github.com/grafana/oncall#join-community)! 
 
+## Update Grafana OnCall OSS
+To update an OSS installation of Grafana OnCall, please see the update docs:
+- **Hobby** playground environment: [README.md](https://github.com/grafana/oncall#update)
+- **Production** Helm environment: [Helm update](https://github.com/grafana/oncall/tree/dev/helm/oncall#update)
+
 ## Slack Setup
 
 The Slack integration for Grafana OnCall leverages Slack API features to provide a customizable and useful integration. Refer to the following steps to configure the Slack integration:

engine/apps/alerts/incident_appearance/renderers/base_renderer.py

@@ -18,9 +18,12 @@ def templater_class(self):
 
 
 class AlertGroupBaseRenderer(ABC):
-    def __init__(self, alert_group):
+    def __init__(self, alert_group, alert=None):
+        if alert is None:
+            alert = alert_group.alerts.first()
+
         self.alert_group = alert_group
-        self.alert_renderer = self.alert_renderer_class(self.alert_group.alerts.first())
+        self.alert_renderer = self.alert_renderer_class(alert)
 
     @property
     @abstractmethod

engine/apps/alerts/incident_appearance/renderers/web_renderer.py

@@ -20,11 +20,11 @@ def render(self):
 
 
 class AlertGroupWebRenderer(AlertGroupBaseRenderer):
-    def __init__(self, alert_group):
-        super().__init__(alert_group)
+    def __init__(self, alert_group, alert=None):
+        if alert is None:
+            alert = alert_group.alerts.last()
 
-        # use the last alert to render content
-        self.alert_renderer = self.alert_renderer_class(self.alert_group.alerts.last())
+        super().__init__(alert_group, alert)
 
     @property
     def alert_renderer_class(self):

engine/apps/alerts/migrations/0004_auto_20220711_1106.py

@@ -0,0 +1,21 @@
+# Generated by Django 3.2.13 on 2022-07-11 11:06
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('alerts', '0003_grafanaalertingcontactpoint_datasource_uid'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='alertgroup',
+            name='active_cache_for_web_calculation_id',
+        ),
+        migrations.RemoveField(
+            model_name='alertgroup',
+            name='cached_render_for_web',
+        ),
+    ]

engine/apps/alerts/models/alert.py

@@ -5,7 +5,7 @@
 from django.apps import apps
 from django.conf import settings
 from django.core.validators import MinLengthValidator
-from django.db import models, transaction
+from django.db import models
 from django.db.models import JSONField
 from django.db.models.signals import post_save
 
@@ -261,9 +261,6 @@ def listen_for_alert_model_save(sender, instance, created, *args, **kwargs):
         else:
             distribute_alert.apply_async((instance.pk,), countdown=TASK_DELAY_SECONDS)
 
-    logger.info(f"Recalculate AG cache. Reason: save alert model {instance.pk}")
-    transaction.on_commit(instance.group.schedule_cache_for_web)
-
 
 # Connect signal to  base Alert class
 post_save.connect(listen_for_alert_model_save, Alert)

engine/apps/alerts/models/alert_group.py

@@ -8,12 +8,9 @@
 from celery import uuid as celery_uuid
 from django.apps import apps
 from django.conf import settings
-from django.core.cache import cache
 from django.core.validators import MinLengthValidator
-from django.db import IntegrityError, models, transaction
+from django.db import IntegrityError, models
 from django.db.models import JSONField, Q, QuerySet
-from django.db.models.signals import post_save
-from django.dispatch import receiver
 from django.utils import timezone
 from django.utils.functional import cached_property
 
@@ -22,16 +19,9 @@
 from apps.alerts.incident_appearance.renderers.slack_renderer import AlertGroupSlackRenderer
 from apps.alerts.incident_log_builder import IncidentLogBuilder
 from apps.alerts.signals import alert_group_action_triggered_signal
-from apps.alerts.tasks import (
-    acknowledge_reminder_task,
-    call_ack_url,
-    schedule_cache_for_alert_group,
-    send_alert_group_signal,
-    unsilence_task,
-)
+from apps.alerts.tasks import acknowledge_reminder_task, call_ack_url, send_alert_group_signal, unsilence_task
 from apps.slack.slack_formatter import SlackFormatter
 from apps.user_management.models import User
-from common.mixins.use_random_readonly_db_manager_mixin import UseRandomReadonlyDbManagerMixin
 from common.public_primary_keys import generate_public_primary_key, increase_public_primary_key_length
 from common.utils import clean_markup, str_or_backup
 
@@ -108,10 +98,6 @@ def filter(self, *args, **kwargs):
         return super().filter(*args, **kwargs, is_archived=False)
 
 
-class AlertGroupManager(UseRandomReadonlyDbManagerMixin, models.Manager):
-    pass
-
-
 class AlertGroupSlackRenderingMixin:
     """
     Ideally this mixin should not exist. Instead of this instance of AlertGroupSlackRenderer should be created and used
@@ -134,8 +120,8 @@ def slack_templated_first_alert(self):
 
 
 class AlertGroup(AlertGroupSlackRenderingMixin, EscalationSnapshotMixin, models.Model):
-    all_objects = AlertGroupManager.from_queryset(AlertGroupQuerySet)()
-    unarchived_objects = AlertGroupManager.from_queryset(UnarchivedAlertGroupQuerySet)()
+    all_objects = AlertGroupQuerySet.as_manager()
+    unarchived_objects = UnarchivedAlertGroupQuerySet.as_manager()
 
     (
         NEW,
@@ -242,8 +228,6 @@ class AlertGroup(AlertGroupSlackRenderingMixin, EscalationSnapshotMixin, models.
 
     active_escalation_id = models.CharField(max_length=100, null=True, default=None)  # ID generated by celery
     active_resolve_calculation_id = models.CharField(max_length=100, null=True, default=None)  # ID generated by celery
-    # ID generated by celery
-    active_cache_for_web_calculation_id = models.CharField(max_length=100, null=True, default=None)
 
     SILENCE_DELAY_OPTIONS = (
         (1800, "30 minutes"),
@@ -315,8 +299,6 @@ def status(self):
         related_name="dependent_alert_groups",
     )
 
-    cached_render_for_web = JSONField(default=dict)
-
     last_unique_unacknowledge_process_id = models.CharField(max_length=100, null=True, default=None)
     is_archived = models.BooleanField(default=False)
 
@@ -404,18 +386,6 @@ def skip_escalation_in_slack(self):
     def is_alert_a_resolve_signal(self, alert):
         raise NotImplementedError
 
-    def cache_for_web(self, organization):
-        from apps.api.serializers.alert_group import AlertGroupSerializer
-
-        # Re-take object to switch connection from readonly db to master.
-        _self = AlertGroup.all_objects.get(pk=self.pk)
-        _self.cached_render_for_web = AlertGroupSerializer(self, context={"organization": organization}).data
-        self.cached_render_for_web = _self.cached_render_for_web
-        _self.save(update_fields=["cached_render_for_web"])
-
-    def schedule_cache_for_web(self):
-        schedule_cache_for_alert_group.apply_async((self.pk,))
-
     @property
     def permalink(self):
         if self.slack_message is not None:
@@ -425,10 +395,6 @@ def permalink(self):
     def web_link(self):
         return urljoin(self.channel.organization.web_link, f"?page=incident&id={self.public_primary_key}")
 
-    @property
-    def alerts_count(self):
-        return self.alerts.count()
-
     @property
     def happened_while_maintenance(self):
         return self.root_alert_group is not None and self.root_alert_group.maintenance_uuid is not None
@@ -449,10 +415,6 @@ def acknowledge_by_user(self, user: User, action_source: Optional[str] = None) -
             self.unresolve()
             self.log_records.create(type=AlertGroupLogRecord.TYPE_UN_RESOLVED, author=user, reason="Acknowledge button")
 
-            # clear resolve report cache
-            cache_key = "render_after_resolve_report_json_{}".format(self.pk)
-            cache.delete(cache_key)
-
         self.acknowledge(acknowledged_by_user=user, acknowledged_by=AlertGroup.USER)
         self.stop_escalation()
         if self.is_root_alert_group:
@@ -673,9 +635,6 @@ def un_resolve_by_user(self, user: User, action_source: Optional[str] = None) ->
             self.unresolve()
             log_record = self.log_records.create(type=AlertGroupLogRecord.TYPE_UN_RESOLVED, author=user)
 
-            # clear resolve report cache
-            self.drop_cached_after_resolve_report_json()
-
             if self.is_root_alert_group:
                 self.start_escalation_if_needed()
 
@@ -848,10 +807,6 @@ def silence_by_user(self, user: User, silence_delay: Optional[int], action_sourc
             self.unresolve()
             self.log_records.create(type=AlertGroupLogRecord.TYPE_UN_RESOLVED, author=user, reason="Silence button")
 
-            # clear resolve report cache
-            cache_key = "render_after_resolve_report_json_{}".format(self.pk)
-            cache.delete(cache_key)
-
         if self.acknowledged:
             self.unacknowledge()
             self.log_records.create(type=AlertGroupLogRecord.TYPE_UN_ACK, author=user, reason="Silence button")
@@ -1060,8 +1015,6 @@ def bulk_acknowledge(user: User, alert_groups: "QuerySet[AlertGroup]") -> None:
                 author=user,
                 reason="Bulk action acknowledge",
             )
-            # clear resolve report cache
-            alert_group.drop_cached_after_resolve_report_json()
 
         for alert_group in alert_groups_to_unsilence_before_acknowledge_list:
             alert_group.log_records.create(
@@ -1194,8 +1147,6 @@ def bulk_restart(user: User, alert_groups: "QuerySet[AlertGroup]") -> None:
                 reason="Bulk action restart",
             )
 
-            alert_group.drop_cached_after_resolve_report_json()
-
             if alert_group.is_root_alert_group:
                 alert_group.start_escalation_if_needed()
 
@@ -1293,7 +1244,6 @@ def bulk_silence(user: User, alert_groups: "QuerySet[AlertGroup]", silence_delay
                 author=user,
                 reason="Bulk action silence",
             )
-            alert_group.drop_cached_after_resolve_report_json()
 
         for alert_group in alert_groups_to_unsilence_before_silence_list:
             alert_group.log_records.create(
@@ -1483,7 +1433,7 @@ def get_acknowledge_text(self, mention_user=False):
         else:
             return "Acknowledged"
 
-    def non_cached_after_resolve_report_json(self):
+    def render_after_resolve_report_json(self):
         AlertGroupLogRecord = apps.get_model("alerts", "AlertGroupLogRecord")
         UserNotificationPolicyLogRecord = apps.get_model("base", "UserNotificationPolicyLogRecord")
         ResolutionNote = apps.get_model("alerts", "ResolutionNote")
@@ -1501,21 +1451,6 @@ def non_cached_after_resolve_report_json(self):
                 result_log_report.append(log_record.render_log_line_json())
         return result_log_report
 
-    def render_after_resolve_report_json(self):
-        cache_key = "render_after_resolve_report_json_{}".format(self.pk)
-
-        # cache.get_or_set in some cases returns None, so use get and set cache methods separately
-        log_report = cache.get(cache_key)
-        if log_report is None:
-            log_report = self.non_cached_after_resolve_report_json()
-            cache.set(cache_key, log_report)
-        return log_report
-
-    def drop_cached_after_resolve_report_json(self):
-        cache_key = "render_after_resolve_report_json_{}".format(self.pk)
-        if cache_key in cache:
-            cache.delete(cache_key)
-
     @property
     def has_resolution_notes(self):
         return self.resolution_notes.exists()
@@ -1595,14 +1530,3 @@ def last_stop_escalation_log(self):
         )
 
         return stop_escalation_log
-
-
-@receiver(post_save, sender=AlertGroup)
-def listen_for_alert_group_model_save(sender, instance, created, *args, **kwargs):
-    if (
-        kwargs is not None
-        and "update_fields" in kwargs
-        and kwargs["update_fields"] is dict
-        and "cached_render_for_web" not in kwargs["update_fields"]
-    ):
-        transaction.on_commit(instance.schedule_cache_for_alert_group)

engine/apps/alerts/models/alert_group_log_record.py

@@ -3,7 +3,7 @@
 
 import humanize
 from django.apps import apps
-from django.db import models, transaction
+from django.db import models
 from django.db.models import JSONField
 from django.db.models.signals import post_save
 from django.dispatch import receiver
@@ -546,7 +546,6 @@ def get_step_specific_info(self):
 
 @receiver(post_save, sender=AlertGroupLogRecord)
 def listen_for_alertgrouplogrecord(sender, instance, created, *args, **kwargs):
-    instance.alert_group.drop_cached_after_resolve_report_json()
     if instance.type != AlertGroupLogRecord.TYPE_DELETED:
         if not instance.alert_group.is_maintenance_incident:
             alert_group_pk = instance.alert_group.pk
@@ -555,6 +554,3 @@ def listen_for_alertgrouplogrecord(sender, instance, created, *args, **kwargs):
                 f"alert group event: {instance.get_type_display()}"
             )
             send_update_log_report_signal.apply_async(kwargs={"alert_group_pk": alert_group_pk}, countdown=8)
-
-    logger.info(f"Recalculate AG cache. Reason: save alert_group_log_record model {instance.pk}")
-    transaction.on_commit(instance.alert_group.schedule_cache_for_web)