feat(api): expose alert fingerprint in the API response

README.md

@@ -39,6 +39,8 @@ see [CONFIGURATION.md](docs/CONFIGURATION.md#alertmanagers).
 
 ### Alert visualization
 
+#### Alert groups
+
 Alerts are displayed grouped preserving
 [group_by](https://prometheus.io/docs/alerting/configuration/#route)
 configuration option in Alertmanager.
@@ -55,6 +57,20 @@ and annotations that are shared between all alerts are moved to the footer.
 
 ![Example](/docs/img/alertGroup.png)
 
+#### Inhibited alerts
+
+Inhibited alerts (suppressed by other alerts,
+[see Alertmanager docs](https://prometheus.io/docs/alerting/latest/alertmanager/#inhibition))
+will have a "muted" button.
+
+![Inhibited alert](/docs/img/inhibited.png)
+
+Clicking on that button will bring a modal with a list of inhibiting alerts.
+
+![Inhibiting alerts](/docs/img/inhibitedByModal.png)
+
+#### Silence deduplication
+
 If all alerts in a group were suppressed by the same silence then, to save
 screen space, the silence will also be moved to the footer.
 

internal/alertmanager/models.go

@@ -244,6 +244,7 @@ func (am *Alertmanager) pullAlerts(version string) error {
 
 			alert.Alertmanager = []models.AlertmanagerInstance{
 				{
+					Fingerprint: alert.Fingerprint,
 					Name:        am.Name,
 					Cluster:     am.ClusterName(),
 					State:       alert.State,

internal/filters/filter_fingerprint.go

@@ -0,0 +1,39 @@
+package filters
+
+import (
+	"fmt"
+
+	"github.com/prymitive/karma/internal/models"
+)
+
+type fingerprintFilter struct {
+	alertFilter
+}
+
+func (filter *fingerprintFilter) Match(alert *models.Alert, matches int) bool {
+	if filter.IsValid {
+		var isMatch bool
+		for _, am := range alert.Alertmanager {
+			m := filter.Matcher.Compare(am.Fingerprint, filter.Value)
+			if m {
+				isMatch = m
+			}
+		}
+		if isMatch {
+			filter.Hits++
+		}
+		return isMatch
+	}
+	e := fmt.Sprintf("Match() called on invalid filter %#v", filter)
+	panic(e)
+}
+
+func (filter *fingerprintFilter) MatchAlertmanager(am *models.AlertmanagerInstance) bool {
+	return filter.Matcher.Compare(am.Fingerprint, filter.Value)
+}
+
+func newFingerprintFilter() FilterT {
+	f := fingerprintFilter{}
+	f.IsAlertmanagerFilter = true
+	return &f
+}

internal/filters/filter_test.go

@@ -114,6 +114,83 @@ var tests = []filterTest{
 		IsValid:    false,
 	},
 
+	{
+		Expression: "@fingerprint=",
+		IsValid:    false,
+	},
+	{
+		Expression: "@fingerprint==",
+		IsValid:    false,
+	},
+	{
+		Expression: "@fingerprint<=active",
+		IsValid:    false,
+	},
+	{
+		Expression:          "@fingerprint=123",
+		IsValid:             true,
+		Alert:               models.Alert{},
+		IsMatch:             false,
+		IsAlertmanagerMatch: true,
+	},
+	{
+		Expression:          "@fingerprint!=123",
+		IsValid:             true,
+		Alert:               models.Alert{},
+		IsMatch:             true,
+		IsAlertmanagerMatch: true,
+	},
+	{
+		Expression: "@fingerprint=1234",
+		IsValid:    true,
+		Alert:      models.Alert{},
+		Alertmanagers: []models.AlertmanagerInstance{
+			{Fingerprint: "1234"},
+		},
+		IsMatch:             true,
+		IsAlertmanagerMatch: true,
+	},
+	{
+		Expression: "@fingerprint=~123",
+		IsValid:    true,
+		Alert:      models.Alert{},
+		Alertmanagers: []models.AlertmanagerInstance{
+			{Fingerprint: "01234"},
+		},
+		IsMatch:             true,
+		IsAlertmanagerMatch: true,
+	},
+	{
+		Expression: "@fingerprint=abc",
+		IsValid:    true,
+		Alert:      models.Alert{},
+		Alertmanagers: []models.AlertmanagerInstance{
+			{Fingerprint: "12345"},
+		},
+		IsMatch:             false,
+		IsAlertmanagerMatch: false,
+	},
+	{
+		Expression: "@fingerprint!=1a1",
+		IsValid:    true,
+		Alert:      models.Alert{},
+		Alertmanagers: []models.AlertmanagerInstance{
+			{Fingerprint: "1a1"},
+		},
+		IsMatch:             false,
+		IsAlertmanagerMatch: false,
+	},
+	{
+		Expression: "@fingerprint!=cde",
+		IsValid:    true,
+		Alert:      models.Alert{},
+		Alertmanagers: []models.AlertmanagerInstance{
+			{Fingerprint: "abc"},
+		},
+		IsMatch:             true,
+		IsAlertmanagerMatch: true,
+	},
+
 	{
 		Expression: "@silence_id=abcdef",
 		IsValid:    true,
@@ -699,7 +776,7 @@ func TestFilters(t *testing.T) {
 		}
 		if f.GetIsValid() {
 			isAlertmanagerFilter := slices.StringInSlice(
-				[]string{"@age", "@alertmanager", "@cluster", "@state", "@silence_id", "@silence_ticket", "@silence_author"},
+				[]string{"@age", "@alertmanager", "@cluster", "@state", "@silence_id", "@silence_ticket", "@silence_author", "@fingerprint"},
 				f.GetName())
 			if isAlertmanagerFilter != f.GetIsAlertmanagerFilter() {
 				t.Errorf("[%s] GetIsAlertmanagerFilter() returned %#v while %#v was expected", ft.Expression, f.GetIsAlertmanagerFilter(), isAlertmanagerFilter)

internal/filters/registry.go

@@ -61,6 +61,12 @@ var AllFilters = []filterConfig{
 		Factory:            newStateFilter,
 		Autocomplete:       stateAutocomplete,
 	},
+	{
+		Label:              "@fingerprint",
+		LabelRe:            regexp.MustCompile("^@fingerprint$"),
+		SupportedOperators: []string{regexpOperator, equalOperator, notEqualOperator},
+		Factory:            newFingerprintFilter,
+	},
 	{
 		Label:              "@receiver",
 		LabelRe:            regexp.MustCompile("^@receiver$"),

internal/mapper/v017/api.go

@@ -56,6 +56,7 @@ func groups(c *client.Alertmanager, timeout time.Duration) ([]models.AlertGroup,
 		}
 		for _, alert := range group.Alerts {
 			a := models.Alert{
+				Fingerprint:  *alert.Fingerprint,
 				Receiver:     *group.Receiver.Name,
 				Annotations:  models.AnnotationsFromMap(alert.Annotations),
 				Labels:       alert.Labels,

internal/models/alert.go

@@ -37,6 +37,7 @@ type Alert struct {
 	// those are not exposed in JSON, Alertmanager specific value will be in kept
 	// in the Alertmanager slice
 	// skip those when generating alert fingerprint too
+	Fingerprint  string   `json:"-" hash:"-"`
 	GeneratorURL string   `json:"-" hash:"-"`
 	SilencedBy   []string `json:"-" hash:"-"`
 	InhibitedBy  []string `json:"-" hash:"-"`

internal/models/alertmanager.go

@@ -5,8 +5,9 @@ import "time"
 // AlertmanagerInstance describes the Alertmanager instance alert was collected
 // from
 type AlertmanagerInstance struct {
-	Name    string `json:"name"`
-	Cluster string `json:"cluster"`
+	Fingerprint string `json:"fingerprint"`
+	Name        string `json:"name"`
+	Cluster     string `json:"cluster"`
 	// per instance alert state
 	State string `json:"state"`
 	// timestamp collected from this instance, those on the alert itself

internal/models/api_test.go

@@ -12,8 +12,10 @@ import (
 
 func TestDedupSharedMaps(t *testing.T) {
 	am := models.AlertmanagerInstance{
-		Cluster:    "fakeCluster",
-		SilencedBy: []string{"fakeSilence1", "fakeSilence2"},
+		Fingerprint: "1",
+		Name:        "am",
+		Cluster:     "fakeCluster",
+		SilencedBy:  []string{"fakeSilence1", "fakeSilence2"},
 	}
 	ag := models.APIAlertGroup{
 		AlertGroup: models.AlertGroup{
@@ -98,7 +100,8 @@ func TestDedupSharedMaps(t *testing.T) {
       "state": "suppressed",
       "alertmanager": [
         {
-          "name": "",
+          "fingerprint": "1",
+          "name": "am",
           "cluster": "fakeCluster",
           "state": "",
           "startsAt": "0001-01-01T00:00:00Z",
@@ -110,7 +113,8 @@ func TestDedupSharedMaps(t *testing.T) {
           "inhibitedBy": null
         },
         {
-          "name": "",
+          "fingerprint": "1",
+          "name": "am",
           "cluster": "fakeCluster",
           "state": "",
           "startsAt": "0001-01-01T00:00:00Z",
@@ -135,7 +139,8 @@ func TestDedupSharedMaps(t *testing.T) {
       "state": "suppressed",
       "alertmanager": [
         {
-          "name": "",
+          "fingerprint": "1",
+          "name": "am",
           "cluster": "fakeCluster",
           "state": "",
           "startsAt": "0001-01-01T00:00:00Z",
@@ -147,7 +152,8 @@ func TestDedupSharedMaps(t *testing.T) {
           "inhibitedBy": null
         },
         {
-          "name": "",
+          "fingerprint": "1",
+          "name": "am",
           "cluster": "fakeCluster",
           "state": "",
           "startsAt": "0001-01-01T00:00:00Z",
@@ -172,7 +178,8 @@ func TestDedupSharedMaps(t *testing.T) {
       "state": "suppressed",
       "alertmanager": [
         {
-          "name": "",
+          "fingerprint": "1",
+          "name": "am",
           "cluster": "fakeCluster",
           "state": "",
           "startsAt": "0001-01-01T00:00:00Z",
@@ -184,7 +191,8 @@ func TestDedupSharedMaps(t *testing.T) {
           "inhibitedBy": null
         },
         {
-          "name": "",
+          "fingerprint": "1",
+          "name": "am",
           "cluster": "fakeCluster",
           "state": "",
           "startsAt": "0001-01-01T00:00:00Z",

ui/src/Common/Query.js

@@ -8,6 +8,7 @@ const StaticLabels = Object.freeze({
   AlertName: "alertname",
   AlertManager: "@alertmanager",
   AlertmanagerCluster: "@cluster",
+  Fingerprint: "@fingerprint",
   Receiver: "@receiver",
   State: "@state",
   SilenceID: "@silence_id",

ui/src/Components/Grid/AlertGrid/AlertGroup/Alert/__snapshots__/index.test.js.snap

@@ -81,7 +81,7 @@ exports[`<Alert /> matches snapshot when inhibited 1`] = `
   <div style=\\"display: inline-block; max-width: 100%;\\"
        class=\\" tooltip-trigger\\"
   >
-    <span class=\\"badge badge-light components-label\\">
+    <span class=\\"badge badge-light components-label components-label-with-hover cursor-pointer\\">
       <svg aria-hidden=\\"true\\"
            focusable=\\"false\\"
            data-prefix=\\"fas\\"

ui/src/Components/Grid/AlertGrid/AlertGroup/Alert/index.js

@@ -3,16 +3,13 @@ import PropTypes from "prop-types";
 
 import { useObserver } from "mobx-react-lite";
 
-import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
-import { faVolumeMute } from "@fortawesome/free-solid-svg-icons/faVolumeMute";
-
 import { APIAlert, APIGroup } from "Models/API";
 import { AlertStore } from "Stores/AlertStore";
 import { SilenceFormStore } from "Stores/SilenceFormStore";
 import { BorderClassMap } from "Common/Colors";
 import { StaticLabels } from "Common/Query";
 import { FilteringLabel } from "Components/Labels/FilteringLabel";
-import { TooltipWrapper } from "Components/TooltipWrapper";
+import { InhibitedByModal } from "Components/InhibitedByModal";
 import { RenderNonLinkAnnotation, RenderLinkAnnotation } from "../Annotation";
 import { AlertMenu } from "./AlertMenu";
 import { RenderSilence } from "../Silences";
@@ -39,13 +36,15 @@ const Alert = ({
 
   const silences = {};
   let clusters = [];
-  let isInhibited = false;
+  let inhibitedBy = [];
   for (const am of alert.alertmanager) {
     if (!clusters.includes(am.cluster)) {
       clusters.push(am.cluster);
     }
-    if (am.inhibitedBy.length > 0) {
-      isInhibited = true;
+    for (const fingerprint of am.inhibitedBy) {
+      if (!inhibitedBy.includes(fingerprint)) {
+        inhibitedBy.push(fingerprint);
+      }
     }
     if (!silences[am.cluster]) {
       silences[am.cluster] = {
@@ -87,12 +86,8 @@ const Alert = ({
         silenceFormStore={silenceFormStore}
         setIsMenuOpen={setIsMenuOpen}
       />
-      {isInhibited ? (
-        <TooltipWrapper title="This alert is inhibited by other alerts">
-          <span className="badge badge-light components-label">
-            <FontAwesomeIcon className="text-success" icon={faVolumeMute} />
-          </span>
-        </TooltipWrapper>
+      {inhibitedBy.length > 0 ? (
+        <InhibitedByModal alertStore={alertStore} fingerprints={inhibitedBy} />
       ) : null}
       {Object.entries(alert.labels).map(([name, value]) => (
         <FilteringLabel

ui/src/Components/Grid/AlertGrid/AlertGroup/Alert/index.test.js

@@ -86,6 +86,23 @@ describe("<Alert />", () => {
   });
 
   it("renders inhibition icon when inhibited", () => {
+    const alert = MockedAlert();
+    alert.alertmanager[0].inhibitedBy = ["123456"];
+    alert.alertmanager.push({
+      name: "ha2",
+      cluster: "HA",
+      state: "active",
+      startsAt: "2018-08-14T17:36:40.017867056Z",
+      source: "localhost/prometheus",
+      silencedBy: [],
+      inhibitedBy: ["123456"],
+    });
+    const group = MockAlertGroup({}, [alert], [], {}, {});
+    const tree = MountedAlert(alert, group, false, false);
+    expect(tree.find(".fa-volume-mute")).toHaveLength(1);
+  });
+
+  it("inhibition icon passes only unique fingerprints", () => {
     const alert = MockedAlert();
     alert.alertmanager[0].inhibitedBy = ["123456"];
     const group = MockAlertGroup({}, [alert], [], {}, {});