Skip to content
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

add subnet metrics and unregister metrics during deletion #420

Merged
merged 2 commits into from
Jul 5, 2024
Merged

add subnet metrics and unregister metrics during deletion #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eec35b7
expose subnet usage metrics
mars1024 Jun 18, 2024
7343222
unregister metrics before deletion
mars1024 Jul 5, 2024
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
9 changes: 7 additions & 2 deletions pkg/constants/finalizers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,10 @@

package constants

const FinalizerIPAllocated = "networking.alibaba.com/ip-allocated"
const FinalizerManagerRuntimeRegistered = "multicluster.alibaba.com/manager-runtime-registered"
const (
FinalizerIPAllocated = "networking.alibaba.com/ip-allocated"

FinalizerManagerRuntimeRegistered = "multicluster.alibaba.com/manager-runtime-registered"

FinalizerMetricsRegistered = "networking.alibaba.com/metrics-registered"
)
55 changes: 53 additions & 2 deletions pkg/controllers/networking/networkstatus_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
Expand Down Expand Up @@ -85,6 +86,17 @@ func (r *NetworkStatusReconciler) Reconcile(ctx context.Context, req ctrl.Reques
return ctrl.Result{}, wrapError("unable to fetch Network", client.IgnoreNotFound(err))
}

if network.DeletionTimestamp != nil {
cleanMetrics(network.Name)
return ctrl.Result{}, wrapError("unable to remove finalizer", r.removeFinalizer(ctx, network))

}

// make sure metrics will be un-registered before deletion
if err = r.addFinalizer(ctx, network); err != nil {
return ctrl.Result{}, wrapError("unable to add finalizer to network", err)
}

nodeSelector := network.Spec.NodeSelector
switch networkingv1.GetNetworkType(network) {
case networkingv1.NetworkTypeGlobalBGP:
Expand Down Expand Up @@ -187,15 +199,54 @@ func updateUsageMetrics(networkName string, networkStatus *networkingv1.NetworkS
}
}

func cleanMetrics(networkName string) {
_ = metrics.IPUsageGauge.DeleteLabelValues(networkName, metrics.IPv4, metrics.IPTotalUsageType)
_ = metrics.IPUsageGauge.DeleteLabelValues(networkName, metrics.IPv4, metrics.IPUsedUsageType)
_ = metrics.IPUsageGauge.DeleteLabelValues(networkName, metrics.IPv4, metrics.IPAvailableUsageType)

_ = metrics.IPUsageGauge.DeleteLabelValues(networkName, metrics.IPv6, metrics.IPTotalUsageType)
_ = metrics.IPUsageGauge.DeleteLabelValues(networkName, metrics.IPv6, metrics.IPUsedUsageType)
_ = metrics.IPUsageGauge.DeleteLabelValues(networkName, metrics.IPv6, metrics.IPAvailableUsageType)

_ = metrics.IPUsageGauge.DeleteLabelValues(networkName, metrics.DualStack, metrics.IPAvailableUsageType)
}

func (r *NetworkStatusReconciler) addFinalizer(ctx context.Context, network *networkingv1.Network) error {
if controllerutil.ContainsFinalizer(network, constants.FinalizerMetricsRegistered) {
return nil
}

patch := client.MergeFrom(network.DeepCopy())
controllerutil.AddFinalizer(network, constants.FinalizerMetricsRegistered)
return retry.RetryOnConflict(retry.DefaultRetry, func() error {
return r.Patch(ctx, network, patch)
})
}

func (r *NetworkStatusReconciler) removeFinalizer(ctx context.Context, network *networkingv1.Network) error {
if !controllerutil.ContainsFinalizer(network, constants.FinalizerMetricsRegistered) {
return nil
}

patch := client.MergeFrom(network.DeepCopy())
controllerutil.RemoveFinalizer(network, constants.FinalizerMetricsRegistered)
return retry.RetryOnConflict(retry.DefaultRetry, func() error {
return r.Patch(ctx, network, patch)
})
}

