Merge pull request #28399 from dgoodwin/patho-rework

TRT-1329: Refactor pathological events framework

Author: openshift-merge-bot[bot]

pkg/monitor/monitorapi/construction.go

@@ -1,6 +1,7 @@
 package monitorapi
 
 import (
+	"crypto/sha256"
 	"fmt"
 	"strings"
 	"time"
@@ -294,24 +295,37 @@ func (b *LocatorBuilder) withServer(serverName string) *LocatorBuilder {
 	return b
 }
 
+// TODO decide whether we want to allow "random" locator keys.  deads2k is -1 on random locator keys and thinks we should enumerate every possible key we special case.
 func (b *LocatorBuilder) KubeEvent(event *corev1.Event) Locator {
-	b.targetType = LocatorTypeKubeEvent
 
-	// WARNING: we're trying to use an enum for the locator keys, but we cannot know
-	// all kinds in a cluster. Instead we'll split the kind and name into two different Keys
-	// for Events:
-	b.annotations[LocatorKindKey] = event.InvolvedObject.Kind
-	b.annotations[LocatorNameKey] = event.InvolvedObject.Name
+	// When Kube Events are displayed, we need repeats of the same event to appear on one line. To do this
+	// we hash the event message, get the first ten characters, and add it as a hmsg locator key.
+	hash := sha256.Sum256([]byte(event.Message))
+	hashStr := fmt.Sprintf("%x", hash)[:10]
+	b.annotations[LocatorHmsgKey] = hashStr
 
-	if len(event.InvolvedObject.Namespace) > 0 {
-		b.annotations[LocatorNamespaceKey] = event.InvolvedObject.Namespace
+	if event.InvolvedObject.Kind == "Namespace" {
+		// namespace better match the event itself.
+		return b.
+			withNamespace(event.InvolvedObject.Name).
+			Build()
+	} else if event.InvolvedObject.Kind == "Node" {
+		return b.
+			withTargetType(LocatorTypeNode).
+			withNode(event.InvolvedObject.Name).
+			Build()
 	}
 
-	// TODO: node + namespace is illegal, look at original impl, it may have handled this better
-	if len(event.Source.Host) > 0 && event.InvolvedObject.Kind != "Node" {
+	// Otherwise we have to fall back to a generic "Kind" locator, likely what deads2k refers to above as sketchy.
+	// For now just preserving the old logic.
+	b.targetType = LocatorTypeKind
+	b.annotations[LocatorKey(strings.ToLower(event.InvolvedObject.Kind))] = event.InvolvedObject.Name
+	if len(event.Source.Host) > 0 && event.Source.Component == "kubelet" {
 		b.annotations[LocatorNodeKey] = event.Source.Host
 	}
-
+	if len(event.InvolvedObject.Namespace) > 0 {
+		b.annotations[LocatorNamespaceKey] = event.InvolvedObject.Namespace
+	}
 	return b.Build()
 }
 

pkg/monitor/monitorapi/types.go

@@ -109,6 +109,7 @@ const (
 	LocatorTypeE2ETest           LocatorType = "E2ETest"
 	LocatorTypeAPIServerShutdown LocatorType = "APIServerShutdown"
 	LocatorTypeClusterVersion    LocatorType = "ClusterVersion"
+	LocatorTypeKind              LocatorType = "Kind"
 	LocatorTypeCloudMetrics      LocatorType = "CloudMetrics"
 )
 
@@ -120,10 +121,12 @@ const (
 	LocatorClusterOperatorKey LocatorKey = "clusteroperator"
 	LocatorClusterVersionKey  LocatorKey = "clusterversion"
 	LocatorNamespaceKey       LocatorKey = "namespace"
+	LocatorDeploymentKey      LocatorKey = "deployment"
 	LocatorNodeKey            LocatorKey = "node"
 	LocatorEtcdMemberKey      LocatorKey = "etcd-member"
 	LocatorKindKey            LocatorKey = "kind"
 	LocatorNameKey            LocatorKey = "name"
+	LocatorHmsgKey            LocatorKey = "hmsg"
 	LocatorPodKey             LocatorKey = "pod"
 	LocatorUIDKey             LocatorKey = "uid"
 	LocatorMirrorUIDKey       LocatorKey = "mirror-uid"
@@ -213,11 +216,16 @@ const (
 	AnnotationContainerExitCode  AnnotationKey = "code"
 	AnnotationCause              AnnotationKey = "cause"
 	AnnotationConfig             AnnotationKey = "config"
+	AnnotationContainer          AnnotationKey = "container"
+	AnnotationImage              AnnotationKey = "image"
+	AnnotationInteresting        AnnotationKey = "interesting"
+	AnnotationCount              AnnotationKey = "count"
 	AnnotationNode               AnnotationKey = "node"
 	AnnotationEtcdLocalMember    AnnotationKey = "local-member-id"
 	AnnotationEtcdTerm           AnnotationKey = "term"
 	AnnotationEtcdLeader         AnnotationKey = "leader"
 	AnnotationPreviousEtcdLeader AnnotationKey = "prev-leader"
+	AnnotationPathological       AnnotationKey = "pathological"
 	AnnotationConstructed        AnnotationKey = "constructed"
 	AnnotationPhase              AnnotationKey = "phase"
 	AnnotationIsStaticPod        AnnotationKey = "mirrored"
@@ -264,6 +272,7 @@ const (
 	SourceAPIServerShutdown       IntervalSource = "APIServerShutdown"
 	SourceDisruption              IntervalSource = "Disruption"
 	SourceE2ETest                 IntervalSource = "E2ETest"
+	SourceKubeEvent               IntervalSource = "KubeEvent"
 	SourceNetworkManagerLog       IntervalSource = "NetworkMangerLog"
 	SourceNodeMonitor             IntervalSource = "NodeMonitor"
 	SourceSystemJournalScanner    IntervalSource = "KubeletLogScanner"
@@ -522,6 +531,11 @@ func IsInE2ENamespace(eventInterval Interval) bool {
 
 func IsInNamespaces(namespaces sets.String) EventIntervalMatchesFunc {
 	return func(eventInterval Interval) bool {
+		// For new, structured locators:
+		if ns, ok := eventInterval.StructuredLocator.Keys[LocatorNamespaceKey]; ok {
+			return namespaces.Has(ns)
+		}
+		// TODO: For legacy locators, can be removed soon
 		ns := NamespaceFromLocator(eventInterval.Locator)
 		return namespaces.Has(ns)
 	}