alert: alerting annotation improvements, fixes #8421

pkg/api/annotations.go

@@ -41,6 +41,7 @@ func GetAnnotations(c *middleware.Context) Response {
 			Title:     item.Title,
 			PanelId:   item.PanelId,
 			RegionId:  item.RegionId,
+			Type:      string(item.Type),
 		})
 	}
 

pkg/api/dtos/annotations.go

@@ -13,6 +13,7 @@ type Annotation struct {
 	Text        string `json:"text"`
 	Metric      string `json:"metric"`
 	RegionId    int64  `json:"regionId"`
+	Type        string `json:"type"`
 
 	Data *simplejson.Json `json:"data"`
 }

public/app/core/core.ts

 ///<reference path="../headers/common.d.ts" />
 ///<reference path="./mod_defs.d.ts" />
 
-import "./directives/annotation_tooltip";
 import "./directives/dash_class";
 import "./directives/confirm_click";
 import "./directives/dash_edit_link";

public/app/features/alerting/alert_def.ts

@@ -91,17 +91,9 @@ function getStateDisplayModel(state) {
         stateClass: 'alert-state-warning'
       };
     }
-    case 'execution_error': {
-      return {
-        text: 'EXECUTION ERROR',
-        iconClass: 'icon-gf icon-gf-critical',
-        stateClass: 'alert-state-critical'
-      };
-    }
-
     case 'paused': {
       return {
-        text: 'paused',
+        text: 'PAUSED',
         iconClass: "fa fa-pause",
         stateClass: 'alert-state-paused'
       };

public/app/features/annotations/all.ts

@@ -3,10 +3,12 @@ import {AnnotationsSrv} from './annotations_srv';
 import {eventEditor} from './event_editor';
 import {EventManager} from './event_manager';
 import {AnnotationEvent} from './event';
+import {annotationTooltipDirective} from './annotation_tooltip';
 
 export {
   AnnotationsSrv,
   eventEditor,
   EventManager,
   AnnotationEvent,
+  annotationTooltipDirective,
 };

public/app/core/directives/annotation_tooltip.js → public/app/features/annotations/annotation_tooltip.ts

-define([
-  'jquery',
-  'lodash',
-  '../core_module',
-],
-function ($, _, coreModule) {
-  'use strict';
-
-  coreModule.default.directive('annotationTooltip', function($sanitize, dashboardSrv, $compile) {
-
-    function sanitizeString(str) {
-      try {
-        return $sanitize(str);
-      }
-      catch(err) {
-        console.log('Could not sanitize annotation string, html escaping instead');
-        return _.escape(str);
-      }
+///<reference path="../../headers/common.d.ts" />
+
+import angular from 'angular';
+import _ from 'lodash';
+import $ from 'jquery';
+import coreModule from 'app/core/core_module';
+import alertDef from '../alerting/alert_def';
+
+/** @ngInject **/
+export function annotationTooltipDirective($sanitize, dashboardSrv, $compile) {
+
+  function sanitizeString(str) {
+    try {
+      return $sanitize(str);
+    } catch (err) {
+      console.log('Could not sanitize annotation string, html escaping instead');
+      return _.escape(str);
     }
+  }
 
-    return {
-      link: function (scope, element) {
-        var event = scope.event;
-        var title = sanitizeString(event.title);
-        var dashboard = dashboardSrv.getCurrent();
-        var time = '<i>' + dashboard.formatDate(event.min) + '</i>';
+  return {
+    restrict: 'E',
+    scope: {
+      "event": "=",
+    },
+    link: function(scope, element) {
+      var event = scope.event;
+      var title = event.title;
+      var text = event.text;
+      var dashboard = dashboardSrv.getCurrent();
 
-        var tooltip = '<div class="graph-annotation">';
-        tooltip += '<div class="graph-annotation-title">' + title + "</div>";
+      var tooltip = '<div class="graph-annotation">';
+      var titleStateClass = '';
 
-        if (event.text) {
-          var text = sanitizeString(event.text);
-          tooltip += text.replace(/\n/g, '<br>') + '<br>';
-        }
+      if (event.source.name === 'panel-alert') {
+        var stateModel = alertDef.getStateDisplayModel(event.newState);
+        titleStateClass = stateModel.stateClass;
+        title = `<i class="icon-gf ${stateModel.iconClass}"></i> ${stateModel.text}`;
+        text = alertDef.getAlertAnnotationInfo(event);
+      }
 
-        var tags = event.tags;
-        if (_.isString(event.tags)) {
-          tags = event.tags.split(',');
-          if (tags.length === 1) {
-            tags = event.tags.split(' ');
-          }
-        }
+      tooltip += `
+        <div class="graph-annotation-header">
+          <span class="graph-annotation-title ${titleStateClass}">${sanitizeString(title)}</span>
+          <span class="graph-annotation-time">${dashboard.formatDate(event.min)}</span>
+        </div>
+      `;
 
-        if (tags && tags.length) {
-          scope.tags = tags;
-          tooltip += '<span class="label label-tag small" ng-repeat="tag in tags" tag-color-from-name="tag">{{tag}}</span><br/>';
-        }
+      tooltip += '<div class="graph-annotation-body">';
 
-        tooltip += '<div class="graph-annotation-time">' + time + '</div>' ;
-        tooltip += "</div>";
+      if (text) {
+        tooltip += sanitizeString(text).replace(/\n/g, '<br>') + '<br>';
+      }
 
-        var $tooltip = $(tooltip);
-        $tooltip.appendTo(element);
+      var tags = event.tags;
+      if (_.isString(event.tags)) {
+        tags = event.tags.split(',');
+        if (tags.length === 1) {
+          tags = event.tags.split(' ');
+        }
+      }
 
-        $compile(element.contents())(scope);
+      if (tags && tags.length) {
+        scope.tags = tags;
+        tooltip += '<span class="label label-tag small" ng-repeat="tag in tags" tag-color-from-name="tag">{{tag}}</span><br/>';
       }
-    };
-  });
 
-});
+      tooltip += "</div>";
+
+      var $tooltip = $(tooltip);
+      $tooltip.appendTo(element);
+
+      $compile(element.contents())(scope);
+    }
+  };
+}
+
+
+
+coreModule.directive('annotationTooltip', annotationTooltipDirective);

public/app/features/annotations/annotations_srv.ts

@@ -73,6 +73,8 @@ export class AnnotationsSrv {
         panelId: panel.id,
         dashboardId: dashboard.id,
       }).then(results => {
+        // this built in annotation source name `panel-alert` is used in annotation tooltip
+        // to know that this annotation is from panel alert
         return this.translateQueryResult({iconColor: '#AA0000', name: 'panel-alert'}, results);
       });
     }

public/app/plugins/panel/graph/jquery.flot.events.js

@@ -10,7 +10,7 @@ function ($, _, angular, Drop) {
   function createAnnotationToolip(element, event) {
     var injector = angular.element(document).injector();
     var content = document.createElement('div');
-    content.innerHTML = '<annotation-tooltip></annotation-tooltip>';
+    content.innerHTML = '<annotation-tooltip event="event"></annotation-tooltip>';
 
     injector.invoke(["$compile", "$rootScope", function($compile, $rootScope) {
       var tmpScope = $rootScope.$new(true);
@@ -24,7 +24,7 @@ function ($, _, angular, Drop) {
         target: element[0],
         content: content,
         position: "bottom center",
-        classes: 'drop-popover',
+        classes: 'drop-popover drop-popover--annotation',
         openOn: 'hover',
         hoverCloseDelay: 200,
         tetherOptions: {

public/sass/components/_drop.scss

@@ -56,3 +56,9 @@ $easing: cubic-bezier(0, 0, 0.265, 1.00);
     max-width: none;
   }
 }
+
+.drop-element.drop-popover--annotation {
+  .drop-content {
+    padding: 0;
+  }
+}

public/sass/components/_panel_graph.scss

@@ -287,10 +287,29 @@
     margin-top: 8px;
   }
 
+  .graph-annotation-header {
+    background-color: $input-label-bg;
+    padding: 0.40rem 0.65rem;
+  }
+
   .graph-annotation-title {
     font-weight: $font-weight-semi-bold;
+    padding-right: $spacer;
+    position: relative;
+    top: 2px;
+  }
+
+  .graph-annotation-time {
+    color: $text-muted;
+    font-style: italic;
+    font-weight: normal;
+    display: inline-block;
     position: relative;
-    top: -0.4rem;
+    top: 1px;
+  }
+
+  .graph-annotation-body {
+    padding: 0.65rem;
   }
 
   a {
@@ -298,11 +317,6 @@
     text-decoration: underline;
   }
 
-  .graph-annotation-time {
-    position: relative;
-    text-align: center;
-    top: 0.6rem;
-  }
 }
 
 .left-yaxis-label {