-
Notifications
You must be signed in to change notification settings - Fork 914
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
introduce tests to check whether workqueue metrics exist
Signed-off-by: chaosi-zju <[email protected]>
- Loading branch information
1 parent
ba1e68d
commit 6890616
Showing
6 changed files
with
235 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /* | ||
| Copyright 2023 The Karmada Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package e2e | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/onsi/ginkgo/v2" | ||
| "github.com/onsi/gomega" | ||
| "github.com/prometheus/common/model" | ||
| "k8s.io/component-base/metrics/testutil" | ||
|
|
||
| testhelper "github.com/karmada-io/karmada/test/helper" | ||
| ) | ||
|
|
||
| var _ = ginkgo.Describe("metrics testing", func() { | ||
| var grabber *testhelper.Grabber | ||
|
|
||
| const workqueueQueueDuration = "workqueue_queue_duration_seconds_sum" | ||
|
|
||
| ginkgo.BeforeEach(func() { | ||
| var err error | ||
| grabber, err = testhelper.NewMetricsGrabber(context.TODO(), hostKubeClient) | ||
| gomega.Expect(err).ShouldNot(gomega.HaveOccurred()) | ||
| }) | ||
|
|
||
| ginkgo.Context("workqueue metrics testing", func() { | ||
|
|
||
| ginkgo.It("verify whether workqueue metrics exist", func() { | ||
| var metrics *testutil.Metrics | ||
| var workqueueQueueDurationMetrics model.Samples | ||
|
|
||
| ginkgo.By("1. grab metrics from karmada controller", func() { | ||
| // the output format of `metrics` is like: | ||
| // [{ | ||
| // "metric": { | ||
| // "__name__": "workqueue_queue_duration_seconds_sum", | ||
| // "controller": "work-status-controller", | ||
| // "name": "work-status-controller" | ||
| // }, | ||
| // "value": [0, "0.12403110800000001"] | ||
| //}] | ||
| var err error | ||
| metrics, err = grabber.GrabMetricsFromKarmadaControllerManager(context.TODO()) | ||
| gomega.Expect(err).ShouldNot(gomega.HaveOccurred()) | ||
| }) | ||
|
|
||
| ginkgo.By("2. verify whether workqueue metrics exist", func() { | ||
| workqueueQueueDurationMetrics = (*metrics)[workqueueQueueDuration] | ||
| gomega.Expect(workqueueQueueDurationMetrics.Len()).Should(gomega.BeNumerically(">", 0)) | ||
| }) | ||
|
|
||
| ginkgo.By("3. verify the value of work-status-controller metric greater than 0", func() { | ||
| workStatusMetric := testhelper.GetMetricByName(workqueueQueueDurationMetrics, "work-status-controller") | ||
| gomega.Expect(workStatusMetric).ShouldNot(gomega.BeNil()) | ||
| gomega.Expect(workStatusMetric.Value).Should(gomega.BeNumerically(">", 0)) | ||
| }) | ||
| }) | ||
| }) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| /* | ||
| Copyright 2024 The Karmada Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package helper | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "regexp" | ||
| "time" | ||
|
|
||
| "github.com/prometheus/common/model" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/util/wait" | ||
| clientset "k8s.io/client-go/kubernetes" | ||
| "k8s.io/component-base/metrics/testutil" | ||
| "k8s.io/klog/v2" | ||
| ) | ||
|
|
||
| const ( | ||
| karmadaNamespace = "karmada-system" | ||
| karmadaControllerManagerDeploy = "karmada-controller-manager" | ||
| karmadaControllerManagerPort = 8080 | ||
| karmadaControllerManagerLeaderMetric = "leader_election_master_status" | ||
| ) | ||
|
|
||
| // following refers to https://github.com/kubernetes/kubernetes/blob/master/test/e2e/framework/metrics/metrics_grabber.go | ||
|
|
||
| // Grabber is used to grab metrics from karmada components | ||
| type Grabber struct { | ||
| hostKubeClient clientset.Interface | ||
| controllerManagerPods []string | ||
| } | ||
|
|
||
| // NewMetricsGrabber creates a new metrics grabber | ||
| func NewMetricsGrabber(ctx context.Context, c clientset.Interface) (*Grabber, error) { | ||
| grabber := Grabber{hostKubeClient: c} | ||
| regKarmadaControllerManager := regexp.MustCompile(karmadaControllerManagerDeploy + "-.*") | ||
|
|
||
| podList, err := c.CoreV1().Pods(karmadaNamespace).List(ctx, metav1.ListOptions{}) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if len(podList.Items) < 1 { | ||
| klog.Warningf("Can't find any pods in namespace %s to grab metrics from", karmadaNamespace) | ||
| } | ||
| for _, pod := range podList.Items { | ||
| if regKarmadaControllerManager.MatchString(pod.Name) { | ||
| grabber.controllerManagerPods = append(grabber.controllerManagerPods, pod.Name) | ||
| } | ||
| } | ||
| return &grabber, nil | ||
| } | ||
|
|
||
| // GrabMetricsFromKarmadaControllerManager fetch metrics from the leader of karmada controller manager | ||
| func (g *Grabber) GrabMetricsFromKarmadaControllerManager(ctx context.Context) (*testutil.Metrics, error) { | ||
| var output string | ||
| var lastMetricsFetchErr error | ||
|
|
||
| var result *testutil.Metrics | ||
| // judge which pod is the leader of karmada controller manager | ||
| for _, podName := range g.controllerManagerPods { | ||
| if metricsWaitErr := wait.PollUntilContextTimeout(ctx, time.Second, 10*time.Second, true, func(ctx context.Context) (bool, error) { | ||
| output, lastMetricsFetchErr = GetMetricsFromPod(ctx, g.hostKubeClient, podName, karmadaNamespace, karmadaControllerManagerPort) | ||
| return lastMetricsFetchErr == nil, nil | ||
| }); metricsWaitErr != nil { | ||
| klog.Errorf("error waiting for %s to expose metrics: %v; %v", podName, metricsWaitErr, lastMetricsFetchErr) | ||
| continue | ||
| } | ||
|
|
||
| podMetrics := testutil.Metrics{} | ||
| metricsParseErr := testutil.ParseMetrics(output, &podMetrics) | ||
| if metricsParseErr != nil { | ||
| klog.Errorf("failed to parse metrics for %s: %v", podName, metricsParseErr) | ||
| continue | ||
| } | ||
|
|
||
| if !isKarmadaControllerManagerLeader(podMetrics[karmadaControllerManagerLeaderMetric]) { | ||
| klog.Infof("skip fetch %s since it is not the leader pod", podName) | ||
| continue | ||
| } | ||
|
|
||
| result = &podMetrics | ||
| break | ||
| } | ||
|
|
||
| if result == nil { | ||
| return nil, fmt.Errorf("failed to fetch metrics from the leader of karmada controller manager") | ||
| } | ||
| return result, nil | ||
| } | ||
|
|
||
| // GetMetricsFromPod retrieves metrics data. | ||
| func GetMetricsFromPod(ctx context.Context, client clientset.Interface, podName string, namespace string, port int) (string, error) { | ||
| rawOutput, err := client.CoreV1().RESTClient().Get(). | ||
| Namespace(namespace). | ||
| Resource("pods"). | ||
| SubResource("proxy"). | ||
| Name(fmt.Sprintf("%s:%d", podName, port)). | ||
| Suffix("metrics"). | ||
| Do(ctx).Raw() | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| return string(rawOutput), nil | ||
| } | ||
|
|
||
| func isKarmadaControllerManagerLeader(samples model.Samples) bool { | ||
| for _, sample := range samples { | ||
| if sample.Metric["name"] == karmadaControllerManagerDeploy && sample.Value > 0 { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // GetMetricByName returns the metric value with the given name. | ||
| func GetMetricByName(samples model.Samples, name string) *model.Sample { | ||
| for _, sample := range samples { | ||
| if sample.Metric["name"] == model.LabelValue(name) { | ||
| return sample | ||
| } | ||
| } | ||
| return nil | ||
| } |