// SetupWithManager sets up the controller with the Manager.
func (r *NetworkStatusReconciler) SetupWithManager(mgr ctrl.Manager) (err error) {
return ctrl.NewControllerManagedBy(mgr).
Named(ControllerNetworkStatus).
For(&networkingv1.Network{},
builder.WithPredicates(
&predicate.GenerationChangedPredicate{},
&utils.IgnoreDeletePredicate{},
&utils.NetworkSpecChangePredicate{},
&predicate.ResourceVersionChangedPredicate{},
predicate.Or(
&utils.NetworkSpecChangePredicate{},
&utils.TerminatingPredicate{},
),
)).
Watches(&source.Kind{Type: &networkingv1.Subnet{}},
handler.EnqueueRequestsFromMapFunc(func(object client.Object) []reconcile.Request {
Expand Down
100 changes: 98 additions & 2 deletions pkg/controllers/networking/subnetstatus_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"fmt"
"reflect"

"github.com/prometheus/client_golang/prometheus"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/tools/record"
Expand All @@ -29,6 +30,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
Expand All @@ -37,9 +39,11 @@ import (
"sigs.k8s.io/controller-runtime/pkg/source"

networkingv1 "github.com/alibaba/hybridnet/pkg/apis/networking/v1"
"github.com/alibaba/hybridnet/pkg/constants"
"github.com/alibaba/hybridnet/pkg/controllers/concurrency"
"github.com/alibaba/hybridnet/pkg/controllers/utils"
ipamtypes "github.com/alibaba/hybridnet/pkg/ipam/types"
"github.com/alibaba/hybridnet/pkg/metrics"
)

const ControllerSubnetStatus = "SubnetStatus"
Expand Down Expand Up @@ -78,6 +82,17 @@ func (r *SubnetStatusReconciler) Reconcile(ctx context.Context, req ctrl.Request
return ctrl.Result{}, wrapError("unable to fetch Subnet", client.IgnoreNotFound(err))
}

if subnet.DeletionTimestamp != nil {
cleanSubnetMetrics(subnet.Spec.Network, subnet.Name)
return ctrl.Result{}, wrapError("unable to remove finalizer", r.removeFinalizer(ctx, subnet))

}

// make sure metrics will be un-registered before deletion
if err = r.addFinalizer(ctx, subnet); err != nil {
return ctrl.Result{}, wrapError("unable to add finalizer to subnet", err)
}

// fetch subnet usage from manager
var usage *ipamtypes.Usage
if usage, err = r.IPAMManager.GetSubnetUsage(subnet.Spec.Network, subnet.Name); err != nil {
Expand All @@ -99,6 +114,9 @@ func (r *SubnetStatusReconciler) Reconcile(ctx context.Context, req ctrl.Request
return ctrl.Result{}, nil
}

// update metrics
updateSubnetUsageMetrics(subnet.Spec.Network, subnet.Name, &subnet.Status)

// patch subnet status
subnetPatch := client.MergeFrom(subnet.DeepCopy())
subnet.Status = *subnetStatus
Expand All @@ -114,15 +132,93 @@ func (r *SubnetStatusReconciler) Reconcile(ctx context.Context, req ctrl.Request
return ctrl.Result{}, nil
}

func updateSubnetUsageMetrics(networkName, subnetName string, subnetStatus *networkingv1.SubnetStatus) {
if subnetStatus.Total > 0 {
metrics.SubnetIPUsageGauge.With(
prometheus.Labels{
"subnetName": subnetName,
"networkName": networkName,
"usageType": metrics.IPTotalUsageType,
},
).Set(float64(subnetStatus.Total))

metrics.SubnetIPUsageGauge.With(
prometheus.Labels{
"subnetName": subnetName,
"networkName": networkName,
"usageType": metrics.IPUsedUsageType,
},
).Set(float64(subnetStatus.Used))

metrics.SubnetIPUsageGauge.With(
prometheus.Labels{
"subnetName": subnetName,
"networkName": networkName,
"usageType": metrics.IPAvailableUsageType,
},
).Set(float64(subnetStatus.Available))
}
}

func cleanSubnetMetrics(networkName, subnetName string) {
_ = metrics.SubnetIPUsageGauge.Delete(
prometheus.Labels{
"subnetName": subnetName,
"networkName": networkName,
"usageType": metrics.IPTotalUsageType,
})

_ = metrics.SubnetIPUsageGauge.Delete(
prometheus.Labels{
"subnetName": subnetName,
"networkName": networkName,
"usageType": metrics.IPUsedUsageType,
})

_ = metrics.SubnetIPUsageGauge.Delete(
prometheus.Labels{
"subnetName": subnetName,
"networkName": networkName,
"usageType": metrics.IPAvailableUsageType,
})
}

func (r *SubnetStatusReconciler) addFinalizer(ctx context.Context, subnet *networkingv1.Subnet) error {
if controllerutil.ContainsFinalizer(subnet, constants.FinalizerMetricsRegistered) {
return nil
}

patch := client.MergeFrom(subnet.DeepCopy())
controllerutil.AddFinalizer(subnet, constants.FinalizerMetricsRegistered)
return retry.RetryOnConflict(retry.DefaultRetry, func() error {
return r.Patch(ctx, subnet, patch)
})
}

func (r *SubnetStatusReconciler) removeFinalizer(ctx context.Context, subnet *networkingv1.Subnet) error {
if !controllerutil.ContainsFinalizer(subnet, constants.FinalizerMetricsRegistered) {
return nil
}

patch := client.MergeFrom(subnet.DeepCopy())
controllerutil.RemoveFinalizer(subnet, constants.FinalizerMetricsRegistered)
return retry.RetryOnConflict(retry.DefaultRetry, func() error {
return r.Patch(ctx, subnet, patch)
})
}

// SetupWithManager sets up the controller with the Manager.
func (r *SubnetStatusReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
Named(ControllerSubnetStatus).
For(&networkingv1.Subnet{},
builder.WithPredicates(
&predicate.GenerationChangedPredicate{},
&utils.IgnoreDeletePredicate{},
&utils.SubnetSpecChangePredicate{},
&predicate.ResourceVersionChangedPredicate{},
predicate.Or(
&utils.SubnetSpecChangePredicate{},
&utils.TerminatingPredicate{},
),
)).
Watches(&source.Kind{Type: &networkingv1.IPInstance{}},
handler.EnqueueRequestsFromMapFunc(func(object client.Object) []reconcile.Request {
Expand Down
15 changes: 14 additions & 1 deletion pkg/metrics/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ import (
)

func init() {
metrics.Registry.MustRegister(IPUsageGauge,
metrics.Registry.MustRegister(
IPUsageGauge,
SubnetIPUsageGauge,
IPAllocationPeriodSummary,
RemoteClusterStatusCheckDuration,
)
Expand Down Expand Up @@ -52,6 +54,17 @@ var IPUsageGauge = prometheus.NewGaugeVec(
},
)

var SubnetIPUsageGauge = prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: "subnet_ip_usage",
Help: "the usage of IPs in different subnets",
},
[]string{
"subnetName",
"networkName",
"usageType",
})

const (
IPStatefulAllocateType = "stateful"
IPNormalAllocateType = "normal"
Expand Down
Loading