Skip to content

Prevent invalid label values by hashing long PrometheusRule names #440

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

Merged
merged 1 commit into from
Nov 3, 2025
Merged

Prevent invalid label values by hashing long PrometheusRule names #440

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
33 changes: 27 additions & 6 deletions internal/controller/prometheusrule_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ package controllers

import (
"context"
"crypto/sha1"
"encoding/hex"
"errors"
"fmt"
"reflect"
Expand Down Expand Up @@ -43,6 +45,8 @@ import (
"github.com/coralogix/coralogix-operator/internal/utils"
)

const managedByLabelKey = "app.kubernetes.io/managed-by"

//+kubebuilder:rbac:groups=monitoring.coreos.com,resources=prometheusrules,verbs=get;list;watch

//+kubebuilder:rbac:groups=coralogix.com,resources=recordingrulegroupsets,verbs=get;list;watch;create;update;patch;delete
Expand Down Expand Up @@ -121,7 +125,7 @@ func (r *PrometheusRuleReconciler) convertPrometheusRuleRecordingRuleToCxRecordi
recordingRuleGroupSet.Name = prometheusRule.Name
recordingRuleGroupSet.Namespace = prometheusRule.Namespace
recordingRuleGroupSet.Labels = prometheusRule.Labels
recordingRuleGroupSet.Labels["app.kubernetes.io/managed-by"] = prometheusRule.Name
recordingRuleGroupSet.Labels[managedByLabelKey] = truncateLabelValue(prometheusRule.Name)
recordingRuleGroupSet.OwnerReferences = []metav1.OwnerReference{getOwnerReference(prometheusRule)}
recordingRuleGroupSet.Spec = desiredRecordingRuleGroupSetSpec
if err = config.GetClient().Create(ctx, recordingRuleGroupSet); err != nil {
Expand All @@ -135,7 +139,7 @@ func (r *PrometheusRuleReconciler) convertPrometheusRuleRecordingRuleToCxRecordi

updated := false
desiredLabels := prometheusRule.Labels
desiredLabels["app.kubernetes.io/managed-by"] = prometheusRule.Name
desiredLabels[managedByLabelKey] = truncateLabelValue(prometheusRule.Name)
if !reflect.DeepEqual(recordingRuleGroupSet.Labels, desiredLabels) {
recordingRuleGroupSet.Labels = desiredLabels
updated = true
Expand Down Expand Up @@ -236,7 +240,7 @@ func (r *PrometheusRuleReconciler) convertPrometheusRuleAlertToCxAlert(ctx conte
alert.Name = alertName
alert.Namespace = prometheusRule.Namespace
alert.Labels = prometheusRule.Labels
alert.Labels["app.kubernetes.io/managed-by"] = prometheusRule.Name
alert.Labels[managedByLabelKey] = truncateLabelValue(prometheusRule.Name)
alert.OwnerReferences = []metav1.OwnerReference{getOwnerReference(prometheusRule)}
alert.Spec = prometheusAlertingRuleToAlertSpec(&rule)
if err = config.GetClient().Create(ctx, alert); err != nil {
Expand All @@ -250,7 +254,7 @@ func (r *PrometheusRuleReconciler) convertPrometheusRuleAlertToCxAlert(ctx conte

updated := false
desiredLabels := prometheusRule.Labels
desiredLabels["app.kubernetes.io/managed-by"] = prometheusRule.Name
desiredLabels[managedByLabelKey] = truncateLabelValue(prometheusRule.Name)
if !reflect.DeepEqual(alert.Labels, desiredLabels) {
alert.Labels = desiredLabels
updated = true
Expand Down Expand Up @@ -298,7 +302,11 @@ func (r *PrometheusRuleReconciler) convertPrometheusRuleAlertToCxAlert(ctx conte
}

var childAlerts coralogixv1beta1.AlertList
if err := config.GetClient().List(ctx, &childAlerts, client.InNamespace(prometheusRule.Namespace), client.MatchingLabels{"app.kubernetes.io/managed-by": prometheusRule.Name}); err != nil {
if err := config.GetClient().List(
ctx,
&childAlerts,
client.InNamespace(prometheusRule.Namespace),
client.MatchingLabels{managedByLabelKey: truncateLabelValue(prometheusRule.Name)}); err != nil {
return fmt.Errorf("received an error while trying to list Alerts: %w", err)
}

Expand All @@ -318,7 +326,11 @@ func (r *PrometheusRuleReconciler) convertPrometheusRuleAlertToCxAlert(ctx conte

func (r *PrometheusRuleReconciler) deleteCxAlerts(ctx context.Context, prometheusRule *prometheus.PrometheusRule) error {
var childAlerts coralogixv1beta1.AlertList
err := config.GetClient().List(ctx, &childAlerts, client.InNamespace(prometheusRule.Namespace), client.MatchingLabels{"app.kubernetes.io/managed-by": prometheusRule.Name})
err := config.GetClient().List(
ctx,
&childAlerts,
client.InNamespace(prometheusRule.Namespace),
client.MatchingLabels{managedByLabelKey: truncateLabelValue(prometheusRule.Name)})
if err != nil {
return fmt.Errorf("received an error while trying to list Alerts: %w", err)
}
Expand Down Expand Up @@ -483,6 +495,15 @@ func sanitizeName(name string) string {
return name
}

// truncateLabelValue ensures label values stay under 63 chars.
func truncateLabelValue(value string) string {
if len(value) <= 63 {
return value
}
h := sha1.Sum([]byte(value))
return fmt.Sprintf("%s-%s", value[:40], hex.EncodeToString(h[:])[:8])
}

// SetupWithManager sets up the controller with the Manager.
func (r *PrometheusRuleReconciler) SetupWithManager(mgr ctrl.Manager) error {
shouldTrackPrometheusRules := func(labels map[string]string) bool {
Expand Down
Loading