Skip to content

OCPBUGS-55136: Fix cluster:console_plugins_info:max metrics has two entries for one dynamic plugin #15850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vikram-raj wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −18
Open

OCPBUGS-55136: Fix cluster:console_plugins_info:max metrics has two entries for one dynamic plugin #15850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 22 additions & 15 deletions pkg/serverconfig/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ func (m *Metrics) MonitorPlugins(dynamicClient dynamic.Interface) {
}

// ConsolePlugins are monitored with a slow interval (see updateConsolePluginInterval).
// So this gauge can go up and down and it is required to set missing values to 0.
// When plugin state changes (e.g., enabled -> disabled), we must delete the old label
// combination to avoid having stale time series in Prometheus.
func (m *Metrics) updatePluginMetric(dynamicClient dynamic.Interface) {
klog.Info("serverconfig.Metrics: Update ConsolePlugin metrics...\n")
startTime := time.Now()
Expand All @@ -138,7 +139,24 @@ func (m *Metrics) updatePluginMetric(dynamicClient dynamic.Interface) {
klog.Errorf("serverconfig.Metrics: Failed to get all installed ConsolePlugins: %v\n", err)
}

pluginInfo := m.calculatePluginInfo(consolePlugins, m.lastPluginInfo)
pluginInfo := m.calculatePluginInfo(consolePlugins)

// Delete stale label combinations from the previous run that are no longer present
if m.lastPluginInfo != nil {
for lastPluginName, lastPluginStates := range *m.lastPluginInfo {
for lastPluginState := range lastPluginStates {
// Check if this label combination still exists in the new pluginInfo
if newStates, exists := (*pluginInfo)[lastPluginName]; !exists {
// Plugin was removed entirely - delete the old series
m.pluginsInfo.DeleteLabelValues(string(lastPluginName), string(lastPluginState))
} else if _, stateExists := newStates[lastPluginState]; !stateExists {
// Plugin exists but state changed - delete the old state series
m.pluginsInfo.DeleteLabelValues(string(lastPluginName), string(lastPluginState))
}
}
}
}

m.lastPluginInfo = pluginInfo
klog.Infof("serverconfig.Metrics: Update ConsolePlugin metrics: %v (took %v)\n",
pluginInfo,
Expand All @@ -164,24 +182,13 @@ func (m *Metrics) getConsolePlugins(dynamicClient dynamic.Interface) (*[]unstruc
return &resp.Items, err
}

// Create a new plugin info map that is based on the last report to report also removed ConsolePlugins.
// Create a new plugin info map containing only the current state of each plugin.
// Stale label combinations are handled by updatePluginMetric which deletes them.
func (m *Metrics) calculatePluginInfo(
consolePlugins *[]unstructured.Unstructured,
lastPluginInfo *map[MappedPluginName]map[PluginState]int,
) *map[MappedPluginName]map[PluginState]int {
pluginInfo := make(map[MappedPluginName]map[PluginState]int)

if lastPluginInfo != nil {
for lastPluginName, lastPluginStates := range *lastPluginInfo {
for lastPluginState := range lastPluginStates {
if pluginInfo[lastPluginName] == nil {
pluginInfo[lastPluginName] = make(map[PluginState]int)
}
pluginInfo[lastPluginName][lastPluginState] = 0
}
}
}

consolePluginNames := make(map[string]bool)

if consolePlugins != nil {
Expand Down
3 changes: 0 additions & 3 deletions pkg/serverconfig/metrics_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,7 @@ func TestPluginMetricsRunningTwice(t *testing.T) {
console_plugins_info{name="demo",state="enabled"} 1
`,
expectedMetricsAfterUpdate: `
console_plugins_info{name="acm",state="enabled"} 0
console_plugins_info{name="acm",state="notfound"} 1
console_plugins_info{name="demo",state="enabled"} 0
console_plugins_info{name="demo",state="notfound"} 1
`,
},
Expand Down Expand Up @@ -239,7 +237,6 @@ func TestPluginMetricsRunningTwice(t *testing.T) {
console_plugins_info{name="acm",state="enabled"} 1
console_plugins_info{name="demo",state="disabled"} 1
console_plugins_info{name="unknown",state="disabled"} 1
console_plugins_info{name="unknown",state="enabled"} 0
console_plugins_info{name="unknown",state="notfound"} 1
`,
},
Expand Down