Files
karma/internal/models/api.go
2026-03-09 19:44:23 +00:00

468 lines
14 KiB
Go

package models
import (
"cmp"
"fmt"
"net/url"
"slices"
"sort"
"strings"
"github.com/fvbommel/sortorder"
)
// Filter holds returned data on any filter passed by the user as part of the query
type Filter struct {
Text string `json:"text"`
Name string `json:"name"`
Matcher string `json:"matcher"`
Value string `json:"value"`
Hits int `json:"hits"`
IsValid bool `json:"isValid"`
}
// Color is used by karmaLabelColor to reprenset colors as RGBA
type Color struct {
Red uint8 `json:"red"`
Green uint8 `json:"green"`
Blue uint8 `json:"blue"`
Alpha uint8 `json:"alpha"`
}
func (c *Color) String() string {
return fmt.Sprintf("rgba(%d,%d,%d,%d)", c.Red, c.Green, c.Blue, c.Alpha)
}
// LabelColors holds color information for labels that should be colored in the UI
// every configured label will have a distinct coloring for each value
type LabelColors struct {
Background string `json:"background"`
Brightness int32 `json:"brightness"`
}
// LabelsColorMap is a map of "Label Key" -> "Label Value" -> karmaLabelColors
type LabelsColorMap map[string]map[string]LabelColors
// LabelsCountMap is a map of "Label Key" -> "Label Value" -> number of occurrence
type LabelsCountMap map[string]map[string]int
type LabelValueStats struct {
Value string `json:"value"`
Raw string `json:"raw"`
Hits int `json:"hits"`
Percent int `json:"percent"`
Offset int `json:"offset"`
}
type LabelValueStatsList []LabelValueStats
func CompareLabelValueStats(a, b LabelValueStats) int {
if a.Hits != b.Hits {
return cmp.Compare(b.Hits, a.Hits)
}
if sortorder.NaturalLess(a.Value, b.Value) {
return -1
}
if sortorder.NaturalLess(b.Value, a.Value) {
return 1
}
return 0
}
// LabelNameStats is used in the overview modal, it shows top labels across alerts
type LabelNameStats struct {
Name string `json:"name"`
Values LabelValueStatsList `json:"values"`
Hits int `json:"hits"`
}
type LabelNameStatsList []LabelNameStats
func CompareLabelNameStats(a, b LabelNameStats) int {
if a.Hits != b.Hits {
return cmp.Compare(b.Hits, a.Hits)
}
return cmp.Compare(a.Name, b.Name)
}
// APIAlertGroupSharedMaps defines shared part of APIAlertGroup
type APIAlertGroupSharedMaps struct {
Annotations Annotations `json:"annotations"`
Labels Labels `json:"labels"`
Silences map[string][]string `json:"silences"`
Sources []string `json:"sources"`
Clusters []string `json:"clusters"`
}
// APIAlertGroup is how AlertGroup is returned in the API response
// All labels and annotations that are shared between all alerts in given group
// are moved to Shared namespace, each alert instance only tracks labels and
// annotations that are unique to that instance
type APIAlertGroup struct {
AllLabels map[string]map[string][]string `json:"allLabels"`
AlertGroup
Shared APIAlertGroupSharedMaps `json:"shared"`
TotalAlerts int `json:"totalAlerts"`
}
func (ag *APIAlertGroup) dedupLabels() {
totalAlerts := len(ag.Alerts)
labelCounts := make(map[string]int, len(ag.Alerts))
for _, alert := range ag.Alerts {
for _, l := range alert.Labels {
key := l.Name.Value() + "\n" + l.Value.Value()
labelCounts[key]++
}
}
sharedLabels := Labels{}
for i, alert := range ag.Alerts {
newAlertLabels := Labels{}
for _, l := range alert.Labels {
key := l.Name.Value() + "\n" + l.Value.Value()
if labelCounts[key] == totalAlerts {
sharedLabels = sharedLabels.Add(l)
} else {
newAlertLabels = newAlertLabels.Add(l)
}
}
ag.Alerts[i].Labels = newAlertLabels
}
ag.Shared.Labels = sharedLabels
}
func (ag *APIAlertGroup) removeGroupingLabels(dropNames []string) {
newGroupLabels := Labels{}
for _, l := range ag.Labels {
if slices.Contains(dropNames, l.Name.Value()) {
continue
}
newGroupLabels = newGroupLabels.Add(l)
}
ag.Labels = newGroupLabels
for i, alert := range ag.Alerts {
newAlertLabels := Labels{}
for _, l := range alert.Labels {
if slices.Contains(dropNames, l.Name.Value()) {
// skip all labels from the drop list
continue
}
if v := ag.Labels.Get(l.Name.Value()); v != nil {
// skip all labels that are used for grouping
continue
}
newAlertLabels = newAlertLabels.Add(l)
}
ag.Alerts[i].Labels = newAlertLabels
}
}
func (ag *APIAlertGroup) dedupAnnotations() {
totalAlerts := len(ag.Alerts)
annotationCount := map[string]int{}
for _, alert := range ag.Alerts {
for _, annotation := range alert.Annotations {
key := annotation.Name.Value() + "\n" + annotation.Value.Value()
annotationCount[key]++
}
}
sharedAnnotations := Annotations{}
sharedKeys := map[string]struct{}{}
for i, alert := range ag.Alerts {
newAlertAnnotations := Annotations{}
for _, annotation := range alert.Annotations {
key := annotation.Name.Value() + "\n" + annotation.Value.Value()
if annotationCount[key] == totalAlerts {
if _, ok := sharedKeys[key]; !ok {
sharedAnnotations = append(sharedAnnotations, annotation)
sharedKeys[key] = struct{}{}
}
} else {
newAlertAnnotations = append(newAlertAnnotations, annotation)
}
}
ag.Alerts[i].Annotations = newAlertAnnotations
}
ag.Shared.Annotations = sharedAnnotations
}
func (ag *APIAlertGroup) dedupSilences() {
ag.Shared.Silences = map[string][]string{}
silencesByCluster := map[string]map[string]int{}
for _, alert := range ag.Alerts {
// process each cluster only once, rather than each alertmanager instance
clusters := map[string]struct{}{}
for _, am := range alert.Alertmanager {
if _, ok := clusters[am.Cluster]; ok {
continue
}
clusters[am.Cluster] = struct{}{}
for _, silenceID := range am.SilencedBy {
if _, ok := silencesByCluster[am.Cluster]; !ok {
silencesByCluster[am.Cluster] = map[string]int{}
}
silencesByCluster[am.Cluster][silenceID]++
}
}
}
totalAlerts := len(ag.Alerts)
for cluster, silenceCountMap := range silencesByCluster {
for silenceID, affectedAlertsCount := range silenceCountMap {
if affectedAlertsCount == totalAlerts {
_, ok := ag.Shared.Silences[cluster]
if !ok {
ag.Shared.Silences[cluster] = []string{}
}
ag.Shared.Silences[cluster] = append(ag.Shared.Silences[cluster], silenceID)
// sort to have stable order of silences
sort.Strings(ag.Shared.Silences[cluster])
}
}
}
}
func (ag *APIAlertGroup) dedupSources() {
ag.Shared.Sources = []string{}
urls := map[string]struct{}{}
var err error
var u *url.URL
for _, alert := range ag.Alerts {
for _, am := range alert.Alertmanager {
u, err = url.Parse(am.Source)
if err != nil {
continue
}
if u.String() == "" {
continue
}
index := strings.Index(am.Source, "/graph?")
if index >= 0 {
urls[am.Source[:index]+"/"] = struct{}{}
} else {
urls[am.Source] = struct{}{}
}
}
}
for u := range urls {
ag.Shared.Sources = append(ag.Shared.Sources, u)
}
sort.Strings(ag.Shared.Sources)
}
func (ag *APIAlertGroup) dedupClusters() {
totalAlerts := len(ag.Alerts)
alertsPerCluster := map[string]int{}
for _, alert := range ag.Alerts {
clusters := map[string]struct{}{}
for _, am := range alert.Alertmanager {
clusters[am.Cluster] = struct{}{}
}
for cluster := range clusters {
if _, found := alertsPerCluster[cluster]; !found {
alertsPerCluster[cluster] = 0
}
alertsPerCluster[cluster]++
}
}
ag.Shared.Clusters = []string{}
for cluster, alerts := range alertsPerCluster {
if alerts == totalAlerts {
ag.Shared.Clusters = append(ag.Shared.Clusters, cluster)
}
}
sort.Strings(ag.Shared.Clusters)
}
func (ag *APIAlertGroup) populateAllLabels() {
ag.AllLabels = map[string]map[string][]string{
AlertStateActive.Value(): {},
AlertStateSuppressed.Value(): {},
AlertStateUnprocessed.Value(): {},
}
labels := map[UniqueString]int{}
for _, alert := range ag.Alerts {
for _, l := range alert.Labels {
if _, ok := labels[l.Name]; !ok {
labels[l.Name] = 0
}
labels[l.Name]++
}
}
labelNames := map[UniqueString]struct{}{}
totalAlerts := len(ag.Alerts)
for k, totalValues := range labels {
if totalValues == totalAlerts {
labelNames[k] = struct{}{}
}
}
for _, alert := range ag.Alerts {
for _, l := range alert.Labels {
if _, ok := labelNames[l.Name]; !ok {
continue
}
if _, ok := ag.AllLabels[alert.State.Value()][l.Name.Value()]; !ok {
ag.AllLabels[alert.State.Value()][l.Name.Value()] = []string{}
}
if !slices.Contains(ag.AllLabels[alert.State.Value()][l.Name.Value()], l.Value.Value()) {
ag.AllLabels[alert.State.Value()][l.Name.Value()] = append(ag.AllLabels[alert.State.Value()][l.Name.Value()], l.Value.Value())
}
}
}
for state := range ag.AllLabels {
for k := range ag.AllLabels[state] {
sort.Strings(ag.AllLabels[state][k])
}
}
}
// DedupSharedMaps will find all labels and annotations shared by all alerts
// in this group and moved them to Shared namespace
func (ag *APIAlertGroup) DedupSharedMaps(ignoredLabels []string) {
ag.populateAllLabels()
// remove all labels that are used for grouping
ag.removeGroupingLabels(ignoredLabels)
// don't dedup if we only have a single alert in this group
if len(ag.Alerts) > 1 {
ag.dedupLabels()
ag.dedupAnnotations()
ag.dedupSilences()
ag.dedupClusters()
} else {
ag.Shared = APIAlertGroupSharedMaps{
Labels: Labels{},
Annotations: Annotations{},
Silences: map[string][]string{},
Clusters: []string{},
}
}
ag.dedupSources()
}
// GridSettings exposes all grid settings from the config file
type GridSettings struct {
Order string `json:"order"`
Label string `json:"label"`
Reverse bool `json:"reverse"`
}
// SortSettings nests all settings specific to sorting
type SortSettings struct {
ValueMapping map[string]map[string]string `json:"valueMapping"`
Grid GridSettings `json:"grid"`
}
type SilenceFormStripSettings struct {
Labels []string `json:"labels"`
}
type SilenceFormSettings struct {
Strip SilenceFormStripSettings `json:"strip"`
DefaultAlertmanagers []string `json:"defaultAlertmanagers"`
}
type AlertAcknowledgementSettings struct {
Author string `json:"author"`
Comment string `json:"comment"`
DurationSeconds int `json:"durationSeconds"`
Enabled bool `json:"enabled"`
}
type LabelSettings struct {
IsStatic bool `json:"isStatic"`
IsValueOnly bool `json:"isValueOnly"`
}
type LabelsSettings map[string]LabelSettings
// Settings is used to export karma configuration that is used by UI
// nolint: maligned
type Settings struct {
Labels LabelsSettings `json:"labels"`
Sorting SortSettings `json:"sorting"`
SilenceForm SilenceFormSettings `json:"silenceForm"`
AnnotationsHidden []string `json:"annotationsHidden"`
AnnotationsVisible []string `json:"annotationsVisible"`
AlertAcknowledgement AlertAcknowledgementSettings `json:"alertAcknowledgement"`
GridGroupLimit int `json:"gridGroupLimit"`
AnnotationsDefaultHidden bool `json:"annotationsDefaultHidden"`
AnnotationsAllowHTML bool `json:"annotationsEnableHTML"`
HistoryEnabled bool `json:"historyEnabled"`
}
type AuthenticationInfo struct {
Username string `json:"username"`
Groups []string `json:"groups"`
Enabled bool `json:"enabled"`
}
type APIGrid struct {
StateCount map[string]int `json:"stateCount"`
LabelName string `json:"labelName"`
LabelValue string `json:"labelValue"`
AlertGroups []APIAlertGroup `json:"alertGroups"`
TotalGroups int `json:"totalGroups"`
}
// nolint: maligned
type AlertsRequest struct {
GridLimits map[string]int `json:"gridLimits"`
GroupLimits map[string]int `json:"groupLimits"`
GridLabel string `json:"gridLabel"`
SortOrder string `json:"sortOrder"`
SortLabel string `json:"sortLabel"`
Filters []string `json:"filters"`
DefaultGroupLimit int `json:"defaultGroupLimit"`
GridSortReverse bool `json:"gridSortReverse"`
SortReverse bool `json:"sortReverse"`
}
// AlertsResponse is the structure of JSON response UI will use to get alert data
type AlertsResponse struct {
Settings Settings `json:"settings"`
Silences map[string]map[string]Silence `json:"silences"`
Colors LabelsColorMap `json:"colors"`
Status string `json:"status"`
Timestamp string `json:"timestamp"`
Version string `json:"version"`
Authentication AuthenticationInfo `json:"authentication"`
Grids []APIGrid `json:"grids"`
LabelNames []string `json:"labelNames"`
Filters []Filter `json:"filters"`
Receivers []string `json:"receivers"`
Upstreams AlertmanagerAPISummary `json:"upstreams"`
TotalAlerts int `json:"totalAlerts"`
}
// Autocomplete is the structure of autocomplete object for filter hints
// this is internal representation, not what's returned to the user
type Autocomplete struct {
Value UniqueString `json:"value"`
Tokens []UniqueString `json:"tokens"`
}
type Counters struct {
Counters LabelNameStatsList `json:"counters"`
Total int `json:"total"`
}